From 66d4ba48348c85db5068eebae207b1bccf7a9bf3 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 11:54:46 -0500 Subject: [PATCH 1/8] remove no-var description & comma-dangle --- README.md | 75 +------------------------------------------------------ 1 file changed, 1 insertion(+), 74 deletions(-) diff --git a/README.md b/README.md index ee0871b496..ade7ee5ece 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,9 @@ -# Airbnb JavaScript Style Guide() { +# Unity JavaScript Style Guide() { *A mostly reasonable approach to JavaScript* -[![Downloads](https://img.shields.io/npm/dm/eslint-config-airbnb.svg)](https://www.npmjs.com/package/eslint-config-airbnb) -[![Downloads](https://img.shields.io/npm/dm/eslint-config-airbnb-base.svg)](https://www.npmjs.com/package/eslint-config-airbnb-base) -[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/airbnb/javascript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - Other Style Guides - [ES5](es5/) - - [React](react/) - - [CSS & Sass](https://github.com/airbnb/css) - - [Ruby](https://github.com/airbnb/ruby) ## Table of Contents @@ -106,25 +99,6 @@ Other Style Guides const b = 2; ``` - - - [2.2](#references--disallow-var) If you must reassign references, use `let` instead of `var`. eslint: [`no-var`](http://eslint.org/docs/rules/no-var.html) jscs: [`disallowVar`](http://jscs.info/rule/disallowVar) - - > Why? `let` is block-scoped rather than function-scoped like `var`. - - ```javascript - // bad - var count = 1; - if (true) { - count += 1; - } - - // good, use the let. - let count = 1; - if (true) { - count += 1; - } - ``` - - [2.3](#references--block-scope) Note that both `let` and `const` are block-scoped. @@ -2195,53 +2169,6 @@ Other Style Guides }; ``` - - - [19.2](#commas--dangling) Additional trailing comma: **Yup.** eslint: [`comma-dangle`](http://eslint.org/docs/rules/comma-dangle.html) jscs: [`requireTrailingComma`](http://jscs.info/rule/requireTrailingComma) - - > Why? This leads to cleaner git diffs. Also, transpilers like Babel will remove the additional trailing comma in the transpiled code which means you don't have to worry about the [trailing comma problem](es5/README.md#commas) in legacy browsers. - - ```javascript - // bad - git diff without trailing comma - const hero = { - firstName: 'Florence', - - lastName: 'Nightingale' - + lastName: 'Nightingale', - + inventorOf: ['coxcomb chart', 'modern nursing'] - }; - - // good - git diff with trailing comma - const hero = { - firstName: 'Florence', - lastName: 'Nightingale', - + inventorOf: ['coxcomb chart', 'modern nursing'], - }; - - // bad - const hero = { - firstName: 'Dana', - lastName: 'Scully' - }; - - const heroes = [ - 'Batman', - 'Superman' - ]; - - // good - const hero = { - firstName: 'Dana', - lastName: 'Scully', - }; - - const heroes = [ - 'Batman', - 'Superman', - ]; - ``` - -**[⬆ back to top](#table-of-contents)** - - ## Semicolons From d39b7695044b6e68b5733b9246475c9b59afd2c0 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 12:00:13 -0500 Subject: [PATCH 2/8] more style updates --- README.md | 59 ------------------------------------------------------- 1 file changed, 59 deletions(-) diff --git a/README.md b/README.md index ade7ee5ece..4cf31c2e13 100644 --- a/README.md +++ b/README.md @@ -749,32 +749,6 @@ Other Style Guides }; ``` - - - [7.13](#functions--reassign-params) Never reassign parameters. eslint: [`no-param-reassign`](http://eslint.org/docs/rules/no-param-reassign.html) - - > Why? Reassigning parameters can lead to unexpected behavior, especially when accessing the `arguments` object. It can also cause optimization issues, especially in V8. - - ```javascript - // bad - function f1(a) { - a = 1; - } - - function f2(a) { - if (!a) { a = 1; } - } - - // good - function f3(a) { - const b = a || 1; - } - - function f4(a = 1) { - } - ``` - -**[⬆ back to top](#table-of-contents)** - ## Arrow Functions @@ -2022,39 +1996,6 @@ Other Style Guides return arr; ``` - - - [18.8](#whitespace--padded-blocks) Do not pad your blocks with blank lines. eslint: [`padded-blocks`](http://eslint.org/docs/rules/padded-blocks.html) jscs: [`disallowPaddingNewlinesInBlocks`](http://jscs.info/rule/disallowPaddingNewlinesInBlocks) - - ```javascript - // bad - function bar() { - - console.log(foo); - - } - - // also bad - if (baz) { - - console.log(qux); - } else { - console.log(foo); - - } - - // good - function bar() { - console.log(foo); - } - - // good - if (baz) { - console.log(qux); - } else { - console.log(foo); - } - ``` - - [18.9](#whitespace--in-parens) Do not add spaces inside parentheses. eslint: [`space-in-parens`](http://eslint.org/docs/rules/space-in-parens.html) jscs: [`disallowSpacesInsideParentheses`](http://jscs.info/rule/disallowSpacesInsideParentheses) From 5b304176508ff7542cdd6f6a98f625d7516d9ba8 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 12:06:10 -0500 Subject: [PATCH 3/8] add ESLINT rc config --- eslintrc.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 eslintrc.json diff --git a/eslintrc.json b/eslintrc.json new file mode 100644 index 0000000000..a9420fd007 --- /dev/null +++ b/eslintrc.json @@ -0,0 +1,22 @@ +{ + "extends": ["angular", "airbnb"], + "env": { + "browser": true, + "jasmine": true + }, + "globals": { + "inject": true + }, + "rules": { + "no-var": "off", + "comma-dangle": "off", + "no-spaced-func": "off", + "vars-on-top": "off", + "func-names": "off", + "no-param-reassign": "off", + "padded-blocks": "off", + "angular/ng_no_angular_mock": "off", + "angular/log": "off", + "angular/on-watch": "off" + } +} From 3f415317e6fea827708ccd2181f30e1fc36f5591 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 12:07:22 -0500 Subject: [PATCH 4/8] remove es5 folder --- es5/README.md | 1753 ------------------------------------------------- 1 file changed, 1753 deletions(-) delete mode 100644 es5/README.md diff --git a/es5/README.md b/es5/README.md deleted file mode 100644 index 4dcbac061b..0000000000 --- a/es5/README.md +++ /dev/null @@ -1,1753 +0,0 @@ -[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/airbnb/javascript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - -# Airbnb JavaScript Style Guide() { - -*A mostly reasonable approach to JavaScript* - - -## Table of Contents - - 1. [Types](#types) - 1. [Objects](#objects) - 1. [Arrays](#arrays) - 1. [Strings](#strings) - 1. [Functions](#functions) - 1. [Properties](#properties) - 1. [Variables](#variables) - 1. [Hoisting](#hoisting) - 1. [Comparison Operators & Equality](#comparison-operators--equality) - 1. [Blocks](#blocks) - 1. [Comments](#comments) - 1. [Whitespace](#whitespace) - 1. [Commas](#commas) - 1. [Semicolons](#semicolons) - 1. [Type Casting & Coercion](#type-casting--coercion) - 1. [Naming Conventions](#naming-conventions) - 1. [Accessors](#accessors) - 1. [Constructors](#constructors) - 1. [Events](#events) - 1. [Modules](#modules) - 1. [jQuery](#jquery) - 1. [ECMAScript 5 Compatibility](#ecmascript-5-compatibility) - 1. [Testing](#testing) - 1. [Performance](#performance) - 1. [Resources](#resources) - 1. [In the Wild](#in-the-wild) - 1. [Translation](#translation) - 1. [The JavaScript Style Guide Guide](#the-javascript-style-guide-guide) - 1. [Chat With Us About Javascript](#chat-with-us-about-javascript) - 1. [Contributors](#contributors) - 1. [License](#license) - -## Types - - - **Primitives**: When you access a primitive type you work directly on its value. - - + `string` - + `number` - + `boolean` - + `null` - + `undefined` - - ```javascript - var foo = 1; - var bar = foo; - - bar = 9; - - console.log(foo, bar); // => 1, 9 - ``` - - **Complex**: When you access a complex type you work on a reference to its value. - - + `object` - + `array` - + `function` - - ```javascript - var foo = [1, 2]; - var bar = foo; - - bar[0] = 9; - - console.log(foo[0], bar[0]); // => 9, 9 - ``` - -**[⬆ back to top](#table-of-contents)** - -## Objects - - - Use the literal syntax for object creation. - - ```javascript - // bad - var item = new Object(); - - // good - var item = {}; - ``` - - - Don't use [reserved words](http://es5.github.io/#x7.6.1) as keys. It won't work in IE8. [More info](https://github.com/airbnb/javascript/issues/61). - - ```javascript - // bad - var superman = { - default: { clark: 'kent' }, - private: true - }; - - // good - var superman = { - defaults: { clark: 'kent' }, - hidden: true - }; - ``` - - - Use readable synonyms in place of reserved words. - - ```javascript - // bad - var superman = { - class: 'alien' - }; - - // bad - var superman = { - klass: 'alien' - }; - - // good - var superman = { - type: 'alien' - }; - ``` - -**[⬆ back to top](#table-of-contents)** - -## Arrays - - - Use the literal syntax for array creation. - - ```javascript - // bad - var items = new Array(); - - // good - var items = []; - ``` - - - Use Array#push instead of direct assignment to add items to an array. - - ```javascript - var someStack = []; - - - // bad - someStack[someStack.length] = 'abracadabra'; - - // good - someStack.push('abracadabra'); - ``` - - - When you need to copy an array use Array#slice. [jsPerf](http://jsperf.com/converting-arguments-to-an-array/7) - - ```javascript - var len = items.length; - var itemsCopy = []; - var i; - - // bad - for (i = 0; i < len; i++) { - itemsCopy[i] = items[i]; - } - - // good - itemsCopy = items.slice(); - ``` - - - To convert an array-like object to an array, use Array#slice. - - ```javascript - function trigger() { - var args = Array.prototype.slice.call(arguments); - ... - } - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Strings - - - Use single quotes `''` for strings. - - ```javascript - // bad - var name = "Bob Parr"; - - // good - var name = 'Bob Parr'; - - // bad - var fullName = "Bob " + this.lastName; - - // good - var fullName = 'Bob ' + this.lastName; - ``` - - - Strings longer than 100 characters should be written across multiple lines using string concatenation. - - Note: If overused, long strings with concatenation could impact performance. [jsPerf](http://jsperf.com/ya-string-concat) & [Discussion](https://github.com/airbnb/javascript/issues/40). - - ```javascript - // bad - var errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.'; - - // bad - var errorMessage = 'This is a super long error that was thrown because \ - of Batman. When you stop to think about how Batman had anything to do \ - with this, you would get nowhere \ - fast.'; - - // good - var errorMessage = 'This is a super long error that was thrown because ' + - 'of Batman. When you stop to think about how Batman had anything to do ' + - 'with this, you would get nowhere fast.'; - ``` - - - When programmatically building up a string, use Array#join instead of string concatenation. Mostly for IE: [jsPerf](http://jsperf.com/string-vs-array-concat/2). - - ```javascript - var items; - var messages; - var length; - var i; - - messages = [{ - state: 'success', - message: 'This one worked.' - }, { - state: 'success', - message: 'This one worked as well.' - }, { - state: 'error', - message: 'This one did not work.' - }]; - - length = messages.length; - - // bad - function inbox(messages) { - items = '
    '; - - for (i = 0; i < length; i++) { - items += '
  • ' + messages[i].message + '
  • '; - } - - return items + '
