Release 4.0.0

Author: benm071

CONTRIBUTING.md

@@ -8,5 +8,5 @@ The Universal Permissive License (UPL), Version 1.0*
 We plan to provide this functionality in the future. At that time, you will need to follow [The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html)
 (OCA).
 
-If you have ideas, comments, or issues related to generator, swing on by the [Oracle JET discussion forum.](https://community.oracle.com/community/development_tools/oracle-jet/generators)
+If you have ideas, comments, or issues to discuss, swing on by the [Oracle JET discussion forum.](https://community.oracle.com/community/development_tools/oracle-jet/generators)
 

README.md

@@ -1,21 +1,21 @@
-# eslint-config-oraclejet 3.2.0
+# @oracle/eslint-config-oraclejet 4.0.0
 
 This package contains the ESLint configurations used by the Oracle JET project.  These configurations come in two flavors:
 
 * es5: this configuration is used by the JET runtime code base, which is authored in ES5.
 * es6: this configuration is used by the JET tooling code base, which consists of a collection of Node-based packages that are authored in ES6.
 
-These ESLint configurations are based on the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript), which defines thorough JavaScript coding guidelines with the goal of ensuring a clean, consistent code base.  The Oracle JET configurations introduce some deltas on top of the base ESLint configurations defined by Airbnb, as explained below.
+These ESLint configurations are based on the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript), which defines thorough JavaScript coding guidelines with the goal of ensuring a clean, consistent code base.  The Oracle JET configurations introduce some deltas on top of the base ESLint configurations provided by Airbnb, as explained below.
 