'; - } - - // good - function inbox(messages) { - items = []; - - for (i = 0; i < length; i++) { - // use direct assignment in this case because we're micro-optimizing. - items[i] = '
  • ' + messages[i].message + '
  • '; - } - - return '
      ' + items.join('') + '
    '; - } - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Functions - - - Function expressions: - - ```javascript - // anonymous function expression - var anonymous = function () { - return true; - }; - - // named function expression - var named = function named() { - return true; - }; - - // immediately-invoked function expression (IIFE) - (function () { - console.log('Welcome to the Internet. Please follow me.'); - }()); - ``` - - - Never declare a function in a non-function block (if, while, etc). Assign the function to a variable instead. Browsers will allow you to do it, but they all interpret it differently, which is bad news bears. - - **Note:** ECMA-262 defines a `block` as a list of statements. A function declaration is not a statement. [Read ECMA-262's note on this issue](http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf#page=97). - - ```javascript - // bad - if (currentUser) { - function test() { - console.log('Nope.'); - } - } - - // good - var test; - if (currentUser) { - test = function test() { - console.log('Yup.'); - }; - } - ``` - - - Never name a parameter `arguments`. This will take precedence over the `arguments` object that is given to every function scope. - - ```javascript - // bad - function nope(name, options, arguments) { - // ...stuff... - } - - // good - function yup(name, options, args) { - // ...stuff... - } - ``` - -**[⬆ back to top](#table-of-contents)** - - - -## Properties - - - Use dot notation when accessing properties. - - ```javascript - var luke = { - jedi: true, - age: 28 - }; - - // bad - var isJedi = luke['jedi']; - - // good - var isJedi = luke.jedi; - ``` - - - Use subscript notation `[]` when accessing properties with a variable. - - ```javascript - var luke = { - jedi: true, - age: 28 - }; - - function getProp(prop) { - return luke[prop]; - } - - var isJedi = getProp('jedi'); - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Variables - - - Always use `var` to declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that. - - ```javascript - // bad - superPower = new SuperPower(); - - // good - var superPower = new SuperPower(); - ``` - - - Use one `var` declaration per variable. - It's easier to add new variable declarations this way, and you never have - to worry about swapping out a `;` for a `,` or introducing punctuation-only - diffs. - - ```javascript - // bad - var items = getItems(), - goSportsTeam = true, - dragonball = 'z'; - - // bad - // (compare to above, and try to spot the mistake) - var items = getItems(), - goSportsTeam = true; - dragonball = 'z'; - - // good - var items = getItems(); - var goSportsTeam = true; - var dragonball = 'z'; - ``` - - - Declare unassigned variables last. This is helpful when later on you might need to assign a variable depending on one of the previous assigned variables. - - ```javascript - // bad - var i, len, dragonball, - items = getItems(), - goSportsTeam = true; - - // bad - var i; - var items = getItems(); - var dragonball; - var goSportsTeam = true; - var len; - - // good - var items = getItems(); - var goSportsTeam = true; - var dragonball; - var length; - var i; - ``` - - - Assign variables at the top of their scope. This helps avoid issues with variable declaration and assignment hoisting related issues. - - ```javascript - // bad - function () { - test(); - console.log('doing stuff..'); - - //..other stuff.. - - var name = getName(); - - if (name === 'test') { - return false; - } - - return name; - } - - // good - function () { - var name = getName(); - - test(); - console.log('doing stuff..'); - - //..other stuff.. - - if (name === 'test') { - return false; - } - - return name; - } - - // bad - unnecessary function call - function () { - var name = getName(); - - if (!arguments.length) { - return false; - } - - this.setFirstName(name); - - return true; - } - - // good - function () { - var name; - - if (!arguments.length) { - return false; - } - - name = getName(); - this.setFirstName(name); - - return true; - } - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Hoisting - - - Variable declarations get hoisted to the top of their scope, but their assignment does not. - - ```javascript - // we know this wouldn't work (assuming there - // is no notDefined global variable) - function example() { - console.log(notDefined); // => throws a ReferenceError - } - - // creating a variable declaration after you - // reference the variable will work due to - // variable hoisting. Note: the assignment - // value of `true` is not hoisted. - function example() { - console.log(declaredButNotAssigned); // => undefined - var declaredButNotAssigned = true; - } - - // The interpreter is hoisting the variable - // declaration to the top of the scope, - // which means our example could be rewritten as: - function example() { - var declaredButNotAssigned; - console.log(declaredButNotAssigned); // => undefined - declaredButNotAssigned = true; - } - ``` - - - Anonymous function expressions hoist their variable name, but not the function assignment. - - ```javascript - function example() { - console.log(anonymous); // => undefined - - anonymous(); // => TypeError anonymous is not a function - - var anonymous = function () { - console.log('anonymous function expression'); - }; - } - ``` - - - Named function expressions hoist the variable name, not the function name or the function body. - - ```javascript - function example() { - console.log(named); // => undefined - - named(); // => TypeError named is not a function - - superPower(); // => ReferenceError superPower is not defined - - var named = function superPower() { - console.log('Flying'); - }; - } - - // the same is true when the function name - // is the same as the variable name. - function example() { - console.log(named); // => undefined - - named(); // => TypeError named is not a function - - var named = function named() { - console.log('named'); - } - } - ``` - - - Function declarations hoist their name and the function body. - - ```javascript - function example() { - superPower(); // => Flying - - function superPower() { - console.log('Flying'); - } - } - ``` - - - For more information refer to [JavaScript Scoping & Hoisting](http://www.adequatelygood.com/2010/2/JavaScript-Scoping-and-Hoisting) by [Ben Cherry](http://www.adequatelygood.com/). - -**[⬆ back to top](#table-of-contents)** - - - -## Comparison Operators & Equality - - - Use `===` and `!==` over `==` and `!=`. - - Conditional statements such as the `if` statement evaluate their expression using coercion with the `ToBoolean` abstract method and always follow these simple rules: - - + **Objects** evaluate to **true** - + **Undefined** evaluates to **false** - + **Null** evaluates to **false** - + **Booleans** evaluate to **the value of the boolean** - + **Numbers** evaluate to **false** if **+0, -0, or NaN**, otherwise **true** - + **Strings** evaluate to **false** if an empty string `''`, otherwise **true** - - ```javascript - if ([0]) { - // true - // An array is an object, objects evaluate to true - } - ``` - - - Use shortcuts. - - ```javascript - // bad - if (name !== '') { - // ...stuff... - } - - // good - if (name) { - // ...stuff... - } - - // bad - if (collection.length > 0) { - // ...stuff... - } - - // good - if (collection.length) { - // ...stuff... - } - ``` - - - For more information see [Truth Equality and JavaScript](http://javascriptweblog.wordpress.com/2011/02/07/truth-equality-and-javascript/#more-2108) by Angus Croll. - -**[⬆ back to top](#table-of-contents)** - - -## Blocks - - - Use braces with all multi-line blocks. - - ```javascript - // bad - if (test) - return false; - - // good - if (test) return false; - - // good - if (test) { - return false; - } - - // bad - function () { return false; } - - // good - function () { - return false; - } - ``` - - - If you're using multi-line blocks with `if` and `else`, put `else` on the same line as your - `if` block's closing brace. - - ```javascript - // bad - if (test) { - thing1(); - thing2(); - } - else { - thing3(); - } - - // good - if (test) { - thing1(); - thing2(); - } else { - thing3(); - } - ``` - - -**[⬆ back to top](#table-of-contents)** - - -## Comments - - - Use `/** ... */` for multi-line comments. Include a description, specify types and values for all parameters and return values. - - ```javascript - // bad - // make() returns a new element - // based on the passed in tag name - // - // @param {String} tag - // @return {Element} element - function make(tag) { - - // ...stuff... - - return element; - } - - // good - /** - * make() returns a new element - * based on the passed in tag name - * - * @param {String} tag - * @return {Element} element - */ - function make(tag) { - - // ...stuff... - - return element; - } - ``` - - - Use `//` for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment. - - ```javascript - // bad - var active = true; // is current tab - - // good - // is current tab - var active = true; - - // bad - function getType() { - console.log('fetching type...'); - // set the default type to 'no type' - var type = this.type || 'no type'; - - return type; - } - - // good - function getType() { - console.log('fetching type...'); - - // set the default type to 'no type' - var type = this.type || 'no type'; - - return type; - } - ``` - - - Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you're pointing out a problem that needs to be revisited, or if you're suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are `FIXME -- need to figure this out` or `TODO -- need to implement`. - - - Use `// FIXME:` to annotate problems. - - ```javascript - function Calculator() { - - // FIXME: shouldn't use a global here - total = 0; - - return this; - } - ``` - - - Use `// TODO:` to annotate solutions to problems. - - ```javascript - function Calculator() { - - // TODO: total should be configurable by an options param - this.total = 0; - - return this; - } - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Whitespace - - - Use soft tabs set to 2 spaces. - - ```javascript - // bad - function () { - ∙∙∙∙var name; - } - - // bad - function () { - ∙var name; - } - - // good - function () { - ∙∙var name; - } - ``` - - - Place 1 space before the leading brace. - - ```javascript - // bad - function test(){ - console.log('test'); - } - - // good - function test() { - console.log('test'); - } - - // bad - dog.set('attr',{ - age: '1 year', - breed: 'Bernese Mountain Dog' - }); - - // good - dog.set('attr', { - age: '1 year', - breed: 'Bernese Mountain Dog' - }); - ``` - - - Place 1 space before the opening parenthesis in control statements (`if`, `while` etc.). Place no space before the argument list in function calls and declarations. - - ```javascript - // bad - if(isJedi) { - fight (); - } - - // good - if (isJedi) { - fight(); - } - - // bad - function fight () { - console.log ('Swooosh!'); - } - - // good - function fight() { - console.log('Swooosh!'); - } - ``` - - - Set off operators with spaces. - - ```javascript - // bad - var x=y+5; - - // good - var x = y + 5; - ``` - - - End files with a single newline character. - - ```javascript - // bad - (function (global) { - // ...stuff... - })(this); - ``` - - ```javascript - // bad - (function (global) { - // ...stuff... - })(this);↵ - ↵ - ``` - - ```javascript - // good - (function (global) { - // ...stuff... - })(this);↵ - ``` - - - Use indentation when making long method chains. Use a leading dot, which - emphasizes that the line is a method call, not a new statement. - - ```javascript - // bad - $('#items').find('.selected').highlight().end().find('.open').updateCount(); - - // bad - $('#items'). - find('.selected'). - highlight(). - end(). - find('.open'). - updateCount(); - - // good - $('#items') - .find('.selected') - .highlight() - .end() - .find('.open') - .updateCount(); - - // bad - var leds = stage.selectAll('.led').data(data).enter().append('svg:svg').classed('led', true) - .attr('width', (radius + margin) * 2).append('svg:g') - .attr('transform', 'translate(' + (radius + margin) + ',' + (radius + margin) + ')') - .call(tron.led); - - // good - var leds = stage.selectAll('.led') - .data(data) - .enter().append('svg:svg') - .classed('led', true) - .attr('width', (radius + margin) * 2) - .append('svg:g') - .attr('transform', 'translate(' + (radius + margin) + ',' + (radius + margin) + ')') - .call(tron.led); - ``` - - - Leave a blank line after blocks and before the next statement - - ```javascript - // bad - if (foo) { - return bar; - } - return baz; - - // good - if (foo) { - return bar; - } - - return baz; - - // bad - var obj = { - foo: function () { - }, - bar: function () { - } - }; - return obj; - - // good - var obj = { - foo: function () { - }, - - bar: function () { - } - }; - - return obj; - ``` - - -**[⬆ back to top](#table-of-contents)** - -## Commas - - - Leading commas: **Nope.** - - ```javascript - // bad - var story = [ - once - , upon - , aTime - ]; - - // good - var story = [ - once, - upon, - aTime - ]; - - // bad - var hero = { - firstName: 'Bob' - , lastName: 'Parr' - , heroName: 'Mr. Incredible' - , superPower: 'strength' - }; - - // good - var hero = { - firstName: 'Bob', - lastName: 'Parr', - heroName: 'Mr. Incredible', - superPower: 'strength' - }; - ``` - - - Additional trailing comma: **Nope.** This can cause problems with IE6/7 and IE9 if it's in quirksmode. Also, in some implementations of ES3 would add length to an array if it had an additional trailing comma. This was clarified in ES5 ([source](http://es5.github.io/#D)): - - > Edition 5 clarifies the fact that a trailing comma at the end of an ArrayInitialiser does not add to the length of the array. This is not a semantic change from Edition 3 but some implementations may have previously misinterpreted this. - - ```javascript - // bad - var hero = { - firstName: 'Kevin', - lastName: 'Flynn', - }; - - var heroes = [ - 'Batman', - 'Superman', - ]; - - // good - var hero = { - firstName: 'Kevin', - lastName: 'Flynn' - }; - - var heroes = [ - 'Batman', - 'Superman' - ]; - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Semicolons - - - **Yup.** - - ```javascript - // bad - (function () { - var name = 'Skywalker' - return name - })() - - // good - (function () { - var name = 'Skywalker'; - return name; - })(); - - // good (guards against the function becoming an argument when two files with IIFEs are concatenated) - ;(function () { - var name = 'Skywalker'; - return name; - })(); - ``` - - [Read more](http://stackoverflow.com/a/7365214/1712802). - -**[⬆ back to top](#table-of-contents)** - - -## Type Casting & Coercion - - - Perform type coercion at the beginning of the statement. - - Strings: - - ```javascript - // => this.reviewScore = 9; - - // bad - var totalScore = this.reviewScore + ''; - - // good - var totalScore = '' + this.reviewScore; - - // bad - var totalScore = '' + this.reviewScore + ' total score'; - - // good - var totalScore = this.reviewScore + ' total score'; - ``` - - - Use `parseInt` for Numbers and always with a radix for type casting. - - ```javascript - var inputValue = '4'; - - // bad - var val = new Number(inputValue); - - // bad - var val = +inputValue; - - // bad - var val = inputValue >> 0; - - // bad - var val = parseInt(inputValue); - - // good - var val = Number(inputValue); - - // good - var val = parseInt(inputValue, 10); - ``` - - - If for whatever reason you are doing something wild and `parseInt` is your bottleneck and need to use Bitshift for [performance reasons](http://jsperf.com/coercion-vs-casting/3), leave a comment explaining why and what you're doing. - - ```javascript - // good - /** - * parseInt was the reason my code was slow. - * Bitshifting the String to coerce it to a - * Number made it a lot faster. - */ - var val = inputValue >> 0; - ``` - - - **Note:** Be careful when using bitshift operations. Numbers are represented as [64-bit values](http://es5.github.io/#x4.3.19), but Bitshift operations always return a 32-bit integer ([source](http://es5.github.io/#x11.7)). Bitshift can lead to unexpected behavior for integer values larger than 32 bits. [Discussion](https://github.com/airbnb/javascript/issues/109). Largest signed 32-bit Int is 2,147,483,647: - - ```javascript - 2147483647 >> 0 //=> 2147483647 - 2147483648 >> 0 //=> -2147483648 - 2147483649 >> 0 //=> -2147483647 - ``` - - - Booleans: - - ```javascript - var age = 0; - - // bad - var hasAge = new Boolean(age); - - // good - var hasAge = Boolean(age); - - // good - var hasAge = !!age; - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Naming Conventions - - - Avoid single letter names. Be descriptive with your naming. - - ```javascript - // bad - function q() { - // ...stuff... - } - - // good - function query() { - // ..stuff.. - } - ``` - - - Use camelCase when naming objects, functions, and instances. - - ```javascript - // bad - var OBJEcttsssss = {}; - var this_is_my_object = {}; - var o = {}; - function c() {} - - // good - var thisIsMyObject = {}; - function thisIsMyFunction() {} - ``` - - - Use PascalCase when naming constructors or classes. - - ```javascript - // bad - function user(options) { - this.name = options.name; - } - - var bad = new user({ - name: 'nope' - }); - - // good - function User(options) { - this.name = options.name; - } - - var good = new User({ - name: 'yup' - }); - ``` - - - Do not use trailing or leading underscores. - - > Why? JavaScript does not have the concept of privacy in terms of properties or methods. Although a leading underscore is a common convention to mean “private”, in fact, these properties are fully public, and as such, are part of your public API contract. This convention might lead developers to wrongly think that a change won't count as breaking, or that tests aren't needed. tl;dr: if you want something to be “private”, it must not be observably present. - - ```javascript - // bad - this.__firstName__ = 'Panda'; - this.firstName_ = 'Panda'; - this._firstName = 'Panda'; - - // good - this.firstName = 'Panda'; - ``` - - - Don't save references to this. Use Function#bind. - - ```javascript - // bad - function () { - var self = this; - return function () { - console.log(self); - }; - } - - // bad - function () { - var that = this; - return function () { - console.log(that); - }; - } - - // bad - function () { - var _this = this; - return function () { - console.log(_this); - }; - } - - // good - function () { - return function () { - console.log(this); - }.bind(this); - } - ``` - - - Name your functions. This is helpful for stack traces. - - ```javascript - // bad - var log = function (msg) { - console.log(msg); - }; - - // good - var log = function log(msg) { - console.log(msg); - }; - ``` - - - **Note:** IE8 and below exhibit some quirks with named function expressions. See [http://kangax.github.io/nfe/](http://kangax.github.io/nfe/) for more info. - - - If your file exports a single class, your filename should be exactly the name of the class. - ```javascript - // file contents - class CheckBox { - // ... - } - module.exports = CheckBox; - - // in some other file - // bad - var CheckBox = require('./checkBox'); - - // bad - var CheckBox = require('./check_box'); - - // good - var CheckBox = require('./CheckBox'); - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Accessors - - - Accessor functions for properties are not required. - - If you do make accessor functions use getVal() and setVal('hello'). - - ```javascript - // bad - dragon.age(); - - // good - dragon.getAge(); - - // bad - dragon.age(25); - - // good - dragon.setAge(25); - ``` - - - If the property is a boolean, use isVal() or hasVal(). - - ```javascript - // bad - if (!dragon.age()) { - return false; - } - - // good - if (!dragon.hasAge()) { - return false; - } - ``` - - - It's okay to create get() and set() functions, but be consistent. - - ```javascript - function Jedi(options) { - options || (options = {}); - var lightsaber = options.lightsaber || 'blue'; - this.set('lightsaber', lightsaber); - } - - Jedi.prototype.set = function set(key, val) { - this[key] = val; - }; - - Jedi.prototype.get = function get(key) { - return this[key]; - }; - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Constructors - - - Assign methods to the prototype object, instead of overwriting the prototype with a new object. Overwriting the prototype makes inheritance impossible: by resetting the prototype you'll overwrite the base! - - ```javascript - function Jedi() { - console.log('new jedi'); - } - - // bad - Jedi.prototype = { - fight: function fight() { - console.log('fighting'); - }, - - block: function block() { - console.log('blocking'); - } - }; - - // good - Jedi.prototype.fight = function fight() { - console.log('fighting'); - }; - - Jedi.prototype.block = function block() { - console.log('blocking'); - }; - ``` - - - Methods can return `this` to help with method chaining. - - ```javascript - // bad - Jedi.prototype.jump = function jump() { - this.jumping = true; - return true; - }; - - Jedi.prototype.setHeight = function setHeight(height) { - this.height = height; - }; - - var luke = new Jedi(); - luke.jump(); // => true - luke.setHeight(20); // => undefined - - // good - Jedi.prototype.jump = function jump() { - this.jumping = true; - return this; - }; - - Jedi.prototype.setHeight = function setHeight(height) { - this.height = height; - return this; - }; - - var luke = new Jedi(); - - luke.jump() - .setHeight(20); - ``` - - - - It's okay to write a custom toString() method, just make sure it works successfully and causes no side effects. - - ```javascript - function Jedi(options) { - options || (options = {}); - this.name = options.name || 'no name'; - } - - Jedi.prototype.getName = function getName() { - return this.name; - }; - - Jedi.prototype.toString = function toString() { - return 'Jedi - ' + this.getName(); - }; - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Events - - - When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass a hash instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of: - - ```js - // bad - $(this).trigger('listingUpdated', listing.id); - - ... - - $(this).on('listingUpdated', function (e, listingId) { - // do something with listingId - }); - ``` - - prefer: - - ```js - // good - $(this).trigger('listingUpdated', { listingId : listing.id }); - - ... - - $(this).on('listingUpdated', function (e, data) { - // do something with data.listingId - }); - ``` - - **[⬆ back to top](#table-of-contents)** - - -## Modules - - - The module should start with a `!`. This ensures that if a malformed module forgets to include a final semicolon there aren't errors in production when the scripts get concatenated. [Explanation](https://github.com/airbnb/javascript/issues/44#issuecomment-13063933) - - The file should be named with camelCase, live in a folder with the same name, and match the name of the single export. - - Add a method called `noConflict()` that sets the exported module to the previous version and returns this one. - - Always declare `'use strict';` at the top of the module. - - ```javascript - // fancyInput/fancyInput.js - - !function (global) { - 'use strict'; - - var previousFancyInput = global.FancyInput; - - function FancyInput(options) { - this.options = options || {}; - } - - FancyInput.noConflict = function noConflict() { - global.FancyInput = previousFancyInput; - return FancyInput; - }; - - global.FancyInput = FancyInput; - }(this); - ``` - -**[⬆ back to top](#table-of-contents)** - - -## jQuery - - - Prefix jQuery object variables with a `$`. - - ```javascript - // bad - var sidebar = $('.sidebar'); - - // good - var $sidebar = $('.sidebar'); - ``` - - - Cache jQuery lookups. - - ```javascript - // bad - function setSidebar() { - $('.sidebar').hide(); - - // ...stuff... - - $('.sidebar').css({ - 'background-color': 'pink' - }); - } - - // good - function setSidebar() { - var $sidebar = $('.sidebar'); - $sidebar.hide(); - - // ...stuff... - - $sidebar.css({ - 'background-color': 'pink' - }); - } - ``` - - - For DOM queries use Cascading `$('.sidebar ul')` or parent > child `$('.sidebar > ul')`. [jsPerf](http://jsperf.com/jquery-find-vs-context-sel/16) - - Use `find` with scoped jQuery object queries. - - ```javascript - // bad - $('ul', '.sidebar').hide(); - - // bad - $('.sidebar').find('ul').hide(); - - // good - $('.sidebar ul').hide(); - - // good - $('.sidebar > ul').hide(); - - // good - $sidebar.find('ul').hide(); - ``` - -**[⬆ back to top](#table-of-contents)** - - -## ECMAScript 5 Compatibility - - - Refer to [Kangax](https://twitter.com/kangax/)'s ES5 [compatibility table](http://kangax.github.com/es5-compat-table/). - -**[⬆ back to top](#table-of-contents)** - - -## Testing - - - **Yup.** - - ```javascript - function () { - return true; - } - ``` - -**[⬆ back to top](#table-of-contents)** - - -## Performance - - - [On Layout & Web Performance](http://kellegous.com/j/2013/01/26/layout-performance/) - - [String vs Array Concat](http://jsperf.com/string-vs-array-concat/2) - - [Try/Catch Cost In a Loop](http://jsperf.com/try-catch-in-loop-cost) - - [Bang Function](http://jsperf.com/bang-function) - - [jQuery Find vs Context, Selector](http://jsperf.com/jquery-find-vs-context-sel/13) - - [innerHTML vs textContent for script text](http://jsperf.com/innerhtml-vs-textcontent-for-script-text) - - [Long String Concatenation](http://jsperf.com/ya-string-concat) - - Loading... - -**[⬆ back to top](#table-of-contents)** - - -## Resources - - -**Read This** - - - [Annotated ECMAScript 5.1](http://es5.github.com/) - -**Tools** - - - Code Style Linters - + [JSHint](http://www.jshint.com/) - [Airbnb Style .jshintrc](https://github.com/airbnb/javascript/blob/master/linters/.jshintrc) - + [JSCS](https://github.com/jscs-dev/node-jscs) - [Airbnb Style Preset](https://github.com/jscs-dev/node-jscs/blob/master/presets/airbnb.json) - -**Other Style Guides** - - - [Google JavaScript Style Guide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml) - - [jQuery Core Style Guidelines](http://docs.jquery.com/JQuery_Core_Style_Guidelines) - - [Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwldrn/idiomatic.js/) - - [JavaScript Standard Style](https://github.com/feross/standard) - -**Other Styles** - - - [Naming this in nested functions](https://gist.github.com/4135065) - Christian Johansen - - [Conditional Callbacks](https://github.com/airbnb/javascript/issues/52) - Ross Allen - - [Popular JavaScript Coding Conventions on Github](http://sideeffect.kr/popularconvention/#javascript) - JeongHoon Byun - - [Multiple var statements in JavaScript, not superfluous](http://benalman.com/news/2012/05/multiple-var-statements-javascript/) - Ben Alman - -**Further Reading** - - - [Understanding JavaScript Closures](http://javascriptweblog.wordpress.com/2010/10/25/understanding-javascript-closures/) - Angus Croll - - [Basic JavaScript for the impatient programmer](http://www.2ality.com/2013/06/basic-javascript.html) - Dr. Axel Rauschmayer - - [You Might Not Need jQuery](http://youmightnotneedjquery.com/) - Zack Bloom & Adam Schwartz - - [ES6 Features](https://github.com/lukehoban/es6features) - Luke Hoban - - [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) - Benjamin De Cock - -**Books** - - - [JavaScript: The Good Parts](http://www.amazon.com/JavaScript-Good-Parts-Douglas-Crockford/dp/0596517742) - Douglas Crockford - - [JavaScript Patterns](http://www.amazon.com/JavaScript-Patterns-Stoyan-Stefanov/dp/0596806752) - Stoyan Stefanov - - [Pro JavaScript Design Patterns](http://www.amazon.com/JavaScript-Design-Patterns-Recipes-Problem-Solution/dp/159059908X) - Ross Harmes and Dustin Diaz - - [High Performance Web Sites: Essential Knowledge for Front-End Engineers](http://www.amazon.com/High-Performance-Web-Sites-Essential/dp/0596529309) - Steve Souders - - [Maintainable JavaScript](http://www.amazon.com/Maintainable-JavaScript-Nicholas-C-Zakas/dp/1449327680) - Nicholas C. Zakas - - [JavaScript Web Applications](http://www.amazon.com/JavaScript-Web-Applications-Alex-MacCaw/dp/144930351X) - Alex MacCaw - - [Pro JavaScript Techniques](http://www.amazon.com/Pro-JavaScript-Techniques-John-Resig/dp/1590597273) - John Resig - - [Smashing Node.js: JavaScript Everywhere](http://www.amazon.com/Smashing-Node-js-JavaScript-Everywhere-Magazine/dp/1119962595) - Guillermo Rauch - - [Secrets of the JavaScript Ninja](http://www.amazon.com/Secrets-JavaScript-Ninja-John-Resig/dp/193398869X) - John Resig and Bear Bibeault - - [Human JavaScript](http://humanjavascript.com/) - Henrik Joreteg - - [Superhero.js](http://superherojs.com/) - Kim Joar Bekkelund, Mads Mobæk, & Olav Bjorkoy - - [JSBooks](http://jsbooks.revolunet.com/) - Julien Bouquillon - - [Third Party JavaScript](http://manning.com/vinegar/) - Ben Vinegar and Anton Kovalyov - - [Effective JavaScript: 68 Specific Ways to Harness the Power of JavaScript](http://amzn.com/0321812182) - David Herman - - [Eloquent JavaScript](http://eloquentjavascript.net) - Marijn Haverbeke - - [You Don't Know JS](https://github.com/getify/You-Dont-Know-JS) - Kyle Simpson - -**Blogs** - - - [DailyJS](http://dailyjs.com/) - - [JavaScript Weekly](http://javascriptweekly.com/) - - [JavaScript, JavaScript...](http://javascriptweblog.wordpress.com/) - - [Bocoup Weblog](http://weblog.bocoup.com/) - - [Adequately Good](http://www.adequatelygood.com/) - - [NCZOnline](http://www.nczonline.net/) - - [Perfection Kills](http://perfectionkills.com/) - - [Ben Alman](http://benalman.com/) - - [Dmitry Baranovskiy](http://dmitry.baranovskiy.com/) - - [Dustin Diaz](http://dustindiaz.com/) - - [nettuts](http://net.tutsplus.com/?s=javascript) - -**Podcasts** - - - [JavaScript Jabber](http://devchat.tv/js-jabber/) - - -**[⬆ back to top](#table-of-contents)** - -## In the Wild - - This is a list of organizations that are using this style guide. Send us a pull request or open an issue and we'll add you to the list. - - - **Aan Zee**: [AanZee/javascript](https://github.com/AanZee/javascript) - - **Adult Swim**: [adult-swim/javascript](https://github.com/adult-swim/javascript) - - **Airbnb**: [airbnb/javascript](https://github.com/airbnb/javascript) - - **Apartmint**: [apartmint/javascript](https://github.com/apartmint/javascript) - - **Avalara**: [avalara/javascript](https://github.com/avalara/javascript) - - **Billabong**: [billabong/javascript](https://github.com/billabong/javascript) - - **Compass Learning**: [compasslearning/javascript-style-guide](https://github.com/compasslearning/javascript-style-guide) - - **DailyMotion**: [dailymotion/javascript](https://github.com/dailymotion/javascript) - - **Digitpaint** [digitpaint/javascript](https://github.com/digitpaint/javascript) - - **Evernote**: [evernote/javascript-style-guide](https://github.com/evernote/javascript-style-guide) - - **ExactTarget**: [ExactTarget/javascript](https://github.com/ExactTarget/javascript) - - **Flexberry**: [Flexberry/javascript-style-guide](https://github.com/Flexberry/javascript-style-guide) - - **Gawker Media**: [gawkermedia/javascript](https://github.com/gawkermedia/javascript) - - **General Electric**: [GeneralElectric/javascript](https://github.com/GeneralElectric/javascript) - - **GoodData**: [gooddata/gdc-js-style](https://github.com/gooddata/gdc-js-style) - - **Grooveshark**: [grooveshark/javascript](https://github.com/grooveshark/javascript) - - **How About We**: [howaboutwe/javascript](https://github.com/howaboutwe/javascript) - - **InfoJobs**: [InfoJobs/JavaScript-Style-Guide](https://github.com/InfoJobs/JavaScript-Style-Guide) - - **Intent Media**: [intentmedia/javascript](https://github.com/intentmedia/javascript) - - **Jam3**: [Jam3/Javascript-Code-Conventions](https://github.com/Jam3/Javascript-Code-Conventions) - - **JSSolutions**: [JSSolutions/javascript](https://github.com/JSSolutions/javascript) - - **Kinetica Solutions**: [kinetica/javascript](https://github.com/kinetica/javascript) - - **Mighty Spring**: [mightyspring/javascript](https://github.com/mightyspring/javascript) - - **MinnPost**: [MinnPost/javascript](https://github.com/MinnPost/javascript) - - **ModCloth**: [modcloth/javascript](https://github.com/modcloth/javascript) - - **Money Advice Service**: [moneyadviceservice/javascript](https://github.com/moneyadviceservice/javascript) - - **Muber**: [muber/javascript](https://github.com/muber/javascript) - - **National Geographic**: [natgeo/javascript](https://github.com/natgeo/javascript) - - **National Park Service**: [nationalparkservice/javascript](https://github.com/nationalparkservice/javascript) - - **Nimbl3**: [nimbl3/javascript](https://github.com/nimbl3/javascript) - - **Nordic Venture Family**: [CodeDistillery/javascript](https://github.com/CodeDistillery/javascript) - - **Orion Health**: [orionhealth/javascript](https://github.com/orionhealth/javascript) - - **Peerby**: [Peerby/javascript](https://github.com/Peerby/javascript) - - **Razorfish**: [razorfish/javascript-style-guide](https://github.com/razorfish/javascript-style-guide) - - **reddit**: [reddit/styleguide/javascript](https://github.com/reddit/styleguide/tree/master/javascript) - - **REI**: [reidev/js-style-guide](https://github.com/reidev/js-style-guide) - - **Ripple**: [ripple/javascript-style-guide](https://github.com/ripple/javascript-style-guide) - - **SeekingAlpha**: [seekingalpha/javascript-style-guide](https://github.com/seekingalpha/javascript-style-guide) - - **Shutterfly**: [shutterfly/javascript](https://github.com/shutterfly/javascript) - - **StudentSphere**: [studentsphere/javascript](https://github.com/studentsphere/javascript) - - **Super**: [SuperJobs/javascript](https://github.com/SuperJobs/javascript) - - **SysGarage**: [sysgarage/javascript-style-guide](https://github.com/sysgarage/javascript-style-guide) - - **Target**: [target/javascript](https://github.com/target/javascript) - - **TheLadders**: [TheLadders/javascript](https://github.com/TheLadders/javascript) - - **T4R Technology**: [T4R-Technology/javascript](https://github.com/T4R-Technology/javascript) - - **VoxFeed**: [VoxFeed/javascript-style-guide](https://github.com/VoxFeed/javascript-style-guide) - - **Weggo**: [Weggo/javascript](https://github.com/Weggo/javascript) - - **Zillow**: [zillow/javascript](https://github.com/zillow/javascript) - - **ZocDoc**: [ZocDoc/javascript](https://github.com/ZocDoc/javascript) - -## Translation - - This style guide is also available in other languages: - - - ![br](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Brazil.png) **Brazilian Portuguese**: [armoucar/javascript-style-guide](https://github.com/armoucar/javascript-style-guide) - - ![bg](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Bulgaria.png) **Bulgarian**: [borislavvv/javascript](https://github.com/borislavvv/javascript) - - ![ca](https://raw.githubusercontent.com/fpmweb/javascript-style-guide/master/img/catala.png) **Catalan**: [fpmweb/javascript-style-guide](https://github.com/fpmweb/javascript-style-guide) - - ![tw](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Taiwan.png) **Chinese(Traditional)**: [jigsawye/javascript](https://github.com/jigsawye/javascript) - - ![cn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) **Chinese(Simplified)**: [sivan/javascript-style-guide](https://github.com/sivan/javascript-style-guide) - - ![fr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/France.png) **French**: [nmussy/javascript-style-guide](https://github.com/nmussy/javascript-style-guide) - - ![de](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Germany.png) **German**: [timofurrer/javascript-style-guide](https://github.com/timofurrer/javascript-style-guide) - - ![it](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Italy.png) **Italian**: [sinkswim/javascript-style-guide](https://github.com/sinkswim/javascript-style-guide) - - ![jp](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Japan.png) **Japanese**: [mitsuruog/javacript-style-guide](https://github.com/mitsuruog/javacript-style-guide) - - ![kr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **Korean**: [tipjs/javascript-style-guide](https://github.com/tipjs/javascript-style-guide) - - ![pl](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Poland.png) **Polish**: [mjurczyk/javascript](https://github.com/mjurczyk/javascript) - - ![ru](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Russia.png) **Russian**: [uprock/javascript](https://github.com/uprock/javascript) - - ![es](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Spain.png) **Spanish**: [paolocarrasco/javascript-style-guide](https://github.com/paolocarrasco/javascript-style-guide) - - ![th](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Thailand.png) **Thai**: [lvarayut/javascript-style-guide](https://github.com/lvarayut/javascript-style-guide) - -## The JavaScript Style Guide Guide - - - [Reference](https://github.com/airbnb/javascript/wiki/The-JavaScript-Style-Guide-Guide) - -## Chat With Us About JavaScript - - - Find us on [gitter](https://gitter.im/airbnb/javascript). - -## Contributors - - - [View Contributors](https://github.com/airbnb/javascript/graphs/contributors) - - -## License - -(The MIT License) - -Copyright (c) 2014 Airbnb - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -**[⬆ back to top](#table-of-contents)** - -# }; From 42ac03e68bbf5e63f736d229754d156f252101d3 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 12:07:37 -0500 Subject: [PATCH 5/8] remove packages --- packages/eslint-config-airbnb-base/.babelrc | 3 - packages/eslint-config-airbnb-base/.eslintrc | 8 - .../eslint-config-airbnb-base/CHANGELOG.md | 78 ----- packages/eslint-config-airbnb-base/README.md | 33 -- packages/eslint-config-airbnb-base/index.js | 18 -- packages/eslint-config-airbnb-base/legacy.js | 21 -- .../eslint-config-airbnb-base/package.json | 63 ---- .../rules/best-practices.js | 235 -------------- .../eslint-config-airbnb-base/rules/errors.js | 103 ------ .../eslint-config-airbnb-base/rules/es6.js | 145 --------- .../rules/imports.js | 132 -------- .../eslint-config-airbnb-base/rules/node.js | 39 --- .../eslint-config-airbnb-base/rules/strict.js | 6 - .../eslint-config-airbnb-base/rules/style.js | 301 ------------------ .../rules/variables.js | 41 --- .../eslint-config-airbnb-base/test/.eslintrc | 12 - .../test/test-base.js | 29 -- packages/eslint-config-airbnb/.babelrc | 3 - packages/eslint-config-airbnb/.eslintrc | 8 - packages/eslint-config-airbnb/CHANGELOG.md | 228 ------------- packages/eslint-config-airbnb/README.md | 36 --- packages/eslint-config-airbnb/base.js | 4 - packages/eslint-config-airbnb/index.js | 9 - packages/eslint-config-airbnb/legacy.js | 4 - packages/eslint-config-airbnb/package.json | 68 ---- .../eslint-config-airbnb/rules/react-a11y.js | 87 ----- packages/eslint-config-airbnb/rules/react.js | 235 -------------- packages/eslint-config-airbnb/test/.eslintrc | 13 - .../eslint-config-airbnb/test/test-base.js | 33 -- .../test/test-react-order.js | 95 ------ 30 files changed, 2090 deletions(-) delete mode 100644 packages/eslint-config-airbnb-base/.babelrc delete mode 100644 packages/eslint-config-airbnb-base/.eslintrc delete mode 100644 packages/eslint-config-airbnb-base/CHANGELOG.md delete mode 100644 packages/eslint-config-airbnb-base/README.md delete mode 100644 packages/eslint-config-airbnb-base/index.js delete mode 100644 packages/eslint-config-airbnb-base/legacy.js delete mode 100644 packages/eslint-config-airbnb-base/package.json delete mode 100644 packages/eslint-config-airbnb-base/rules/best-practices.js delete mode 100644 packages/eslint-config-airbnb-base/rules/errors.js delete mode 100644 packages/eslint-config-airbnb-base/rules/es6.js delete mode 100644 packages/eslint-config-airbnb-base/rules/imports.js delete mode 100644 packages/eslint-config-airbnb-base/rules/node.js delete mode 100644 packages/eslint-config-airbnb-base/rules/strict.js delete mode 100644 packages/eslint-config-airbnb-base/rules/style.js delete mode 100644 packages/eslint-config-airbnb-base/rules/variables.js delete mode 100644 packages/eslint-config-airbnb-base/test/.eslintrc delete mode 100644 packages/eslint-config-airbnb-base/test/test-base.js delete mode 100644 packages/eslint-config-airbnb/.babelrc delete mode 100644 packages/eslint-config-airbnb/.eslintrc delete mode 100644 packages/eslint-config-airbnb/CHANGELOG.md delete mode 100644 packages/eslint-config-airbnb/README.md delete mode 100644 packages/eslint-config-airbnb/base.js delete mode 100644 packages/eslint-config-airbnb/index.js delete mode 100644 packages/eslint-config-airbnb/legacy.js delete mode 100644 packages/eslint-config-airbnb/package.json delete mode 100644 packages/eslint-config-airbnb/rules/react-a11y.js delete mode 100644 packages/eslint-config-airbnb/rules/react.js delete mode 100644 packages/eslint-config-airbnb/test/.eslintrc delete mode 100644 packages/eslint-config-airbnb/test/test-base.js delete mode 100644 packages/eslint-config-airbnb/test/test-react-order.js diff --git a/packages/eslint-config-airbnb-base/.babelrc b/packages/eslint-config-airbnb-base/.babelrc deleted file mode 100644 index e0aceaae1c..0000000000 --- a/packages/eslint-config-airbnb-base/.babelrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "presets": ["airbnb"] -} diff --git a/packages/eslint-config-airbnb-base/.eslintrc b/packages/eslint-config-airbnb-base/.eslintrc deleted file mode 100644 index 6c8556be3b..0000000000 --- a/packages/eslint-config-airbnb-base/.eslintrc +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "./index.js", - "rules": { - // disable requiring trailing commas because it might be nice to revert to - // being JSON at some point, and I don't want to make big changes now. - "comma-dangle": 0 - } -} diff --git a/packages/eslint-config-airbnb-base/CHANGELOG.md b/packages/eslint-config-airbnb-base/CHANGELOG.md deleted file mode 100644 index 4c0b304f9c..0000000000 --- a/packages/eslint-config-airbnb-base/CHANGELOG.md +++ /dev/null @@ -1,78 +0,0 @@ -5.0.0 / 2016-07-24 -================== - - [breaking] enable `import/newline-after-import` - - [breaking] enable overlooked rules: `linebreak-style`, `new-parens`, `no-continue`, `no-lonely-if`, `operator-assignment`, `space-unary-ops`, `dot-location`, `no-extra-boolean-cast`, `no-this-before-super`, `require-yield`, `no-path-concat`, `no-label-var`, `no-void`, `constructor-super`, `prefer-spread`, `no-new-require`, `no-undef-init`, `no-unexpected-multiline` - - [deps] update `eslint`, `eslint-find-rules`, `eslint-plugin-import`, `babel-tape-runner`; add `babel-preset-airbnb` - - [patch] flesh out defaults: `jsx-quotes` - - [docs] update the peer dep install command to dynamically look up the right version numbers when installing peer deps - - [tests] fix prepublish scripts - -4.0.2 / 2016-07-14 -================== - - [fix] repair accidental comma-dangle change - -4.0.1 / 2016-07-14 (unpublished) -================== - - [fix] Prevent trailing commas in the legacy config (#950) - - [deps] update `eslint-plugin-import` - -4.0.0 / 2016-07-02 -================== - - [breaking] [deps] update `eslint` to v3; drop support for < node 4 - - [breaking] enable `rest-spread-spacing` rule - - [breaking] enable `no-mixed-operators` rule - - [breaking] enable `import` rules: `no-named-as-default`, `no-named-as-default-member`, `no-extraneous-dependencies` - - [breaking] enable `object-property-newline` rule - - [breaking] enable `no-prototype-builtins` rule - - [breaking] enable `no-useless-rename` rule - - [breaking] enable `unicode-bom` rule - - [breaking] Enforce proper generator star spacing (#887) - - [breaking] Enable imports/imports-first rule (#882) - - [breaking] re-order rules; put import rules in separate file (#881) - - [patch] `newline-per-chained-call`: bump the limit to 4 - - [patch] `object-shorthand`: do not warn when the concise form would have a string literal as a name - - [patch] Loosen `prefer-const` to not warn when the variable is “read” before being assigned to - - [refactor] fix quoting of rule properties (#885) - - [refactor] `quotes`: Use object option form rather than deprecated string form. - - [deps] update `eslint`, `eslint-plugin-import`, `eslint-find-rules`, `tape` - - [tests] Only run `eslint-find-rules` on prepublish, not in tests - -3.0.1 / 2016-05-08 -================== - - [patch] re-disable `no-extra-parens` (#869, #867) - -3.0.0 / 2016-05-07 -================== - - [breaking] enable `import/no-mutable-exports` - - [breaking] enable `no-class-assign` rule, to pair with `no-func-assign` - - [breaking] widen `no-extra-parens` to include everything, except `nestedBinaryExpressions` - - [breaking] Re-enabling `newline-per-chained-call` (#748) - - [minor] enable `import/no-amd` - - [patch] enable `import/no-duplicates` - - [deps] update `eslint`, `eslint-plugin-import`, `eslint-find-rules` - -2.0.0 / 2016-04-29 -================== - - [breaking] enable `no-unsafe-finally` rule - - [semver-minor] enable `no-useless-computed-key` rule - - [deps] update `eslint`, `eslint-plugin-import` - -1.0.4 / 2016-04-26 -================== - - [deps] update `eslint-find-rules`, `eslint-plugin-import` - -1.0.3 / 2016-04-21 -================== - - [patch: loosen rules] Allow empty class/object methods - -1.0.2 / 2016-04-20 -================== - - [patch: loosen rules] Allow `break` (#840) - -1.0.1 / 2016-04-19 -================== - - [patch: loosen rules] Allow `== null` (#542) - -1.0.0 / 2016-04-19 -================== - - Initial commmit; moved content over from `eslint-config-airbnb` package. diff --git a/packages/eslint-config-airbnb-base/README.md b/packages/eslint-config-airbnb-base/README.md deleted file mode 100644 index e0d8bc091a..0000000000 --- a/packages/eslint-config-airbnb-base/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# eslint-config-airbnb-base - -[![npm version](https://badge.fury.io/js/eslint-config-airbnb-base.svg)](http://badge.fury.io/js/eslint-config-airbnb-base) - -This package provides Airbnb's base JS .eslintrc as an extensible shared config. - -## Usage - -We export two ESLint configurations for your usage. - -### eslint-config-airbnb-base - -Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires `eslint` and `eslint-plugin-import`. - -1. `PKG=eslint-config-airbnb-base npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"` (which produces and runs a command like `npm install --save-dev eslint-config-airbnb-base eslint@^3.0.1 eslint-plugin-import@^1.10.3` but with whatever the proper version numbers are) -2. add `"extends": "airbnb-base"` to your .eslintrc - -### eslint-config-airbnb-base/legacy - -Lints ES5 and below. Requires `eslint` and `eslint-plugin-import`. - -1. `PKG=eslint-config-airbnb-base npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"` (which produces and runs a command like `npm install --save-dev eslint-config-airbnb-base eslint@^3.0.1 eslint-plugin-import@^1.10.3` but with whatever the proper version numbers are) -2. add `"extends": "airbnb-base/legacy"` to your .eslintrc - -See [Airbnb's overarching ESLint config](https://npmjs.com/eslint-config-airbnb), [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript), and the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information. - -## Improving this config - -Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc? - -You can run tests with `npm test`. - -You can make sure this module lints with itself using `npm run lint`. diff --git a/packages/eslint-config-airbnb-base/index.js b/packages/eslint-config-airbnb-base/index.js deleted file mode 100644 index 547e8b2ac5..0000000000 --- a/packages/eslint-config-airbnb-base/index.js +++ /dev/null @@ -1,18 +0,0 @@ -module.exports = { - extends: [ - './rules/best-practices', - './rules/errors', - './rules/node', - './rules/style', - './rules/variables', - './rules/es6', - './rules/imports', - ].map(require.resolve), - parserOptions: { - ecmaVersion: 7, - sourceType: 'module', - }, - rules: { - strict: 2, - } -}; diff --git a/packages/eslint-config-airbnb-base/legacy.js b/packages/eslint-config-airbnb-base/legacy.js deleted file mode 100644 index f3dacc4c7b..0000000000 --- a/packages/eslint-config-airbnb-base/legacy.js +++ /dev/null @@ -1,21 +0,0 @@ -module.exports = { - extends: [ - './rules/best-practices', - './rules/errors', - './rules/node', - './rules/style', - './rules/variables' - ].map(require.resolve), - env: { - browser: true, - node: true, - amd: false, - mocha: false, - jasmine: false - }, - ecmaFeatures: {}, - globals: {}, - rules: { - 'comma-dangle': [2, 'never'] - } -}; diff --git a/packages/eslint-config-airbnb-base/package.json b/packages/eslint-config-airbnb-base/package.json deleted file mode 100644 index 175fc87fc3..0000000000 --- a/packages/eslint-config-airbnb-base/package.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "name": "eslint-config-airbnb-base", - "version": "5.0.0", - "description": "Airbnb's base JS ESLint config, following our styleguide", - "main": "index.js", - "scripts": { - "lint": "eslint .", - "tests-only": "babel-tape-runner ./test/test-*.js", - "prepublish": "not-in-publish || (eslint-find-rules --unused && npm test)", - "pretest": "npm run --silent lint", - "test": "npm run --silent tests-only", - "travis": "npm run --silent test" - }, - "repository": { - "type": "git", - "url": "https://github.com/airbnb/javascript" - }, - "keywords": [ - "eslint", - "eslintconfig", - "config", - "airbnb", - "javascript", - "styleguide" - ], - "author": "Jake Teton-Landis (https://twitter.com/@jitl)", - "contributors": [ - { - "name": "Jake Teton-Landis", - "url": "https://twitter.com/jitl" - }, - { - "name": "Jordan Harband", - "email": "ljharb@gmail.com", - "url": "http://ljharb.codes" - }, - { - "name": "Harrison Shoff", - "url": "https://twitter.com/hshoff" - } - ], - "license": "MIT", - "bugs": { - "url": "https://github.com/airbnb/javascript/issues" - }, - "homepage": "https://github.com/airbnb/javascript", - "devDependencies": { - "babel-preset-airbnb": "^2.0.0", - "babel-tape-runner": "^2.0.1", - "eslint": "^3.1.1", - "eslint-find-rules": "^1.11.1", - "eslint-plugin-import": "^1.11.1", - "in-publish": "^2.0.0", - "tape": "^4.6.0" - }, - "peerDependencies": { - "eslint": "^3.1.1", - "eslint-plugin-import": "^1.11.1" - }, - "engines": { - "node": ">= 4" - } -} diff --git a/packages/eslint-config-airbnb-base/rules/best-practices.js b/packages/eslint-config-airbnb-base/rules/best-practices.js deleted file mode 100644 index 838ae71368..0000000000 --- a/packages/eslint-config-airbnb-base/rules/best-practices.js +++ /dev/null @@ -1,235 +0,0 @@ -module.exports = { - rules: { - // enforces getter/setter pairs in objects - 'accessor-pairs': 0, - - // enforces return statements in callbacks of array's methods - // http://eslint.org/docs/rules/array-callback-return - 'array-callback-return': 2, - - // treat var statements as if they were block scoped - 'block-scoped-var': 2, - - // specify the maximum cyclomatic complexity allowed in a program - complexity: [0, 11], - - // require return statements to either always or never specify values - 'consistent-return': 2, - - // specify curly brace conventions for all control statements - curly: [2, 'multi-line'], - - // require default case in switch statements - 'default-case': [2, { commentPattern: '^no default$' }], - - // encourages use of dot notation whenever possible - 'dot-notation': [2, { allowKeywords: true }], - - // enforces consistent newlines before or after dots - // http://eslint.org/docs/rules/dot-location - 'dot-location': [2, 'property'], - - // require the use of === and !== - // http://eslint.org/docs/rules/eqeqeq - eqeqeq: [2, 'allow-null'], - - // make sure for-in loops have an if statement - 'guard-for-in': 2, - - // disallow the use of alert, confirm, and prompt - 'no-alert': 1, - - // disallow use of arguments.caller or arguments.callee - 'no-caller': 2, - - // disallow lexical declarations in case/default clauses - // http://eslint.org/docs/rules/no-case-declarations.html - 'no-case-declarations': 2, - - // disallow division operators explicitly at beginning of regular expression - // http://eslint.org/docs/rules/no-div-regex - 'no-div-regex': 0, - - // disallow else after a return in an if - 'no-else-return': 2, - - // disallow empty functions, except for standalone funcs/arrows - // http://eslint.org/docs/rules/no-empty-function - 'no-empty-function': [2, { - allow: [ - 'arrowFunctions', - 'functions', - 'methods', - ] - }], - - // disallow empty destructuring patterns - // http://eslint.org/docs/rules/no-empty-pattern - 'no-empty-pattern': 2, - - // disallow comparisons to null without a type-checking operator - 'no-eq-null': 0, - - // disallow use of eval() - 'no-eval': 2, - - // disallow adding to native types - 'no-extend-native': 2, - - // disallow unnecessary function binding - 'no-extra-bind': 2, - - // disallow Unnecessary Labels - // http://eslint.org/docs/rules/no-extra-label - 'no-extra-label': 2, - - // disallow fallthrough of case statements - 'no-fallthrough': 2, - - // disallow the use of leading or trailing decimal points in numeric literals - 'no-floating-decimal': 2, - - // disallow implicit type conversions - // http://eslint.org/docs/rules/no-implicit-coercion - 'no-implicit-coercion': [0, { - boolean: false, - number: true, - string: true, - allow: [], - }], - - // disallow var and named functions in global scope - // http://eslint.org/docs/rules/no-implicit-globals - 'no-implicit-globals': 0, - - // disallow use of eval()-like methods - 'no-implied-eval': 2, - - // disallow this keywords outside of classes or class-like objects - 'no-invalid-this': 0, - - // disallow usage of __iterator__ property - 'no-iterator': 2, - - // disallow use of labels for anything other then loops and switches - 'no-labels': [2, { allowLoop: false, allowSwitch: false }], - - // disallow unnecessary nested blocks - 'no-lone-blocks': 2, - - // disallow creation of functions within loops - 'no-loop-func': 2, - - // disallow magic numbers - // http://eslint.org/docs/rules/no-magic-numbers - 'no-magic-numbers': [0, { - ignore: [], - ignoreArrayIndexes: true, - enforceConst: true, - detectObjects: false, - }], - - // disallow use of multiple spaces - 'no-multi-spaces': 2, - - // disallow use of multiline strings - 'no-multi-str': 2, - - // disallow reassignments of native objects - 'no-native-reassign': 2, - - // disallow use of new operator when not part of the assignment or comparison - 'no-new': 2, - - // disallow use of new operator for Function object - 'no-new-func': 2, - - // disallows creating new instances of String, Number, and Boolean - 'no-new-wrappers': 2, - - // disallow use of (old style) octal literals - 'no-octal': 2, - - // disallow use of octal escape sequences in string literals, such as - // var foo = 'Copyright \251'; - 'no-octal-escape': 2, - - // disallow reassignment of function parameters - // disallow parameter object manipulation - // rule: http://eslint.org/docs/rules/no-param-reassign.html - 'no-param-reassign': [2, { props: true }], - - // disallow usage of __proto__ property - 'no-proto': 2, - - // disallow declaring the same variable more then once - 'no-redeclare': 2, - - // disallow use of assignment in return statement - 'no-return-assign': 2, - - // disallow use of `javascript:` urls. - 'no-script-url': 2, - - // disallow self assignment - // http://eslint.org/docs/rules/no-self-assign - 'no-self-assign': 2, - - // disallow comparisons where both sides are exactly the same - 'no-self-compare': 2, - - // disallow use of comma operator - 'no-sequences': 2, - - // restrict what can be thrown as an exception - 'no-throw-literal': 2, - - // disallow unmodified conditions of loops - // http://eslint.org/docs/rules/no-unmodified-loop-condition - 'no-unmodified-loop-condition': 0, - - // disallow usage of expressions in statement position - 'no-unused-expressions': [2, { - allowShortCircuit: false, - allowTernary: false, - }], - - // disallow unused labels - // http://eslint.org/docs/rules/no-unused-labels - 'no-unused-labels': 2, - - // disallow unnecessary .call() and .apply() - 'no-useless-call': 0, - - // disallow useless string concatenation - // http://eslint.org/docs/rules/no-useless-concat - 'no-useless-concat': 2, - - // disallow unnecessary string escaping - // http://eslint.org/docs/rules/no-useless-escape - 'no-useless-escape': 2, - - // disallow use of void operator - // http://eslint.org/docs/rules/no-void - 'no-void': 2, - - // disallow usage of configurable warning terms in comments: e.g. todo - 'no-warning-comments': [0, { terms: ['todo', 'fixme', 'xxx'], location: 'start' }], - - // disallow use of the with statement - 'no-with': 2, - - // require use of the second argument for parseInt() - radix: 2, - - // requires to declare all vars on top of their containing scope - 'vars-on-top': 2, - - // require immediate function invocation to be wrapped in parentheses - // http://eslint.org/docs/rules/wrap-iife.html - 'wrap-iife': [2, 'outside'], - - // require or disallow Yoda conditions - yoda: 2 - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/errors.js b/packages/eslint-config-airbnb-base/rules/errors.js deleted file mode 100644 index 7221cd1647..0000000000 --- a/packages/eslint-config-airbnb-base/rules/errors.js +++ /dev/null @@ -1,103 +0,0 @@ -module.exports = { - rules: { - // require trailing commas in multiline object literals - 'comma-dangle': [2, 'always-multiline'], - - // disallow assignment in conditional expressions - 'no-cond-assign': [2, 'always'], - - // disallow use of console - 'no-console': 1, - - // disallow use of constant expressions in conditions - 'no-constant-condition': 1, - - // disallow control characters in regular expressions - 'no-control-regex': 2, - - // disallow use of debugger - 'no-debugger': 2, - - // disallow duplicate arguments in functions - 'no-dupe-args': 2, - - // disallow duplicate keys when creating object literals - 'no-dupe-keys': 2, - - // disallow a duplicate case label. - 'no-duplicate-case': 2, - - // disallow empty statements - 'no-empty': 2, - - // disallow the use of empty character classes in regular expressions - 'no-empty-character-class': 2, - - // disallow assigning to the exception in a catch block - 'no-ex-assign': 2, - - // disallow double-negation boolean casts in a boolean context - // http://eslint.org/docs/rules/no-extra-boolean-cast - 'no-extra-boolean-cast': 2, - - // disallow unnecessary parentheses - // http://eslint.org/docs/rules/no-extra-parens - 'no-extra-parens': [0, 'all', { - conditionalAssign: true, - nestedBinaryExpressions: false, - returnAssign: false, - }], - - // disallow unnecessary semicolons - 'no-extra-semi': 2, - - // disallow overwriting functions written as function declarations - 'no-func-assign': 2, - - // disallow function or variable declarations in nested blocks - 'no-inner-declarations': 2, - - // disallow invalid regular expression strings in the RegExp constructor - 'no-invalid-regexp': 2, - - // disallow irregular whitespace outside of strings and comments - 'no-irregular-whitespace': 2, - - // disallow negation of the left operand of an in expression - 'no-negated-in-lhs': 2, - - // disallow the use of object properties of the global object (Math and JSON) as functions - 'no-obj-calls': 2, - - // disallow use of Object.prototypes builtins directly - // http://eslint.org/docs/rules/no-prototype-builtins - 'no-prototype-builtins': 2, - - // disallow multiple spaces in a regular expression literal - 'no-regex-spaces': 2, - - // disallow sparse arrays - 'no-sparse-arrays': 2, - - // Avoid code that looks like two expressions but is actually one - // http://eslint.org/docs/rules/no-unexpected-multiline - 'no-unexpected-multiline': 2, - - // disallow unreachable statements after a return, throw, continue, or break statement - 'no-unreachable': 2, - - // disallow return/throw/break/continue inside finally blocks - // http://eslint.org/docs/rules/no-unsafe-finally - 'no-unsafe-finally': 2, - - // disallow comparisons with the value NaN - 'use-isnan': 2, - - // ensure JSDoc comments are valid - // http://eslint.org/docs/rules/valid-jsdoc - 'valid-jsdoc': 0, - - // ensure that the results of typeof are compared against a valid string - 'valid-typeof': 2 - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/es6.js b/packages/eslint-config-airbnb-base/rules/es6.js deleted file mode 100644 index a7754b6461..0000000000 --- a/packages/eslint-config-airbnb-base/rules/es6.js +++ /dev/null @@ -1,145 +0,0 @@ -module.exports = { - env: { - es6: true - }, - parserOptions: { - ecmaVersion: 6, - sourceType: 'module', - ecmaFeatures: { - generators: false, - objectLiteralDuplicateProperties: false - } - }, - - rules: { - // enforces no braces where they can be omitted - // http://eslint.org/docs/rules/arrow-body-style - 'arrow-body-style': [2, 'as-needed'], - - // require parens in arrow function arguments - 'arrow-parens': 0, - - // require space before/after arrow function's arrow - // http://eslint.org/docs/rules/arrow-spacing - 'arrow-spacing': [2, { before: true, after: true }], - - // verify super() callings in constructors - 'constructor-super': 2, - - // enforce the spacing around the * in generator functions - // http://eslint.org/docs/rules/generator-star-spacing - 'generator-star-spacing': [2, { before: false, after: true }], - - // disallow modifying variables of class declarations - // http://eslint.org/docs/rules/no-class-assign - 'no-class-assign': 2, - - // disallow arrow functions where they could be confused with comparisons - // http://eslint.org/docs/rules/no-confusing-arrow - 'no-confusing-arrow': [2, { - allowParens: true, - }], - - // disallow modifying variables that are declared using const - 'no-const-assign': 2, - - // disallow duplicate class members - // http://eslint.org/docs/rules/no-dupe-class-members - 'no-dupe-class-members': 2, - - // disallow importing from the same path more than once - // http://eslint.org/docs/rules/no-duplicate-imports - 'no-duplicate-imports': 2, - - // disallow symbol constructor - // http://eslint.org/docs/rules/no-new-symbol - 'no-new-symbol': 2, - - // disallow specific imports - // http://eslint.org/docs/rules/no-restricted-imports - 'no-restricted-imports': 0, - - // disallow to use this/super before super() calling in constructors. - // http://eslint.org/docs/rules/no-this-before-super - 'no-this-before-super': 2, - - // disallow useless computed property keys - // http://eslint.org/docs/rules/no-useless-computed-key - 'no-useless-computed-key': 2, - - // disallow unnecessary constructor - // http://eslint.org/docs/rules/no-useless-constructor - 'no-useless-constructor': 2, - - // disallow renaming import, export, and destructured assignments to the same name - // http://eslint.org/docs/rules/no-useless-rename - 'no-useless-rename': [2, { - ignoreDestructuring: false, - ignoreImport: false, - ignoreExport: false, - }], - - // require let or const instead of var - 'no-var': 2, - - // require method and property shorthand syntax for object literals - // http://eslint.org/docs/rules/object-shorthand - 'object-shorthand': [2, 'always', { - ignoreConstructors: false, - avoidQuotes: true, - }], - - // suggest using arrow functions as callbacks - 'prefer-arrow-callback': [2, { - allowNamedFunctions: false, - allowUnboundThis: true, - }], - - // suggest using of const declaration for variables that are never modified after declared - 'prefer-const': [2, { - destructuring: 'any', - ignoreReadBeforeAssign: true, - }], - - // suggest using Reflect methods where applicable - // http://eslint.org/docs/rules/prefer-reflect - // TODO: enable - 'prefer-reflect': 0, - - // use rest parameters instead of arguments - // http://eslint.org/docs/rules/prefer-rest-params - 'prefer-rest-params': 2, - - // suggest using the spread operator instead of .apply() - // http://eslint.org/docs/rules/prefer-spread - 'prefer-spread': 2, - - // suggest using template literals instead of string concatenation - // http://eslint.org/docs/rules/prefer-template - 'prefer-template': 2, - - // disallow generator functions that do not have yield - // http://eslint.org/docs/rules/require-yield - 'require-yield': 2, - - // enforce spacing between object rest-spread - // http://eslint.org/docs/rules/rest-spread-spacing - 'rest-spread-spacing': [2, 'never'], - - // import sorting - // http://eslint.org/docs/rules/sort-imports - 'sort-imports': [0, { - ignoreCase: false, - ignoreMemberSort: false, - memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'], - }], - - // enforce usage of spacing in template strings - // http://eslint.org/docs/rules/template-curly-spacing - 'template-curly-spacing': 2, - - // enforce spacing around the * in yield* expressions - // http://eslint.org/docs/rules/yield-star-spacing - 'yield-star-spacing': [2, 'after'] - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/imports.js b/packages/eslint-config-airbnb-base/rules/imports.js deleted file mode 100644 index eb0610760f..0000000000 --- a/packages/eslint-config-airbnb-base/rules/imports.js +++ /dev/null @@ -1,132 +0,0 @@ -module.exports = { - env: { - es6: true - }, - parserOptions: { - ecmaVersion: 6, - sourceType: 'module' - }, - plugins: [ - 'import' - ], - - settings: { - 'import/resolver': { - node: { - extensions: ['.js', '.json'] - } - }, - 'import/extensions': [ - 'node_modules', - ], - 'import/core-modules': [ - ], - 'import/ignore': [ - 'node_modules', - '\\.(coffee|scss|css|less|hbs|svg|json)$', - ], - }, - - rules: { - // Static analysis: - - // ensure imports point to files/modules that can be resolved - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md - 'import/no-unresolved': [2, { commonjs: true }], - - // ensure named imports coupled with named exports - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it - 'import/named': 0, - - // ensure default import coupled with default export - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it - 'import/default': 0, - - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/namespace.md - 'import/namespace': 0, - - // Helpful warnings: - - // disallow invalid exports, e.g. multiple defaults - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/export.md - 'import/export': 2, - - // do not allow a default import name to match a named export - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md - 'import/no-named-as-default': 2, - - // warn on accessing default export property names that are also named exports - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md - 'import/no-named-as-default-member': 2, - - // disallow use of jsdoc-marked-deprecated imports - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md - 'import/no-deprecated': 0, - - // Forbid the use of extraneous packages - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md - 'import/no-extraneous-dependencies': [2, { - devDependencies: false, - optionalDependencies: false, - }], - - // Forbid mutable exports - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md - 'import/no-mutable-exports': 2, - - // Module systems: - - // disallow require() - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md - 'import/no-commonjs': 0, - - // disallow AMD require/define - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-amd.md - 'import/no-amd': 2, - - // No Node.js builtin modules - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md - // TODO: enable? - 'import/no-nodejs-modules': 0, - - // Style guide: - - // disallow non-import statements appearing before import statements - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/imports-first.md - 'import/imports-first': [2, 'absolute-first'], - - // disallow duplicate imports - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md - 'import/no-duplicates': 2, - - // disallow namespace imports - // TODO: enable? - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-namespace.md - 'import/no-namespace': 0, - - // Ensure consistent use of file extension within the import path - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md - // TODO: enable when https://github.com/benmosher/eslint-plugin-import/issues/390 is resolved - 'import/extensions': [0, 'never'], - - // Enforce a convention in module import order - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md - // TODO: enable? - 'import/order': [0, { - groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'], - 'newlines-between': 'never', - }], - - // Require a newline after the last import/require in a group - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md - 'import/newline-after-import': 2, - - // Require modules with a single export to use a default export - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md - 'import/prefer-default-export': 2, - - // Restrict which files can be imported in a given folder - // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md - 'import/no-restricted-paths': 0, - }, -}; diff --git a/packages/eslint-config-airbnb-base/rules/node.js b/packages/eslint-config-airbnb-base/rules/node.js deleted file mode 100644 index cbd8fc22e6..0000000000 --- a/packages/eslint-config-airbnb-base/rules/node.js +++ /dev/null @@ -1,39 +0,0 @@ -module.exports = { - env: { - node: true - }, - - rules: { - // enforce return after a callback - 'callback-return': 0, - - // require all requires be top-level - // http://eslint.org/docs/rules/global-require - 'global-require': 2, - - // enforces error handling in callbacks (node environment) - 'handle-callback-err': 0, - - // disallow mixing regular variable and require declarations - 'no-mixed-requires': [0, false], - - // disallow use of new operator with the require function - 'no-new-require': 2, - - // disallow string concatenation with __dirname and __filename - // http://eslint.org/docs/rules/no-path-concat - 'no-path-concat': 2, - - // disallow use of process.env - 'no-process-env': 0, - - // disallow process.exit() - 'no-process-exit': 0, - - // restrict usage of specified node modules - 'no-restricted-modules': 0, - - // disallow use of synchronous methods (off by default) - 'no-sync': 0, - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/strict.js b/packages/eslint-config-airbnb-base/rules/strict.js deleted file mode 100644 index 43d7010c60..0000000000 --- a/packages/eslint-config-airbnb-base/rules/strict.js +++ /dev/null @@ -1,6 +0,0 @@ -module.exports = { - rules: { - // babel inserts `'use strict';` for us - strict: [2, 'never'] - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/style.js b/packages/eslint-config-airbnb-base/rules/style.js deleted file mode 100644 index c8a6f50e9e..0000000000 --- a/packages/eslint-config-airbnb-base/rules/style.js +++ /dev/null @@ -1,301 +0,0 @@ -module.exports = { - rules: { - // enforce spacing inside array brackets - 'array-bracket-spacing': [2, 'never'], - - // enforce spacing inside single-line blocks - // http://eslint.org/docs/rules/block-spacing - 'block-spacing': [2, 'always'], - - // enforce one true brace style - 'brace-style': [2, '1tbs', { allowSingleLine: true }], - - // require camel case names - camelcase: [2, { properties: 'never' }], - - // enforce spacing before and after comma - 'comma-spacing': [2, { before: false, after: true }], - - // enforce one true comma style - 'comma-style': [2, 'last'], - - // disallow padding inside computed properties - 'computed-property-spacing': [2, 'never'], - - // enforces consistent naming when capturing the current execution context - 'consistent-this': 0, - - // enforce newline at the end of file, with no multiple empty lines - 'eol-last': 2, - - // require function expressions to have a name - 'func-names': 1, - - // enforces use of function declarations or expressions - 'func-style': 0, - - // Blacklist certain identifiers to prevent them being used - // http://eslint.org/docs/rules/id-blacklist - 'id-blacklist': 0, - - // this option enforces minimum and maximum identifier lengths - // (variable names, property names etc.) - 'id-length': 0, - - // require identifiers to match the provided regular expression - 'id-match': 0, - - // this option sets a specific tab width for your code - // http://eslint.org/docs/rules/indent - indent: [2, 2, { SwitchCase: 1, VariableDeclarator: 1, outerIIFEBody: 1 }], - - // specify whether double or single quotes should be used in JSX attributes - // http://eslint.org/docs/rules/jsx-quotes - 'jsx-quotes': [0, 'prefer-double'], - - // enforces spacing between keys and values in object literal properties - 'key-spacing': [2, { beforeColon: false, afterColon: true }], - - // require a space before & after certain keywords - 'keyword-spacing': [2, { - before: true, - after: true, - overrides: { - return: { after: true }, - throw: { after: true }, - case: { after: true } - } - }], - - // disallow mixed 'LF' and 'CRLF' as linebreaks - // http://eslint.org/docs/rules/linebreak-style - 'linebreak-style': [2, 'unix'], - - // enforces empty lines around comments - 'lines-around-comment': 0, - - // specify the maximum depth that blocks can be nested - 'max-depth': [0, 4], - - // specify the maximum length of a line in your program - // http://eslint.org/docs/rules/max-len - 'max-len': [2, 100, 2, { - ignoreUrls: true, - ignoreComments: false - }], - - // specify the max number of lines in a file - // http://eslint.org/docs/rules/max-lines - 'max-lines': [0, { - max: 300, - skipBlankLines: true, - skipComments: true - }], - - // specify the maximum depth callbacks can be nested - 'max-nested-callbacks': 0, - - // limits the number of parameters that can be used in the function declaration. - 'max-params': [0, 3], - - // specify the maximum number of statement allowed in a function - 'max-statements': [0, 10], - - // restrict the number of statements per line - // http://eslint.org/docs/rules/max-statements-per-line - 'max-statements-per-line': [0, { max: 1 }], - - // require multiline ternary - // http://eslint.org/docs/rules/multiline-ternary - 'multiline-ternary': 0, - - // require a capital letter for constructors - 'new-cap': [2, { newIsCap: true }], - - // disallow the omission of parentheses when invoking a constructor with no arguments - // http://eslint.org/docs/rules/new-parens - 'new-parens': 2, - - // allow/disallow an empty newline after var statement - 'newline-after-var': 0, - - // http://eslint.org/docs/rules/newline-before-return - 'newline-before-return': 0, - - // enforces new line after each method call in the chain to make it - // more readable and easy to maintain - // http://eslint.org/docs/rules/newline-per-chained-call - 'newline-per-chained-call': [2, { ignoreChainWithDepth: 4 }], - - // disallow use of the Array constructor - 'no-array-constructor': 2, - - // disallow use of bitwise operators - // http://eslint.org/docs/rules/no-bitwise - // TODO: enable - 'no-bitwise': 0, - - // disallow use of the continue statement - // http://eslint.org/docs/rules/no-continue - 'no-continue': 2, - - // disallow comments inline after code - 'no-inline-comments': 0, - - // disallow if as the only statement in an else block - // http://eslint.org/docs/rules/no-lonely-if - 'no-lonely-if': 2, - - // disallow un-paren'd mixes of different operators - // http://eslint.org/docs/rules/no-mixed-operators - 'no-mixed-operators': [2, { - groups: [ - ['+', '-', '*', '/', '%', '**'], - ['&', '|', '^', '~', '<<', '>>', '>>>'], - ['==', '!=', '===', '!==', '>', '>=', '<', '<='], - ['&&', '||'], - ['in', 'instanceof'] - ], - allowSamePrecedence: false - }], - - // disallow mixed spaces and tabs for indentation - 'no-mixed-spaces-and-tabs': 2, - - // disallow multiple empty lines and only one newline at the end - 'no-multiple-empty-lines': [2, { max: 2, maxEOF: 1 }], - - // disallow negated conditions - // http://eslint.org/docs/rules/no-negated-condition - 'no-negated-condition': 0, - - // disallow nested ternary expressions - 'no-nested-ternary': 2, - - // disallow use of the Object constructor - 'no-new-object': 2, - - // disallow use of unary operators, ++ and -- - 'no-plusplus': 0, - - // disallow certain syntax forms - // http://eslint.org/docs/rules/no-restricted-syntax - 'no-restricted-syntax': [ - 2, - 'DebuggerStatement', - 'ForInStatement', - 'LabeledStatement', - 'WithStatement', - ], - - // disallow space between function identifier and application - 'no-spaced-func': 2, - - // disallow the use of ternary operators - 'no-ternary': 0, - - // disallow trailing whitespace at the end of lines - 'no-trailing-spaces': 2, - - // disallow dangling underscores in identifiers - 'no-underscore-dangle': [2, { allowAfterThis: false }], - - // disallow the use of Boolean literals in conditional expressions - // also, prefer `a || b` over `a ? a : b` - // http://eslint.org/docs/rules/no-unneeded-ternary - 'no-unneeded-ternary': [2, { defaultAssignment: false }], - - // disallow whitespace before properties - // http://eslint.org/docs/rules/no-whitespace-before-property - 'no-whitespace-before-property': 2, - - // require padding inside curly braces - 'object-curly-spacing': [2, 'always'], - - // enforce line breaks between braces - // http://eslint.org/docs/rules/object-curly-newline - // TODO: enable once https://github.com/eslint/eslint/issues/6488 is resolved - 'object-curly-newline': [0, { - ObjectExpression: { minProperties: 0, multiline: true }, - ObjectPattern: { minProperties: 0, multiline: true } - }], - - // enforce "same line" or "multiple line" on object properties. - // http://eslint.org/docs/rules/object-property-newline - 'object-property-newline': [2, { - allowMultiplePropertiesPerLine: true, - }], - - // allow just one var statement per function - 'one-var': [2, 'never'], - - // require a newline around variable declaration - // http://eslint.org/docs/rules/one-var-declaration-per-line - 'one-var-declaration-per-line': [2, 'always'], - - // require assignment operator shorthand where possible or prohibit it entirely - // http://eslint.org/docs/rules/operator-assignment - 'operator-assignment': [2, 'always'], - - // enforce operators to be placed before or after line breaks - 'operator-linebreak': 0, - - // enforce padding within blocks - 'padded-blocks': [2, 'never'], - - // require quotes around object literal property names - // http://eslint.org/docs/rules/quote-props.html - 'quote-props': [2, 'as-needed', { keywords: false, unnecessary: true, numbers: false }], - - // specify whether double or single quotes should be used - quotes: [2, 'single', { avoidEscape: true }], - - // do not require jsdoc - // http://eslint.org/docs/rules/require-jsdoc - 'require-jsdoc': 0, - - // require or disallow use of semicolons instead of ASI - semi: [2, 'always'], - - // enforce spacing before and after semicolons - 'semi-spacing': [2, { before: false, after: true }], - - // sort variables within the same declaration block - 'sort-vars': 0, - - // require or disallow space before blocks - 'space-before-blocks': 2, - - // require or disallow space before function opening parenthesis - // http://eslint.org/docs/rules/space-before-function-paren - 'space-before-function-paren': [2, { anonymous: 'always', named: 'never' }], - - // require or disallow spaces inside parentheses - 'space-in-parens': [2, 'never'], - - // require spaces around operators - 'space-infix-ops': 2, - - // Require or disallow spaces before/after unary operators - // http://eslint.org/docs/rules/space-unary-ops - 'space-unary-ops': [2, { - words: true, - nonwords: false, - overrides: { - }, - }], - - // require or disallow a space immediately following the // or /* in a comment - 'spaced-comment': [2, 'always', { - exceptions: ['-', '+'], - markers: ['=', '!'] // space here to support sprockets directives - }], - - // require or disallow the Unicode Byte Order Mark - // http://eslint.org/docs/rules/unicode-bom - 'unicode-bom': [2, 'never'], - - // require regex literals to be wrapped in parentheses - 'wrap-regex': 0 - } -}; diff --git a/packages/eslint-config-airbnb-base/rules/variables.js b/packages/eslint-config-airbnb-base/rules/variables.js deleted file mode 100644 index 3abce6f8ec..0000000000 --- a/packages/eslint-config-airbnb-base/rules/variables.js +++ /dev/null @@ -1,41 +0,0 @@ -module.exports = { - rules: { - // enforce or disallow variable initializations at definition - 'init-declarations': 0, - - // disallow the catch clause parameter name being the same as a variable in the outer scope - 'no-catch-shadow': 0, - - // disallow deletion of variables - 'no-delete-var': 2, - - // disallow labels that share a name with a variable - // http://eslint.org/docs/rules/no-label-var - 'no-label-var': 2, - - // disallow specific globals - 'no-restricted-globals': 0, - - // disallow declaration of variables already declared in the outer scope - 'no-shadow': 2, - - // disallow shadowing of names such as arguments - 'no-shadow-restricted-names': 2, - - // disallow use of undeclared variables unless mentioned in a /*global */ block - 'no-undef': 2, - - // disallow use of undefined when initializing variables - 'no-undef-init': 2, - - // disallow use of undefined variable - // TODO: enable? - 'no-undefined': 0, - - // disallow declaration of variables that are not used in the code - 'no-unused-vars': [2, { vars: 'local', args: 'after-used' }], - - // disallow use of variables before they are defined - 'no-use-before-define': 2 - } -}; diff --git a/packages/eslint-config-airbnb-base/test/.eslintrc b/packages/eslint-config-airbnb-base/test/.eslintrc deleted file mode 100644 index 7e22f26a09..0000000000 --- a/packages/eslint-config-airbnb-base/test/.eslintrc +++ /dev/null @@ -1,12 +0,0 @@ -{ - "rules": { - // disabled because I find it tedious to write tests while following this - // rule - "no-shadow": 0, - // tests uses `t` for tape - "id-length": [2, {"min": 2, "properties": "never", "exceptions": ["t"]}], - "import/no-extraneous-dependencies": [2, { - "devDependencies": true - }], - } -} diff --git a/packages/eslint-config-airbnb-base/test/test-base.js b/packages/eslint-config-airbnb-base/test/test-base.js deleted file mode 100644 index 8e7dc8cd2d..0000000000 --- a/packages/eslint-config-airbnb-base/test/test-base.js +++ /dev/null @@ -1,29 +0,0 @@ -import fs from 'fs'; -import path from 'path'; -import test from 'tape'; - -import index from '../'; - -const files = { index }; - -fs.readdirSync(path.join(__dirname, '../rules')).forEach(name => { - files[name] = require(`../rules/${name}`); // eslint-disable-line global-require -}); - -Object.keys(files).forEach(name => { - const config = files[name]; - - test(`${name}: does not reference react`, t => { - t.plan(2); - - // scan plugins for react and fail if it is found - const hasReactPlugin = Object.prototype.hasOwnProperty.call(config, 'plugins') && - config.plugins.indexOf('react') !== -1; - t.notOk(hasReactPlugin, 'there is no react plugin'); - - // scan rules for react/ and fail if any exist - const reactRuleIds = Object.keys(config.rules) - .filter(ruleId => ruleId.indexOf('react/') === 0); - t.deepEquals(reactRuleIds, [], 'there are no react/ rules'); - }); -}); diff --git a/packages/eslint-config-airbnb/.babelrc b/packages/eslint-config-airbnb/.babelrc deleted file mode 100644 index e0aceaae1c..0000000000 --- a/packages/eslint-config-airbnb/.babelrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "presets": ["airbnb"] -} diff --git a/packages/eslint-config-airbnb/.eslintrc b/packages/eslint-config-airbnb/.eslintrc deleted file mode 100644 index 6c8556be3b..0000000000 --- a/packages/eslint-config-airbnb/.eslintrc +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "./index.js", - "rules": { - // disable requiring trailing commas because it might be nice to revert to - // being JSON at some point, and I don't want to make big changes now. - "comma-dangle": 0 - } -} diff --git a/packages/eslint-config-airbnb/CHANGELOG.md b/packages/eslint-config-airbnb/CHANGELOG.md deleted file mode 100644 index f2f71d1d36..0000000000 --- a/packages/eslint-config-airbnb/CHANGELOG.md +++ /dev/null @@ -1,228 +0,0 @@ -9.0.1 / 2016-05-08 -================== -- [patch] update `eslint-config-airbnb-base` to v3.0.1 - -9.0.0 / 2016-05-07 -================== -- [breaking] update `eslint-config-airbnb-base` to v3 -- [deps] update `eslint-find-rules`, `eslint-plugin-import`, `eslint-plugin-jsx-a11y` - -8.0.0 / 2016-04-21 -================== -- [breaking] Migrate non-React rules to a separate linter config (`eslint-config-airbnb-base`) -- [breaking] disallow empty methods -- [breaking] disallow empty restructuring patterns -- [breaking] enable `no-restricted-syntax` rule -- [breaking] enable `global-require` rule -- [breaking] [react] enable `react/jsx-curly-spacing` rule ([#693](https://github.com/airbnb/javascript/issues/693)) -- [semver-minor] [react] Add `react/jsx-first-prop-new-line` rule -- [semver-minor] [react] enable `jsx-equals-spacing` rule -- [semver-minor] [react] enable `jsx-indent` rule -- [semver-minor] enforce spacing inside single-line blocks -- [semver-minor] enforce `no-underscore-dangle` -- [semver-minor] Enable import/no-unresolved and import/export rules ([#825](https://github.com/airbnb/javascript/issues/825)) -- [semver-patch] Enable `no-useless-concat` rule which `prefer-template` already covers -- [semver-patch] Allow `== null` ([#542](https://github.com/airbnb/javascript/issues/542)) -- [dev deps / peer deps] update `eslint`, `eslint-plugin-react`, `eslint-plugin-import` -- [dev deps / peer deps] update `eslint-plugin-jsx-a11y` and rename rules ([#838](https://github.com/airbnb/javascript/issues/838)) -- [refactor] [react] separate a11y rules to their own file -- [refactor] Add missing disabled rules. -- [tests] Add `eslint-find-rules` to prevent missing rules - -7.0.0 / 2016-04-11 -================== -- [react] [breaking] Add accessibility rules to the React style guide + `eslint-plugin-a11y` -- [breaking] enable `react/require-render-return` -- [breaking] Add `no-dupe-class-members` rule + section ([#785](https://github.com/airbnb/javascript/issues/785)) -- [breaking] error on debugger statements -- [breaking] add `no-useless-escape` rule -- [breaking] add `no-duplicate-imports` rule -- [semver-minor] enable `jsx-pascal-case` rule -- [deps] update `eslint`, `react` -- [dev deps] update `eslint`, `eslint-plugin-react` - -6.2.0 / 2016-03-22 -================== -- [new] Allow arrow functions in JSX props -- [fix] re-enable `no-confusing-arrow` rule, with `allowParens` option enabled ([#752](https://github.com/airbnb/javascript/issues/752), [#791](https://github.com/airbnb/javascript/issues/791)) -- [dev deps] update `tape`, `eslint`, `eslint-plugin-react` -- [peer deps] update `eslint`, `eslint-plugin-react` - -6.1.0 / 2016-02-22 -================== -- [new] enable [`react/prefer-stateless-function`][react/prefer-stateless-function] -- [dev deps] update `react-plugin-eslint`, `eslint`, `tape` - -6.0.2 / 2016-02-22 -================== -- [fix] disable [`no-confusing-arrow`][no-confusing-arrow] due to an `eslint` bug ([#752](https://github.com/airbnb/javascript/issues/752)) - -6.0.1 / 2016-02-21 -================== -- [fix] disable [`newline-per-chained-call`][newline-per-chained-call] due to an `eslint` bug ([#748](https://github.com/airbnb/javascript/issues/748)) - -6.0.0 / 2016-02-21 -================== -- [breaking] enable [`array-callback-return`][array-callback-return] -- [breaking] enable [`no-confusing-arrow`][no-confusing-arrow] -- [breaking] enable [`no-new-symbol`][no-new-symbol] -- [breaking] enable [`no-restricted-imports`][no-restricted-imports] -- [breaking] enable [`no-useless-constructor`][no-useless-constructor] -- [breaking] enable [`prefer-rest-params`][prefer-rest-params] -- [breaking] enable [`template-curly-spacing`][template-curly-spacing] -- [breaking] enable [`newline-per-chained-call`][newline-per-chained-call] -- [breaking] enable [`one-var-declaration-per-line`][one-var-declaration-per-line] -- [breaking] enable [`no-self-assign`][no-self-assign] -- [breaking] enable [`no-whitespace-before-property`][no-whitespace-before-property] -- [breaking] [react] enable [`react/jsx-space-before-closing`][react/jsx-space-before-closing] -- [breaking] [react] enable `static-methods` at top of [`react/sort-comp`][react/sort-comp] -- [breaking] [react] don't `ignoreTranspilerName` for [`react/display-name`][react/display-name] -- [peer+dev deps] update `eslint`, `eslint-plugin-react` ([#730](https://github.com/airbnb/javascript/issues/730)) - -5.0.1 / 2016-02-13 -================== -- [fix] `eslint` peerDep should not include breaking changes - -5.0.0 / 2016-02-03 -================== -- [breaking] disallow unneeded ternary expressions -- [breaking] Avoid lexical declarations in case/default clauses -- [dev deps] update `babel-tape-runner`, `eslint-plugin-react`, `react`, `tape` - -4.0.0 / 2016-01-22 -================== -- [breaking] require outer IIFE wrapping; flesh out guide section -- [minor] Add missing [`arrow-body-style`][arrow-body-style], [`prefer-template`][prefer-template] rules ([#678](https://github.com/airbnb/javascript/issues/678)) -- [minor] Add [`prefer-arrow-callback`][prefer-arrow-callback] to ES6 rules (to match the guide) ([#677](https://github.com/airbnb/javascript/issues/677)) -- [Tests] run `npm run lint` as part of tests; fix errors -- [Tests] use `parallelshell` to parallelize npm run-scripts - -3.1.0 / 2016-01-07 -================== -- [minor] Allow multiple stateless components in a single file - -3.0.2 / 2016-01-06 -================== -- [fix] Ignore URLs in [`max-len`][max-len] ([#664](https://github.com/airbnb/javascript/issues/664)) - -3.0.1 / 2016-01-06 -================== -- [fix] because we use babel, keywords should not be quoted - -3.0.0 / 2016-01-04 -================== -- [breaking] enable [`quote-props`][quote-props] rule ([#632](https://github.com/airbnb/javascript/issues/632)) -- [breaking] Define a max line length of 100 characters ([#639](https://github.com/airbnb/javascript/issues/639)) -- [breaking] [react] Minor cleanup for the React styleguide, add [`react/jsx-no-bind`][react/jsx-no-bind] ([#619](https://github.com/airbnb/javascript/issues/619)) -- [breaking] update best-practices config to prevent parameter object manipulation ([#627](https://github.com/airbnb/javascript/issues/627)) -- [minor] Enable [`react/no-is-mounted`][react/no-is-mounted] rule (#635, #633) -- [minor] Sort [`react/prefer-es6-class`][react/prefer-es6-class] alphabetically ([#634](https://github.com/airbnb/javascript/issues/634)) -- [minor] enable [`react/prefer-es6-class`][react/prefer-es6-class] rule -- Permit strict mode in "legacy" config -- [react] add missing rules from `eslint-plugin-react` (enforcing where necessary) ([#581](https://github.com/airbnb/javascript/issues/581)) -- [dev deps] update `eslint-plugin-react` - -2.1.1 / 2015-12-15 -================== -- [fix] Remove deprecated [`react/jsx-quotes`][react/jsx-quotes] ([#622](https://github.com/airbnb/javascript/issues/622)) - -2.1.0 / 2015-12-15 -================== -- [fix] use `require.resolve` to allow nested `extend`s ([#582](https://github.com/airbnb/javascript/issues/582)) -- [new] enable [`object-shorthand`][object-shorthand] rule ([#621](https://github.com/airbnb/javascript/issues/621)) -- [new] enable [`arrow-spacing`][arrow-spacing] rule ([#517](https://github.com/airbnb/javascript/issues/517)) -- [docs] flesh out react rule defaults ([#618](https://github.com/airbnb/javascript/issues/618)) - -2.0.0 / 2015-12-03 -================== -- [breaking] [`space-before-function-paren`][space-before-function-paren]: require function spacing: `function (` ([#605](https://github.com/airbnb/javascript/issues/605)) -- [breaking] [`indent`][indent]: Fix switch statement indentation rule ([#606](https://github.com/airbnb/javascript/issues/606)) -- [breaking] [`array-bracket-spacing`][array-bracket-spacing], [`computed-property-spacing`][computed-property-spacing]: disallow spacing inside brackets ([#594](https://github.com/airbnb/javascript/issues/594)) -- [breaking] [`object-curly-spacing`][object-curly-spacing]: require padding inside curly braces ([#594](https://github.com/airbnb/javascript/issues/594)) -- [breaking] [`space-in-parens`][space-in-parens]: disallow spaces in parens ([#594](https://github.com/airbnb/javascript/issues/594)) - -1.0.2 / 2015-11-25 -================== -- [breaking] [`no-multiple-empty-lines`][no-multiple-empty-lines]: only allow 1 blank line at EOF ([#578](https://github.com/airbnb/javascript/issues/578)) -- [new] `restParams`: enable rest params ([#592](https://github.com/airbnb/javascript/issues/592)) - -1.0.1 / 2015-11-25 -================== -- *erroneous publish* - -1.0.0 / 2015-11-08 -================== -- require `eslint` `v1.0.0` or higher -- remove `babel-eslint` dependency - -0.1.1 / 2015-11-05 -================== -- remove [`id-length`][id-length] rule ([#569](https://github.com/airbnb/javascript/issues/569)) -- enable [`no-mixed-spaces-and-tabs`][no-mixed-spaces-and-tabs] ([#539](https://github.com/airbnb/javascript/issues/539)) -- enable [`no-const-assign`][no-const-assign] ([#560](https://github.com/airbnb/javascript/issues/560)) -- enable [`space-before-keywords`][space-before-keywords] ([#554](https://github.com/airbnb/javascript/issues/554)) - -0.1.0 / 2015-11-05 -================== -- switch to modular rules files courtesy the [eslint-config-default][ecd] project and [@taion][taion]. [PR][pr-modular] -- export `eslint-config-airbnb/legacy` for ES5-only users. `eslint-config-airbnb/legacy` does not require the `babel-eslint` parser. [PR][pr-legacy] - -0.0.9 / 2015-09-24 -================== -- add rule [`no-undef`][no-undef] -- add rule [`id-length`][id-length] - -0.0.8 / 2015-08-21 -================== -- now has a changelog -- now is modular (see instructions above for with react and without react versions) - -0.0.7 / 2015-07-30 -================== -- TODO: fill in - - -[ecd]: https://github.com/walmartlabs/eslint-config-defaults -[taion]: https://github.com/taion -[pr-modular]: https://github.com/airbnb/javascript/pull/526 -[pr-legacy]: https://github.com/airbnb/javascript/pull/527 - -[array-bracket-spacing]: http://eslint.org/docs/rules/array-bracket-spacing -[array-callback-return]: http://eslint.org/docs/rules/array-callback-return -[arrow-body-style]: http://eslint.org/docs/rules/arrow-body-style -[arrow-spacing]: http://eslint.org/docs/rules/arrow-spacing -[computed-property-spacing]: http://eslint.org/docs/rules/computed-property-spacing -[id-length]: http://eslint.org/docs/rules/id-length -[indent]: http://eslint.org/docs/rules/indent -[max-len]: http://eslint.org/docs/rules/max-len -[newline-per-chained-call]: http://eslint.org/docs/rules/newline-per-chained-call -[no-confusing-arrow]: http://eslint.org/docs/rules/no-confusing-arrow -[no-const-assign]: http://eslint.org/docs/rules/no-const-assign -[no-mixed-spaces-and-tabs]: http://eslint.org/docs/rules/no-mixed-spaces-and-tabs -[no-multiple-empty-lines]: http://eslint.org/docs/rules/no-multiple-empty-lines -[no-new-symbol]: http://eslint.org/docs/rules/no-new-symbol -[no-restricted-imports]: http://eslint.org/docs/rules/no-restricted-imports -[no-self-assign]: http://eslint.org/docs/rules/no-self-assign -[no-undef]: http://eslint.org/docs/rules/no-undef -[no-useless-constructor]: http://eslint.org/docs/rules/no-useless-constructor -[no-whitespace-before-property]: http://eslint.org/docs/rules/no-whitespace-before-property -[object-curly-spacing]: http://eslint.org/docs/rules/object-curly-spacing -[object-shorthand]: http://eslint.org/docs/rules/object-shorthand -[one-var-declaration-per-line]: http://eslint.org/docs/rules/one-var-declaration-per-line -[prefer-arrow-callback]: http://eslint.org/docs/rules/prefer-arrow-callback -[prefer-rest-params]: http://eslint.org/docs/rules/prefer-rest-params -[prefer-template]: http://eslint.org/docs/rules/prefer-template -[quote-props]: http://eslint.org/docs/rules/quote-props -[space-before-function-paren]: http://eslint.org/docs/rules/space-before-function-paren -[space-before-keywords]: http://eslint.org/docs/rules/space-before-keywords -[space-in-parens]: http://eslint.org/docs/rules/space-in-parens -[template-curly-spacing]: http://eslint.org/docs/rules/template-curly-spacing - -[react/jsx-space-before-closing]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md -[react/sort-comp]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md -[react/display-name]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md -[react/jsx-no-bind]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md -[react/no-is-mounted]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md -[react/prefer-es6-class]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md -[react/jsx-quotes]: https://github.com/yannickcr/eslint-plugin-react/blob/f817e37beddddc84b4788969f07c524fa7f0823b/docs/rules/jsx-quotes.md -[react/prefer-stateless-function]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md diff --git a/packages/eslint-config-airbnb/README.md b/packages/eslint-config-airbnb/README.md deleted file mode 100644 index afcf902135..0000000000 --- a/packages/eslint-config-airbnb/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# eslint-config-airbnb - -[![npm version](https://badge.fury.io/js/eslint-config-airbnb.svg)](http://badge.fury.io/js/eslint-config-airbnb) - -This package provides Airbnb's .eslintrc as an extensible shared config. - -## Usage - -We export three ESLint configurations for your usage. - -### eslint-config-airbnb - -Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires `eslint`, `eslint-plugin-import`, `eslint-plugin-react`, and `eslint-plugin-jsx-a11y`. - -1. `PKG=eslint-config-airbnb npm info "$PKG" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG"` (which produces and runs a command like `npm install --save-dev eslint-config-airbnb eslint@^2.9.0 eslint-plugin-jsx-a11y@^1.2.0 eslint-plugin-import@^1.7.0 eslint-plugin-react@^5.0.1` but with whatever the proper version numbers are) -2. add `"extends": "airbnb"` to your .eslintrc - -### eslint-config-airbnb/base - -This entry point is deprecated. See [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). - -### eslint-config-airbnb/legacy - -This entry point is deprecated. See [eslint-config-airbnb-base](https://npmjs.com/eslint-config-airbnb-base). - -See [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript) and -the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) -for more information. - -## Improving this config - -Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc? - -You can run tests with `npm test`. - -You can make sure this module lints with itself using `npm run lint`. diff --git a/packages/eslint-config-airbnb/base.js b/packages/eslint-config-airbnb/base.js deleted file mode 100644 index bb1ea39118..0000000000 --- a/packages/eslint-config-airbnb/base.js +++ /dev/null @@ -1,4 +0,0 @@ -module.exports = { - extends: ['eslint-config-airbnb-base'].map(require.resolve), - rules: {}, -}; diff --git a/packages/eslint-config-airbnb/index.js b/packages/eslint-config-airbnb/index.js deleted file mode 100644 index ddd3bfb712..0000000000 --- a/packages/eslint-config-airbnb/index.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = { - extends: [ - 'eslint-config-airbnb-base', - 'eslint-config-airbnb-base/rules/strict', - './rules/react', - './rules/react-a11y', - ].map(require.resolve), - rules: {} -}; diff --git a/packages/eslint-config-airbnb/legacy.js b/packages/eslint-config-airbnb/legacy.js deleted file mode 100644 index e88f71224a..0000000000 --- a/packages/eslint-config-airbnb/legacy.js +++ /dev/null @@ -1,4 +0,0 @@ -module.exports = { - extends: ['eslint-config-airbnb-base/legacy'].map(require.resolve), - rules: {}, -}; diff --git a/packages/eslint-config-airbnb/package.json b/packages/eslint-config-airbnb/package.json deleted file mode 100644 index e27cf0071d..0000000000 --- a/packages/eslint-config-airbnb/package.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "name": "eslint-config-airbnb", - "version": "9.0.1", - "description": "Airbnb's ESLint config, following our styleguide", - "main": "index.js", - "scripts": { - "lint": "eslint .", - "tests-only": "babel-tape-runner ./test/test-*.js", - "prepublish": "not-in-publish || (eslint-find-rules --unused && npm test)", - "pretest": "npm run --silent lint", - "test": "npm run --silent tests-only", - "travis": "cd ../eslint-config-airbnb-base && npm install && npm link && cd - && npm link eslint-config-airbnb-base && npm run --silent test ; npm unlink eslint-config-airbnb-base >/dev/null &" - }, - "repository": { - "type": "git", - "url": "https://github.com/airbnb/javascript" - }, - "keywords": [ - "eslint", - "eslintconfig", - "config", - "airbnb", - "javascript", - "styleguide" - ], - "author": "Jake Teton-Landis (https://twitter.com/@jitl)", - "contributors": [ - { - "name": "Jake Teton-Landis", - "url": "https://twitter.com/jitl" - }, - { - "name": "Jordan Harband", - "email": "ljharb@gmail.com", - "url": "http://ljharb.codes" - }, - { - "name": "Harrison Shoff", - "url": "https://twitter.com/hshoff" - } - ], - "license": "MIT", - "bugs": { - "url": "https://github.com/airbnb/javascript/issues" - }, - "homepage": "https://github.com/airbnb/javascript", - "dependencies": { - "eslint-config-airbnb-base": "^3.0.1" - }, - "devDependencies": { - "babel-preset-airbnb": "^2.0.0", - "babel-tape-runner": "^2.0.1", - "eslint": "^2.10.2", - "eslint-find-rules": "^1.9.2", - "eslint-plugin-import": "^1.8.0", - "eslint-plugin-jsx-a11y": "^1.2.2", - "eslint-plugin-react": "^5.1.1", - "in-publish": "^2.0.0", - "react": ">= 0.13.0", - "tape": "^4.5.1" - }, - "peerDependencies": { - "eslint": "^2.10.2", - "eslint-plugin-jsx-a11y": "^1.2.2", - "eslint-plugin-import": "^1.8.0", - "eslint-plugin-react": "^5.1.1" - } -} diff --git a/packages/eslint-config-airbnb/rules/react-a11y.js b/packages/eslint-config-airbnb/rules/react-a11y.js deleted file mode 100644 index 6ba17e8eaa..0000000000 --- a/packages/eslint-config-airbnb/rules/react-a11y.js +++ /dev/null @@ -1,87 +0,0 @@ -module.exports = { - plugins: [ - 'jsx-a11y', - 'react' - ], - ecmaFeatures: { - jsx: true - }, - rules: { - // Require ARIA roles to be valid and non-abstract - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-role.md - 'jsx-a11y/aria-role': 2, - - // Enforce all aria-* props are valid. - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-props.md - 'jsx-a11y/aria-props': 0, - - // Enforce ARIA state and property values are valid. - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-proptypes.md - 'jsx-a11y/aria-proptypes': 0, - - // Enforce that elements that do not support ARIA roles, states, and - // properties do not have those attributes. - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/aria-unsupported-elements.md - 'jsx-a11y/aria-unsupported-elements': 0, - - // disallow href "#" - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/href-no-hash.md - 'jsx-a11y/href-no-hash': 0, - - // Require to have a non-empty `alt` prop, or role="presentation" - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/img-has-alt.md - 'jsx-a11y/img-has-alt': 2, - - // Prevent img alt text from containing redundant words like "image", "picture", or "photo" - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/img-redundant-alt.md - 'jsx-a11y/img-redundant-alt': 2, - - // require that JSX labels use "htmlFor" - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/label-has-for.md - 'jsx-a11y/label-has-for': 0, - - // require that mouseover/out come with focus/blur, for keyboard-only users - // TODO: enable? - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/mouse-events-have-key-events.md - 'jsx-a11y/mouse-events-have-key-events': 0, - - // Prevent use of `accessKey` - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-access-key.md - 'jsx-a11y/no-access-key': 2, - - // require onBlur instead of onChange - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-onchange.md - 'jsx-a11y/no-onchange': 0, - - // Enforce that elements with onClick handlers must be focusable. - // TODO: evaluate - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/onclick-has-focus.md - 'jsx-a11y/onclick-has-focus': 0, - - // require things with onClick to have an aria role - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/onclick-has-role.md - 'jsx-a11y/onclick-has-role': 0, - - // Enforce that elements with ARIA roles must have all required attributes - // for that role. - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-has-required-aria-props.md - 'jsx-a11y/role-has-required-aria-props': 0, - - // Enforce that elements with explicit or implicit roles defined contain - // only aria-* properties supported by that role. - // TODO: enable - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/role-supports-aria-props.md - 'jsx-a11y/role-supports-aria-props': 0, - - // Enforce tabIndex value is not greater than zero. - // TODO: evaluate - // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/tabindex-no-positive.md - 'jsx-a11y/tabindex-no-positive': 0, - }, -}; diff --git a/packages/eslint-config-airbnb/rules/react.js b/packages/eslint-config-airbnb/rules/react.js deleted file mode 100644 index 57884823c6..0000000000 --- a/packages/eslint-config-airbnb/rules/react.js +++ /dev/null @@ -1,235 +0,0 @@ -module.exports = { - plugins: [ - 'react' - ], - parserOptions: { - ecmaFeatures: { - jsx: true, - }, - }, - ecmaFeatures: { - jsx: true - }, - - // View link below for react rules documentation - // https://github.com/yannickcr/eslint-plugin-react#list-of-supported-rules - rules: { - // Specify whether double or single quotes should be used in JSX attributes - // http://eslint.org/docs/rules/jsx-quotes - 'jsx-quotes': [2, 'prefer-double'], - - // Prevent missing displayName in a React component definition - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md - 'react/display-name': [0, { ignoreTranspilerName: false }], - - // Forbid certain propTypes (any, array, object) - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-prop-types.md - 'react/forbid-prop-types': [0, { forbid: ['any', 'array', 'object'] }], - - // Enforce boolean attributes notation in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md - 'react/jsx-boolean-value': [2, 'never'], - - // Validate closing bracket location in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md - 'react/jsx-closing-bracket-location': [2, 'line-aligned'], - - // Enforce or disallow spaces inside of curly braces in JSX attributes - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md - 'react/jsx-curly-spacing': [2, 'never', { allowMultiline: true }], - - // Enforce event handler naming conventions in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-handler-names.md - 'react/jsx-handler-names': [0, { - eventHandlerPrefix: 'handle', - eventHandlerPropPrefix: 'on', - }], - - // Validate props indentation in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent-props.md - 'react/jsx-indent-props': [2, 2], - - // Validate JSX has key prop when in array or iterator - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-key.md - 'react/jsx-key': 0, - - // Limit maximum of props on a single line in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-max-props-per-line.md - 'react/jsx-max-props-per-line': [0, { maximum: 1 }], - - // Prevent usage of .bind() in JSX props - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md - 'react/jsx-no-bind': [2, { - ignoreRefs: true, - allowArrowFunctions: true, - allowBind: false, - }], - - // Prevent duplicate props in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-duplicate-props.md - 'react/jsx-no-duplicate-props': [0, { ignoreCase: false }], - - // Prevent usage of unwrapped JSX strings - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-literals.md - 'react/jsx-no-literals': 0, - - // Disallow undeclared variables in JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-undef.md - 'react/jsx-no-undef': 2, - - // Enforce PascalCase for user-defined JSX components - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md - 'react/jsx-pascal-case': [2, { - allowAllCaps: true, - ignore: [], - }], - - // Enforce propTypes declarations alphabetical sorting - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md - 'react/sort-prop-types': [0, { - ignoreCase: false, - callbacksLast: false, - }], - - // Deprecated in favor of react/jsx-sort-props - 'react/jsx-sort-prop-types': 0, - - // Enforce props alphabetical sorting - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md - 'react/jsx-sort-props': [0, { - ignoreCase: false, - callbacksLast: false, - }], - - // Prevent React to be incorrectly marked as unused - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-react.md - 'react/jsx-uses-react': [2, { pragma: 'React' }], - - // Prevent variables used in JSX to be incorrectly marked as unused - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-vars.md - 'react/jsx-uses-vars': 2, - - // Prevent usage of dangerous JSX properties - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger.md - 'react/no-danger': 0, - - // Prevent usage of deprecated methods - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-deprecated.md - 'react/no-deprecated': [1, { react: '0.14.0' }], - - // Prevent usage of setState in componentDidMount - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-mount-set-state.md - 'react/no-did-mount-set-state': [2, 'allow-in-func'], - - // Prevent usage of setState in componentDidUpdate - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-update-set-state.md - 'react/no-did-update-set-state': [2, 'allow-in-func'], - - // Prevent direct mutation of this.state - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-direct-mutation-state.md - 'react/no-direct-mutation-state': 0, - - // Prevent usage of isMounted - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-is-mounted.md - 'react/no-is-mounted': 2, - - // Prevent multiple component definition per file - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md - 'react/no-multi-comp': [2, { ignoreStateless: true }], - - // Prevent usage of setState - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-set-state.md - 'react/no-set-state': 0, - - // Prevent using string references - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-string-refs.md - 'react/no-string-refs': 2, - - // Prevent usage of unknown DOM property - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unknown-property.md - 'react/no-unknown-property': 2, - - // Require ES6 class declarations over React.createClass - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md - 'react/prefer-es6-class': [2, 'always'], - - // Require stateless functions when not using lifecycle methods, setState or ref - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md - 'react/prefer-stateless-function': 2, - - // Prevent missing props validation in a React component definition - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md - 'react/prop-types': [2, { ignore: [], customValidators: [] }], - - // Prevent missing React when using JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md - 'react/react-in-jsx-scope': 2, - - // Restrict file extensions that may be required - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-extension.md - 'react/require-extension': [0, { extensions: ['.jsx'] }], - - // Require render() methods to return something - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-render-return.md - 'react/require-render-return': 2, - - // Prevent extra closing tags for components without children - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md - 'react/self-closing-comp': 2, - - // Enforce spaces before the closing bracket of self-closing JSX elements - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md - 'react/jsx-space-before-closing': [2, 'always'], - - // Enforce component methods order - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md - 'react/sort-comp': [2, { - order: [ - 'static-methods', - 'lifecycle', - '/^on.+$/', - '/^(get|set)(?!(InitialState$|DefaultProps$|ChildContext$)).+$/', - 'everything-else', - '/^render.+$/', - 'render' - ], - }], - - // Prevent missing parentheses around multilines JSX - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/wrap-multilines.md - 'react/wrap-multilines': [2, { - declaration: true, - assignment: true, - return: true - }], - - // Require that the first prop in a JSX element be on a new line when the element is multiline - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-first-prop-new-line.md - 'react/jsx-first-prop-new-line': [2, 'multiline'], - - // Enforce spacing around jsx equals signs - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-equals-spacing.md - 'react/jsx-equals-spacing': [2, 'never'], - - // Enforce JSX indentation - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent.md - 'react/jsx-indent': [2, 2], - - // Disallow target="_blank" on links - // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-target-blank.md - // TODO: enable - 'react/jsx-no-target-blank': 0 - }, - - settings: { - 'import/resolver': { - node: { - extensions: ['.js', '.jsx', '.json'] - } - }, - react: { - pragma: 'React', - version: '0.14' - }, - } -}; diff --git a/packages/eslint-config-airbnb/test/.eslintrc b/packages/eslint-config-airbnb/test/.eslintrc deleted file mode 100644 index eafcdbffa6..0000000000 --- a/packages/eslint-config-airbnb/test/.eslintrc +++ /dev/null @@ -1,13 +0,0 @@ -{ - "rules": { - // disabled because I find it tedious to write tests while following this - // rule - "no-shadow": 0, - - // tests uses `t` for tape - "id-length": [2, {"min": 2, "properties": "never", "exceptions": ["t"]}], - - // tests can import things in devDependencies - "import/no-extraneous-dependencies": [2, {"devDependencies": true}] - } -} diff --git a/packages/eslint-config-airbnb/test/test-base.js b/packages/eslint-config-airbnb/test/test-base.js deleted file mode 100644 index 9457e2ef42..0000000000 --- a/packages/eslint-config-airbnb/test/test-base.js +++ /dev/null @@ -1,33 +0,0 @@ -import fs from 'fs'; -import path from 'path'; -import test from 'tape'; - -const base = require('../base'); - -const files = { base }; - -fs.readdirSync(path.join(__dirname, '../rules')).forEach(name => { - if (name === 'react.js' || name === 'react-a11y.js') { - return; - } - - files[name] = require(`../rules/${name}`); // eslint-disable-line global-require -}); - -Object.keys(files).forEach(name => { - const config = files[name]; - - test(`${name}: does not reference react`, t => { - t.plan(2); - - // scan plugins for react and fail if it is found - const hasReactPlugin = Object.prototype.hasOwnProperty.call(config, 'plugins') && - config.plugins.indexOf('react') !== -1; - t.notOk(hasReactPlugin, 'there is no react plugin'); - - // scan rules for react/ and fail if any exist - const reactRuleIds = Object.keys(config.rules) - .filter(ruleId => ruleId.indexOf('react/') === 0); - t.deepEquals(reactRuleIds, [], 'there are no react/ rules'); - }); -}); diff --git a/packages/eslint-config-airbnb/test/test-react-order.js b/packages/eslint-config-airbnb/test/test-react-order.js deleted file mode 100644 index 016fef9d34..0000000000 --- a/packages/eslint-config-airbnb/test/test-react-order.js +++ /dev/null @@ -1,95 +0,0 @@ -import test from 'tape'; -import { CLIEngine } from 'eslint'; -import eslintrc from '../'; -import reactRules from '../rules/react'; -import reactA11yRules from '../rules/react-a11y'; - -const cli = new CLIEngine({ - useEslintrc: false, - baseConfig: eslintrc, - - rules: { - // This rule fails when executing on text. - indent: 0, - - // It is okay to import devDependencies in tests. - 'import/no-extraneous-dependencies': [2, { devDependencies: true }], - }, -}); - -function lint(text) { - // @see http://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles - // @see http://eslint.org/docs/developer-guide/nodejs-api.html#executeontext - const linter = cli.executeOnText(text); - return linter.results[0]; -} - -function wrapComponent(body) { - return ` -import React from 'react'; -export default class MyComponent extends React.Component { -/* eslint no-empty-function: 0 */ -${body} -} -`; -} - -test('validate react prop order', (t) => { - t.test('make sure our eslintrc has React and JSX linting dependencies', (t) => { - t.plan(2); - t.deepEqual(reactRules.plugins, ['react']); - t.deepEqual(reactA11yRules.plugins, ['jsx-a11y', 'react']); - }); - - t.test('passes a good component', (t) => { - t.plan(3); - const result = lint(wrapComponent(` - componentWillMount() {} - componentDidMount() {} - setFoo() {} - getFoo() {} - setBar() {} - someMethod() {} - renderDogs() {} - render() { return
    ; } -`)); - - t.notOk(result.warningCount, 'no warnings'); - t.notOk(result.errorCount, 'no errors'); - t.deepEquals(result.messages, [], 'no messages in results'); - }); - - t.test('order: when random method is first', t => { - t.plan(2); - const result = lint(wrapComponent(` - someMethod() {} - componentWillMount() {} - componentDidMount() {} - setFoo() {} - getFoo() {} - setBar() {} - renderDogs() {} - render() { return
    ; } -`)); - - t.ok(result.errorCount, 'fails'); - t.equal(result.messages[0].ruleId, 'react/sort-comp', 'fails due to sort'); - }); - - t.test('order: when random method after lifecycle methods', t => { - t.plan(2); - const result = lint(wrapComponent(` - componentWillMount() {} - componentDidMount() {} - someMethod() {} - setFoo() {} - getFoo() {} - setBar() {} - renderDogs() {} - render() { return
    ; } -`)); - - t.ok(result.errorCount, 'fails'); - t.equal(result.messages[0].ruleId, 'react/sort-comp', 'fails due to sort'); - }); -}); From 7c75583648cf4618edd15a3c871f5af3f2f4dfb9 Mon Sep 17 00:00:00 2001 From: Stella Cannefax Date: Tue, 26 Jul 2016 12:07:58 -0500 Subject: [PATCH 6/8] remove react --- react/README.md | 554 ------------------------------------------------ 1 file changed, 554 deletions(-) delete mode 100644 react/README.md diff --git a/react/README.md b/react/README.md deleted file mode 100644 index 04ddda9f8f..0000000000 --- a/react/README.md +++ /dev/null @@ -1,554 +0,0 @@ -# Airbnb React/JSX Style Guide - -*A mostly reasonable approach to React and JSX* - -## Table of Contents - - 1. [Basic Rules](#basic-rules) - 1. [Class vs `React.createClass` vs stateless](#class-vs-reactcreateclass-vs-stateless) - 1. [Naming](#naming) - 1. [Declaration](#declaration) - 1. [Alignment](#alignment) - 1. [Quotes](#quotes) - 1. [Spacing](#spacing) - 1. [Props](#props) - 1. [Refs](#refs) - 1. [Parentheses](#parentheses) - 1. [Tags](#tags) - 1. [Methods](#methods) - 1. [Ordering](#ordering) - 1. [`isMounted`](#ismounted) - -## Basic Rules - - - Only include one React component per file. - - However, multiple [Stateless, or Pure, Components](https://facebook.github.io/react/docs/reusable-components.html#stateless-functions) are allowed per file. eslint: [`react/no-multi-comp`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md#ignorestateless). - - Always use JSX syntax. - - Do not use `React.createElement` unless you're initializing the app from a file that is not JSX. - -## Class vs `React.createClass` vs stateless - - - If you have internal state and/or refs, prefer `class extends React.Component` over `React.createClass` unless you have a very good reason to use mixins. eslint: [`react/prefer-es6-class`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-es6-class.md) [`react/prefer-stateless-function`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prefer-stateless-function.md) - - ```jsx - // bad - const Listing = React.createClass({ - // ... - render() { - return
    {this.state.hello}
    ; - } - }); - - // good - class Listing extends React.Component { - // ... - render() { - return
    {this.state.hello}
    ; - } - } - ``` - - And if you don't have state or refs, prefer normal functions (not arrow functions) over classes: - - ```jsx - // bad - class Listing extends React.Component { - render() { - return
    {this.props.hello}
    ; - } - } - - // bad (relying on function name inference is discouraged) - const Listing = ({ hello }) => ( -
    {hello}
    - ); - - // good - function Listing({ hello }) { - return
    {hello}
    ; - } - ``` - -## Naming - - - **Extensions**: Use `.jsx` extension for React components. - - **Filename**: Use PascalCase for filenames. E.g., `ReservationCard.jsx`. - - **Reference Naming**: Use PascalCase for React components and camelCase for their instances. eslint: [`react/jsx-pascal-case`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-pascal-case.md) - - ```jsx - // bad - import reservationCard from './ReservationCard'; - - // good - import ReservationCard from './ReservationCard'; - - // bad - const ReservationItem = ; - - // good - const reservationItem = ; - ``` - - - **Component Naming**: Use the filename as the component name. For example, `ReservationCard.jsx` should have a reference name of `ReservationCard`. However, for root components of a directory, use `index.jsx` as the filename and use the directory name as the component name: - - ```jsx - // bad - import Footer from './Footer/Footer'; - - // bad - import Footer from './Footer/index'; - - // good - import Footer from './Footer'; - ``` - -## Declaration - - - Do not use `displayName` for naming components. Instead, name the component by reference. - - ```jsx - // bad - export default React.createClass({ - displayName: 'ReservationCard', - // stuff goes here - }); - - // good - export default class ReservationCard extends React.Component { - } - ``` - -## Alignment - - - Follow these alignment styles for JSX syntax. eslint: [`react/jsx-closing-bracket-location`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md) - - ```jsx - // bad - - - // good - - - // if props fit in one line then keep it on the same line - - - // children get indented normally - - - - ``` - -## Quotes - - - Always use double quotes (`"`) for JSX attributes, but single quotes for all other JS. eslint: [`jsx-quotes`](http://eslint.org/docs/rules/jsx-quotes) - - > Why? JSX attributes [can't contain escaped quotes](http://eslint.org/docs/rules/jsx-quotes), so double quotes make contractions like `"don't"` easier to type. - > Regular HTML attributes also typically use double quotes instead of single, so JSX attributes mirror this convention. - - ```jsx - // bad - - - // good - - - // bad - - - // good - - ``` - -## Spacing - - - Always include a single space in your self-closing tag. - - ```jsx - // bad - - - // very bad - - - // bad - - - // good - - ``` - - - Do not pad JSX curly braces with spaces. eslint: [`react/jsx-curly-spacing`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md) - - ```jsx - // bad - - - // good - - ``` - -## Props - - - Always use camelCase for prop names. - - ```jsx - // bad - - - // good - - ``` - - - Omit the value of the prop when it is explicitly `true`. eslint: [`react/jsx-boolean-value`](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md) - - ```jsx - // bad -