-Application developers are welcome to use the Oracle JET ESLint configurations with their own code bases, though be aware that several of the changes are fairly specific to JET (eg. use of underscore prefixes), so please review the changes below before adoption.  A better option for JET-based applications that want to follow a similar coding standard without picking up the JET-specific quirks would be to use [Airbnb's ESLint configurations](https://www.npmjs.com/package/eslint-config-airbnb) directly.
+Application developers are welcome to use the Oracle JET ESLint configurations with their own code bases, though be aware that several of the changes are fairly specific to JET (e.g. use of underscore prefixes), so please review the information below before adoption.  A better option for JET-based applications that want to follow a similar coding standard without picking up the JET-specific quirks would be to use [Airbnb's ESLint configurations](https://www.npmjs.com/package/eslint-config-airbnb) directly.
 
 ## Deltas to the Airbnb ESLint Configurations
 
 The following sections list the modifications that the Oracle JET ESLint configurations apply on top of the base Airbnb configurations.
 
 ### 1. Common Deltas
 
-The items in this section apply to both our ES5 and ES6 configurations.
+The items in this section apply to both of our configurations (ES5 and ES6).
 
 #### 1.1 Underscore prefixes are used for private variables
 
@@ -29,47 +29,75 @@ The JET team is evaluating other [approaches to private properties](https://curi
 
 _ESLint rule change_: [func-names](http://eslint.org/docs/rules/func-names) is disabled.
 
-The Airbnb ESLint rules enforce that all function expressions must be named.  This requires duplication when assigning function expressions, eg:
+The Airbnb ESLint rules enforce that all function expressions must be named.  This requires duplication when assigning function expressions, e.g.:
 
 ```javascript
   Foo.prototype.doSomething = function doSomething() { };
 ```
 
 Given that ES6 specifies new rules for [function name inference](http://www.ecma-international.org/ecma-262/6.0/#sec-assignment-operators-runtime-semantics-evaluation), the JET code base allows anonymous function expressions.
 
-Note that while modern browsers support function name inference, the use of anonymous function expressions can make debugging more challenging on older browsers (eg. IE11).
+Note that while modern browsers support function name inference, the use of anonymous function expressions can make debugging more challenging on older browsers (e.g. IE11).
 
-#### 1.3 Functions may be called before they are defined.
+#### 1.3 Functions may be used before they are defined (in non-hoisting situations)
 
 _ESLint rule change_: [no-use-before-define](http://eslint.org/docs/rules/no-use-before-define) is disabled for functions.
 
 Robert Martin's [Clean Code](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) promotes the notion that code should read like a top-down  narrative, where higher level functions appear at the top of the module, followed by functions of increasingly lower levels of abstraction that are used to implement the preceding higher level functions.  This approach to code organization is dubbed "The Stepdown Rule".
 
-The JET team likes this rule enough to justify disabling the no-use-before-define rule defined by Airbnb's ESLint config.  (We disable the rule just for functions, not for variables).
+Unfortunately, the no-use-before-define ESLint rule is not compatible with this approach.
 
-#### 1.4. Function declarations are allowed.
+In theory, no-use-before-define intends to protect developers from relying on function hoisting behavior like this:
+
+```javascript
+// Call function that has not yet been defined
+doSomething();
+
+// Define function somewhere later in the same scope
+function doSomething() { }
+```
+The above code relies on the fact that the definition of the doSomething function will be hoisted to the top of the scope, above the doSomething() call.  This is reasonable to flag.
+
+However, the no-use-before-define rule additionally reports the following code as a violation:
+
+```javascript
+function doSomething() {
+  doSomeLowerLevelThing();
+}
+
+function doSomeLowerLevelThing() {}
+```
+
+Although the above code does not rely on function hoisting, no-use-before-define still considers this code to be invalid, which prohibits the use of Martin's Stepdown Rule.
+
+The JET team likes the Stepdown Rule enough to justify disabling the no-use-before-define rule defined by Airbnb's ESLint config.  (We disable the rule just for functions, not for variables.)
+
+If in the future we find (or implement) an ESLint rule that can distinguish between hoisting-dependent vs. hoisting-independent usages, we may start treating hoisting-dependent use-before-define cases as violations.  As such, we encourage JET developers to limit reliance on function hoisting, even though this is not currently enforced.
+
+
+#### 1.4. Function declarations are allowed
 
 _ESLint rule change_: None.
 
-The Airbnb style guide prefers the use of [function expressions instead of function declarations](https://github.com/airbnb/javascript#functions--declarations) due to concerns over confusion relating to function [hoisting](http://www.adequatelygood.com/JavaScript-Scoping-and-Hoisting.html).
+The Airbnb style guide prefers the use of [function expressions instead of function declarations](https://github.com/airbnb/javascript#functions--declarations) due to concerns over function [hoisting](http://www.adequatelygood.com/JavaScript-Scoping-and-Hoisting.html) confusion.
 
-We have found function declarations to be reasonably readable and have not had problems with function declaration hoisting confusion.  As such, we continue to use this language feature.
+We have found function declarations to be readable and have increased complexity in our code base.  As such, we continue to leverage this language feature.
 
 Note that it appears that Airbnb eventually plans to enforce the use of function expressions via the [func-style](http://eslint.org/docs/rules/func-style) rule.  However, this is not yet enforced, so JET does not yet make any rule changes relating to this.
 
 #### 1.5 Platform-specific line breaks are allowed
 
 _ESLint rule change_: [linebreak-style](http://eslint.org/docs/rules/linebreak-style) is disabled.
 
-Rather than enforce a consistent line break style via ESLint, we prefer to deal with this at the source control layer.  This allows our developers to do development on their platform of choice (including running ESLint).
+Rather than enforce a consistent line break style via ESLint, we prefer to deal with this at the source control layer.  This allows our developers to do development (including running ESLint) on their platform of choice without having to worry about line breaks.
 
-#### 1.6 The unary increment/decrement operators may be used in for loops.
+#### 1.6 The unary increment/decrement operators may be used in for loops
 
 _ESLint rule change_: [no-plusplus](http://eslint.org/docs/rules/no-plusplus) is disabled for afterthoughts in for loops.
 
 The Airbnb style guide raises various [concerns about the use of ++ and --](https://github.com/airbnb/javascript#variables--unary-increment-decrement).  While we agree with these concerns, we are comfortable with allowing these operators in for loops.
 
-Note that, like Airbnb, we prefer [higher-order functions instead of loops](https://github.com/airbnb/javascript#iterators--nope).  But for the few places where we do loop, we are okay with seeing increment/decrement operators.
+Note that, like Airbnb, we prefer [higher-order functions instead of loops](https://github.com/airbnb/javascript#iterators--nope).
 
 ### 2. ES6-specific Deltas
 
@@ -79,7 +107,7 @@ The following changes are specific to the ES6 version of the Oracle JET ESLint c
 
 _ESLint rule change_: [no-console](http://eslint.org/docs/rules/no-console) is disabled.
 
-For the moment, our ES6 configuration is exclusively used by JET's  Node-based tooling modules.  These modules use console logging to communicate with the end user.
+For the moment, our ES6 configuration is exclusively used by JET's Node-based tooling modules.  These modules use console logging to communicate with the end user.
 
 Note we are considering generalizing our ES6 rules to apply to browser code as well, in which case we would change to (globally) disallowing console logging.
 
@@ -93,13 +121,13 @@ The Airbnb ESLint config forbids the use of 'use strict' as Airbnb relies on [Ba
 
 _ESLint rule change_: [comma-dangle](http://eslint.org/docs/rules/comma-dangle) is disabled.
 
-Airbnb's (ES6) style guide mandates the use of dangling commas for the purpose of having cleaner git diffs.  We find that dangling commas can be slightly less readable/more confusing for developers, so we prefer to optimize for reading over dif'fing.
+Airbnb's (ES6) style guide mandates the use of dangling commas for the purpose of having cleaner git diffs.  We find that dangling commas can be slightly less readable and slightly more confusing for developers, so we prefer to optimize for reading over diff'ing.
 
 #### 2.4 Unresolved imports are (temporarily) allowed
 
 _ESLint rule change_: [import/no-unresolved](http://eslint.org/docs/rules/import/no-unresolved) is disabled.
 
-While we would like to leave this rule enabled, we are currently seeing some seemingly false positives trigger by this rule.  We are temporarily disabling this while we get to the bottom of the violations.
+While we would like to leave this rule enabled, we are currently seeing some false positives triggered by this rule.  As such, we are temporarily disabling this while we get to the bottom of the violations.  We plan to re-enable this rule in a future version of our eslint-config-oraclejet.
 
 ### 3. ES5-specific Deltas
 
@@ -109,9 +137,9 @@ The following changes are specific to the ES5 version of the Oracle JET ESLint c
 
 _ESLint rule change_: [quote-props](http://eslint.org/docs/rules/import/quote-props) and [dot-notation](http://eslint.org/docs/rules/dot-notation) are disabled.
 
-Like Airbnb, we strongly prefer dot notation over quoting.  However, the JET code base uses quoting as a way to ensure that the Closure Compiler does not mangle certain property names.  Rather than suppress each of these violations locally each time the quoted property is referenced, we decided to disable these two ESLint rules.
+Like Airbnb, we strongly prefer dot notation over quoting.  However, the JET runtime code base uses quoting as a way to ensure that the Closure Compiler does not mangle certain property names.  Rather than suppress each of these violations locally each time the quoted property is referenced, we decided to disable these two ESLint rules globally.
 
-We would recommend that teams building JET-based applications use dot notation and leave these two rules enabled.
+We may re-enable both of these rules in the future, and as such encourage the use of dot notation wherever possible.
 
 ## [Contributing](https://github.com/oracle/eslint-config-oraclejet/tree/master/CONTRIBUTING.md)
 Oracle JET is an open source project.  Pull Requests are currently not being accepted. See [CONTRIBUTING](https://github.com/oracle/eslint-config-oraclejet/tree/master/CONTRIBUTING.md) for details.

RELEASENOTES.md

@@ -1,5 +1,8 @@
 ## Release Notes for eslint-config-oraclejet ##
 
+### 4.0.0
+* Moved module into @oracle scope, changing the name to @oracle/eslint-config-oraclejet
+
 ### 3.2.0
 * No changes
 

es5/base.js

@@ -24,6 +24,6 @@ module.exports = {
         "no-use-before-define" : ["error", {"functions" : false, "classes" : true}],
         "no-plusplus": ["error", {"allowForLoopAfterthoughts": true }],
         "no-underscore-dangle": "off", 
-        "quote-props": "off"
+        "quote-props": "off", 
     }
 }

es6/base.js

@@ -16,6 +16,6 @@ module.exports = {
         "no-console" : "off",
         "no-plusplus": ["error", {"allowForLoopAfterthoughts": true }],
         "no-use-before-define" : ["error", {"functions" : false, "classes" : true}],
-        "strict" : "off"
+        "strict" : "off",
     }
 };

index.js

@@ -5,7 +5,7 @@
 // Default config
 module.exports = {
   extends: [
-    './es6/base'
+    './es5/base'
   ].map(require.resolve),
   rules: {}
 };

package.json

@@ -1,26 +1,28 @@
 {
-  "name": "eslint-config-oraclejet",
-  "version": "3.2.0",
+  "name": "@oracle/eslint-config-oraclejet",
+  "version": "4.0.0",
   "license": "UPL-1.0",
   "description": "JET Coding standards eslint config files",
   "keywords": [
     "eslint",
     "eslintconfig"
-  ],  
+  ],
   "homepage": "http://oraclejet.org",
   "files": [
     "es5",
     "es6",
     "*.js"
   ],
-  "dependencies": 
-  {  
-    "eslint-config-airbnb-base": "^10.0.1",
-    "eslint-plugin-import": "^2.2.0"
+  "dependencies": {
+    "eslint": "~3.19.0",
+    "eslint-config-airbnb": "~14.1.0",
+    "eslint-config-airbnb-base": "~11.1.2",
+    "eslint-plugin-import": "~2.2.0",
+    "eslint-plugin-react": "~6.10.3",
+    "eslint-plugin-jsx-a11y": "~4.0.0"
   },
-  "devDependencies":
-  {
-    "fs-extra": "^2.0.0"
+  "devDependencies": {
+    "fs-extra": "~2.1.2"
   },
-  "jetdocversion": "320"
+  "jetdocversion": "400"
 }