/**

* @license Apache-2.0

*

* Copyright (c) 2018 The Stdlib Authors.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

'use strict';

/**

* ESLint rules which enforce style.

*

* @namespace rules

*/

var rules = {};

/**

* Always requiring line breaks if line breaks already exist between array elements. NOTE: disabled to allow some freedom in determining best presentation. In general, prefer line breaks if already using line breaks.

*

* @name array-bracket-newline

* @memberof rules

* @type {Array}

* @see [array-bracket-newline]{@link https://eslint.org/docs/rules/array-bracket-newline}

*

* @example

* // Bad...

* var arr = [

* 1, 2

* ];

*

* @example

* // Good...

* var arr = [

* 1,

* 2

* ];

*/

rules[ 'array-bracket-newline' ] = [ 'off', {

'multiline': true,

'minItems': null

}];

/**

* Warn when not having spaces within array brackets. NOTE: disabled as difficult to enforce a general rule. Prefer spaces within array brackets, but allow discretion in balancing readability, clarity, and aesthetics.

*

* @name array-bracket-spacing

* @memberof rules

* @type {Array}

* @see [array-bracket-spacing]{@link https://eslint.org/docs/rules/array-bracket-spacing}

*

* @example

* // Bad...

* var arr = [5];

*

* @example

* // Good...

* var arr = [ 5 ];

*

* @example

* // Okay...

* var arr = [ [ 1 ], [ 2 ] ];

*

* @example

* // Okay...

* var arr = [[ 1 ], [ 2 ]];

*

* @example

* // Okay...

* var arr = [ [1], [2] ];

*/

rules[ 'array-bracket-spacing' ] = [ 'off', 'always', {

'singleValue': true,

'objectsInArrays': false,

'arraysInArrays': false

}];

/**

* Enforce consistent line breaks between array elements.

*

* @name array-element-newline

* @memberof rules

* @type {Array}

* @default [ 'error', 'consistent' ]

* @see [array-element-newline]{@link https://eslint.org/docs/rules/array-element-newline}

*

* @example

* // Bad...

* var arr = [

* 1, 2,

* 3

* ];

*

* @example

* // Okay...

* var arr = [ 1, 2, 3 ];

*

* @example

* // Okay...

* var arr = [

* 1,

* 2,

* 3

* ];

*/

rules[ 'array-element-newline' ] = [ 'error', 'consistent' ];

/**

* Always require spaces in single-line blocks.

*

* @name block-spacing

* @memberof rules

* @type {Array}

* @default [ 'error', 'always' ]

* @see [block-spacing]{@link https://eslint.org/docs/rules/block-spacing}

*

* @example

* // Bad...

* function foo( x ) {

* if ( x === 5 ) {return x;}

* }

*

* @example

* // Good...

* function foo( x ) {

* if ( x === 5 ) { return x; }

* }

*/

rules[ 'block-spacing' ] = [ 'error', 'always' ];

/**

* Prefer "one true brace style", but allow consideration of readability and aesthetics.

*

* @name brace-style

* @memberof rules

* @type {Array}

* @see [brace-style]{@link https://eslint.org/docs/rules/brace-style}

*

* @example

* // Bad...

* function foo( x ) {

* if ( x !== x )

* {

* return NaN;

* }

* }

*

* @example

* // Bad...

* function foo( x ) {

* if ( x !== x ) { return NaN; }

* }

*

* @example

* // Good...

* if ( x < 10.0 ) {

* y = foo( x );

* } else {

* y = bar( x );

* }

*

* @example

* // Okay...

* if ( x < 10.0 ) {

* y = foo( x );

* }

* // Mid-range approximation...

* else if ( x < 20.0 ) {

* y = bar( x );

* }

* // Large approximation...

* else {

* y = beep( x );

* }

*/

rules[ 'brace-style' ] = [ 'off', '1tbs', {

'allowSingleLine': false

}];

/**

* Require camelcased variable names, but relax the restriction for property names.

*

* @name camelcase

* @memberof rules

* @type {Array}

* @default [ 'error', {'properties':'never'} ]

* @see [camelcase]{@link https://eslint.org/docs/rules/camelcase}

*

* @example

* // Bad...

* var beep_boop = true;

*

* @example

* // Good...

* var beepBoop = true;

*

* @example

* // Okay...

* var obj = {

* 'beep_boop': true

* };

*/

rules[ 'camelcase' ] = [ 'error', {

'properties': 'never'

}];

/**

* Require that the first letter of a comment be capitalized, but relax this restriction for inline comments.

*

* @name capitalized-comments

* @memberof rules

* @type {Array}

* @see [capitalized-comments]{@link https://eslint.org/docs/rules/capitalized-comments}

*

* @example

* // Good...

*

* @example

* // bad...

*/

rules[ 'capitalized-comments' ] = [ 'off', 'always', {

'ignoreInlineComments': true

}];

/**

* Never allow trailing commas.

*

* @name comma-dangle

* @memberof rules

* @type {Array}

* @default [ 'error', 'never' ]

* @see [comma-dangle]{@link https://eslint.org/docs/rules/comma-dangle}

*

* @example

* // Bad...

* var obj = {

* 'beep': true,

* };

*

* @example

* // Good...

* var obj = {

* 'beep': true

* }

*/

rules[ 'comma-dangle' ] = [ 'error', 'never' ];

/**

* Require a space after a comma, but never before.

*

* @name comma-spacing

* @memberof rules

* @type {Array}

* @see [comma-spacing]{@link https://eslint.org/docs/rules/comma-spacing}

*

* @example

* // Bad...

* var x = 5,y = 8;

*

* @example

* // Bad...

* var x = 5 ,y = 8;

*

* @example

* // Good...

* var x = 5, y = 8;

*/

rules[ 'comma-spacing' ] = [ 'error', {

'before': false,

'after': true

}];

/**

* Require a comma after and on the same line as an array element, object property, or variable declaration.

*

* @name comma-style

* @memberof rules

* @type {Array}

* @default [ 'error', 'last' ]

* @see [comma-style]{@link https://eslint.org/docs/rules/comma-style}

*

* @example

* // Bad...

* var obj = {

* 'beep': true

* , 'boop': true

* };

*

* @example

* // Good...

* var obj = {

* 'beep': true,

* 'boop': true

* };

*/

rules[ 'comma-style' ] = [ 'error', 'last' ];

/**

* Prefer using whitespace within computed properties. NOTE: disabled, as hard to enforce a general rule. While whitespace is preferred, readability and clarity is preferred to a greater extent.

*

* @name computed-property-spacing

* @memberof rules

* @type {Array}

* @default [ 'off', 'always' ]

* @see [computed-property-spacing]{@link https://eslint.org/docs/rules/computed-property-spacing}

*

* @example

* // Bad...

* var x = obj[prop];

*

* @example

* // Okay...

* var i = 1;

* var x = (1+y[i]) * 10;

*

* @example

* // Good...

* var x = obj[ prop ];

*/

rules[ 'computed-property-spacing' ] = [ 'off', 'always' ];

/**

* Require a `this` variable to only be aliased as `self`.

*

* @name consistent-this

* @memberof rules

* @type {Array}

* @default [ 'error', 'self' ]

* @see [consistent-this]{@link https://eslint.org/docs/rules/consistent-this}

*

* @example

* // Bad...

* var that = this;

*

* @example

* // Good...

* var self = this;

*/

rules[ 'consistent-this' ] = [ 'error', 'self' ];

/**

* Always require an end-of-line character at the end of non-empty files, thus allowing for appending to and concatenating files.

*

* @name eol-last

* @memberof rules

* @type {Array}

* @default [ 'error', 'always' ]

* @see [eol-last]{@link https://eslint.org/docs/rules/eol-last}

*/

rules[ 'eol-last' ] = [ 'error', 'always' ];

/**

* Never allow a space between function identifiers and their invocations.

*

* @name func-call-spacing

* @memberof rules

* @type {Array}

* @default [ 'error', 'never' ]

* @see [func-call-spacing]{@link https://eslint.org/docs/rules/func-call-spacing}

*

* @example

* // Bad...

* foo ();

*

* @example

* // Good...

* foo();

*/

rules[ 'func-call-spacing' ] = [ 'error', 'never' ];

/**

* Do not require that a variable name match a function name or property.

*

* @name func-name-matching

* @memberof rules

* @type {string}

* @default 'off'

* @see [func-name-matching]{@link https://eslint.org/docs/rules/func-name-matching}

*

* @example

* // Okay...

* var f = obj.foo;

*/

rules[ 'func-name-matching' ] = 'off';

/**

* Always require that functions have a name to aid debugging.

*

* @name func-names

* @memberof rules

* @type {Array}

* @default [ 'error', 'always' ]

* @see [func-names]{@link https://eslint.org/docs/rules/func-names}

*

* @example

* // Bad...

* var foo = function() {

* // Do something...

* };

*

* @example

* // Good...

* var foo = function foo() {

* // Do something...

* };

*

* @example

* // Better...

* function foo() {

* // Do something...

* }

*/

rules[ 'func-names' ] = [ 'error', 'always' ];

/**

* Always require function declarations and never allow function expressions or arrow functions.

*

* @name func-style

* @memberof rules

* @type {Array}

* @see [func-style]{@link https://eslint.org/docs/rules/func-style}

*

* @example

* // Bad...

* var foo = function() {

* // Do something...

* };

*

* @example

* // Good...

* function foo() {

* // Do something...

* }

*/

rules[ 'func-style' ] = [ 'error', 'declaration', {

'allowArrowFunctions': false

}];

/**

* Never allow linebreaks between arguments of a function call.

*

* @name function-call-argument-newline

* @memberof rules

* @type {Array}

* @default [ 'error', 'never' ]

* @see [function-call-argument-newline]{@link https://eslint.org/docs/rules/function-call-argument-newline}

*

* @example

* // Bad...

* function foo(

* x,

* y

* ) {

* return x + y;

* }

*

* @example

* // Bad...

* console.log(

* 1,

* 2

* );

*

* @example

* // Good...

* function foo( x, y ) {

* return x + y;

* }

*

* @example

* // Good...

* console.log( 1, 2 );

*/

rules[ 'function-call-argument-newline' ] = [ 'error', 'never' ];

/**

* Never allow linebreaks inside parentheses of function parameters or arguments.

*

* @name function-paren-newline

* @memberof rules

* @type {Array}

* @default [ 'error', 'never' ]

* @see [function-paren-newline]{@link https://eslint.org/docs/rules/function-paren-newline}

*

* @example

* // Bad...

* function foo(

* x,

* y

* ) {

* return x + y;

* }

*

* @example

* // Bad...

* console.log(

* 1,

* 2

* );

*

* @example

* // Good...

* function foo( x, y ) {

* return x + y;

* }

*

* @example

* // Good...

* console.log( 1, 2 );

*/

rules[ 'function-paren-newline' ] = [ 'error', 'never' ];

/**

* Do not blacklist any identifiers.

*

* @name id-blacklist

* @memberof rules

* @type {string}

* @default 'off'

* @see [id-blacklist]{@link https://eslint.org/docs/rules/id-blacklist}

*/

rules[ 'id-blacklist' ] = 'off';

/**

* Warn if the length of an identifier name exceeds `25` characters.

*

* @name id-length

* @memberof rules

* @type {Array}

* @see [id-length]{@link https://eslint.org/docs/rules/id-length}

*/

rules[ 'id-length' ] = [ 'warn', {

'min': 1,

'max': 25,

'properties': 'never'

}];

/**

* Do not impose draconian name restrictions.

*

* @name id-match

* @memberof rules

* @type {string}

* @default 'off'

* @see [id-match]{@link https://eslint.org/docs/rules/id-match}

*/

rules[ 'id-match' ] = 'off';

/**

* Do not allow a newline before an arrow function body.

*

* @name implicit-arrow-linebreak

* @memberof rules

* @type {Array}

* @default [ 'error', 'beside' ]

* @see [implicit-arrow-linebreak]{@link https://eslint.org/docs/rules/implicit-arrow-linebreak}

*

* @example

* // Bad...

* (foo) =>

* bar;

*

* @example

* // Okay...

* (foo) => bar;

*/

rules[ 'implicit-arrow-linebreak' ] = [ 'error', 'beside' ];

/**

* Require tabs, except for `case` statements.

*

* @name indent

* @memberof rules

* @type {Array}

* @see [indent]{@link https://eslint.org/docs/rules/indent}

*/

rules[ 'indent' ] = [ 'error', 'tab', {

'SwitchCase': 0,

'VariableDeclarator': 1,

'outerIIFEBody': 1,

'MemberExpression': 1,

'FunctionDeclaration': {

'body': 1,

'parameters': 'off'

},

'FunctionExpression': {

'body': 1,

'parameters': 'off'

},

'CallExpression': {

'arguments': 'off'

},

'ArrayExpression': 1,

'ObjectExpression': 1,

'flatTernaryExpressions': true

}];

/**

* Disable rule for JSX quotes.

*

* @name jsx-quotes

* @memberof rules

* @type {string}

* @see [jsx-quotes]{@link https://eslint.org/docs/rules/jsx-quotes}

*/

rules[ 'jsx-quotes' ] = 'off';

/**

* Require a space after, but not before, the colon separating an object property from a corresponding value.

*

* @name key-spacing

* @memberof rules

* @type {Array}

* @see [key-spacing]{@link https://eslint.org/docs/rules/key-spacing}

*

* @example

* // Bad...

* var obj = {

* 'beep' : 'boop'

* };

*

* @example

* // Good...

* var obj = {

* 'beep': 'boop'

* };

*/

rules[ 'key-spacing' ] = [ 'error', {

'beforeColon': false,

'afterColon': true,

'mode': 'strict'

}];

/**

* Require spaces around keywords.

*

* @name keyword-spacing

* @memberof rules

* @type {Array}

* @see [keyword-spacing]{@link https://eslint.org/docs/rules/keyword-spacing}

*

* @example

* // Bad...

* if( x < 10 ){

* y = foo( x );

* }else{

* y = bar( x );

}

*

* @example

* // Good...

* if ( x!== x ) {

* y = foo( x );

* } else {

* y = bar( x );

* }

*/

rules[ 'keyword-spacing' ] = [ 'error', {

'before': true,

'after': true

}];

/**

* Allow comments either above or beside code.

*

* @name line-comment-position

* @memberof rules

* @type {string}

* @default 'off'

* @see [line-comment-position]{@link https://eslint.org/docs/rules/line-comment-position}

*/

rules[ 'line-comment-position' ] = 'off';

/**

* Enforce Unix-style line breaks.

*

* @name linebreak-style

* @memberof rules

* @type {Array}

* @default [ 'error', 'unix' ]

* @see [linebreak-style]{@link https://eslint.org/docs/rules/linebreak-style}

*/

rules[ 'linebreak-style' ] = [ 'error', 'unix' ];

/**

* Prefer empty lines before comments.

*

* @name lines-around-comment

* @memberof rules

* @type {Array}

* @see [lines-around-comment]{@link https://eslint.org/docs/rules/lines-around-comment}

*

* @example

* // Bad...

* var x = 5;

* // Line comment:

* var y = 10;

*

* @example

* // Good...

* var x = 5;

*

* // Line comment:

* var y = 10;

*/

rules[ 'lines-around-comment' ] = [ 'off', { // NOTE: disabled to allow some discretion in terms of readability, clarity, and terseness.

'beforeBlockComment': true,

'afterBlockComment': false,

'beforeLineComment': true,

'afterLineComment': false,

'allowBlockStart': true,

'allowBlockEnd': true,

'allowObjectStart': true,

'allowObjectEnd': true,

'allowArrayStart': true,

'allowArrayEnd': true,

'allowClassStart': true,

'allowClassEnd': true

}];

/**

* Do not allow lines between class members.

*

* @name lines-between-class-members

* @memberof rules

* @type {Array}

* @see [lines-between-class-members]{@link https://eslint.org/docs/rules/lines-between-class-members}

*

* @example

* // Bad...

* class Foo {

* bar() {}

*

* baz() {}

* }

*

* @example

* // Okay...

* class Foo {

* bar() {}

* baz() {}

* }

*/

rules[ 'lines-between-class-members' ] = [ 'error', 'never', {

'exceptAfterSingleLine': false

}];

/**

* Enforce a maximum depth that blocks can be nested.

*

* @name max-depth

* @memberof rules

* @type {Array}

* @default [ 'error', {'max': 5} ]

* @see [max-depth]{@link https://eslint.org/docs/rules/max-depth}

*/

rules[ 'max-depth' ] = [ 'error', {

'max': 5

}];

/**

* Do not allow a line to exceed a maximum line length.

*

* @name max-len

* @memberof rules

* @type {Array}

* @see [max-len]{@link https://eslint.org/docs/rules/max-len}

*/

rules[ 'max-len' ] = [ 'warn', {

'code': 80,

'tabWidth': 4,

'ignoreComments': true,

'ignoreUrls': true,

'ignoreStrings': true,

'ignoreTemplateLiterals': true,

'ignoreRegExpLiterals': true

}];

/**

* Limit the number of source code lines in a file.

*

* @name max-lines

* @memberof rules

* @type {Array}

* @see [max-lines]{@link https://eslint.org/docs/rules/max-lines}

*/

rules[ 'max-lines' ] = [ 'warn', {

'max': 300,

'skipBlankLines': true,

'skipComments': true

}];

/**

* Warn when a function contains more than `200` source code lines.

*

* @name max-lines-per-function

* @memberof rules

* @type {Array}

* @see [max-lines-per-function]{@link https://eslint.org/docs/rules/max-lines-per-function}

*/

rules[ 'max-lines-per-function' ] = [ 'warn', {

'max': 200,

'skipBlankLines': true,

'skipComments': true,

'IIFEs': true

}];

/**

* Limit the number of nested callbacks.

*

* @name max-nested-callbacks

* @memberof rules

* @type {Array}

* @default [ 'error', {'max': 3} ]

* @see [max-nested-callbacks]{@link https://eslint.org/docs/rules/max-nested-callbacks}

*/

rules[ 'max-nested-callbacks' ] = [ 'error', {

'max': 3

}];

/**

* Never allow more than `10` parameters.

*

* @name max-params

* @memberof rules

* @type {Array}

* @default [ 'error', {'max': 10} ]

* @see [max-params]{@link https://eslint.org/docs/rules/max-params}

*/

rules[ 'max-params' ] = [ 'error', {

'max': 10

}];

/**

* Warn when a function has more than `100` statements.

*

* @name max-statements

* @memberof rules

* @type {Array}

* @default [ 'warn', {'max': 100} ]

* @see [max-statements]{@link https://eslint.org/docs/rules/max-statements}

*/

rules[ 'max-statements' ] = [ 'warn', {

'max': 100

}];

/**

* Require only `1` statement per line.

*

* @name max-statements-per-line

* @memberof rules

* @type {Array}

* @default [ 'error', {'max': 1} ]

* @see [max-statements-per-line]{@link https://eslint.org/docs/rules/max-statements-per-line}

*/

rules[ 'max-statements-per-line' ] = [ 'error', {

'max': 1

}];

/**

* Require multiline comments be "starred" blocks. NOTE: currently disabled as the rule only supports "aligned" starred blocks.

*

* @name multiline-comment-style

* @memberof rules

* @type {Array}

* @default [ 'off', 'starred-block' ]

* @see [multiline-comment-style]{@link https://eslint.org/docs/rules/multiline-comment-style}

*/

rules[ 'multiline-comment-style' ] = [ 'off', 'starred-block' ]; // TODO: enable once non-"aligned" blocks are supported

/**

* Allow same line or multiline ternary expressions.

*

* @name multiline-ternary

* @memberof rules

* @type {string}

* @default 'off'

* @see [multiline-ternary]{@link https://eslint.org/docs/rules/multiline-ternary}

*/

rules[ 'multiline-ternary' ] = 'off';

/**

* Require all uppercase-started functions (and properties) be called with the `new` operator.

*

* @name new-cap

* @memberof rules

* @type {Array}

* @see [new-cap]{@link https://eslint.org/docs/rules/new-cap}

*/

rules[ 'new-cap' ] = [ 'error', {

'newIsCap': false,

'capIsNew': true,

'properties': true

}];

/**

* Require parentheses when invoking a function using the `new` operator.

*

* @name new-parens

* @memberof rules

* @type {Array}

* @default [ 'error', 'always' ]

* @see [new-parens]{@link https://eslint.org/docs/rules/new-parens}

*

* @example

* // Bad...

* var arr = new Array;

*

* @example

* // Good...

* var arr = new Array();

*/

rules[ 'new-parens' ] = [ 'error', 'always' ];

/**

* Do not enforce newlines within chained calls.

*

* @name newline-per-chained-call

* @memberof rules

* @type {string}

* @default 'off'

* @see [newline-per-chained-call]{@link https://eslint.org/docs/rules/newline-per-chained-call}

*/

rules[ 'newline-per-chained-call' ] = 'off';

/**

* Never allow the use of the `Array` constructor when an array literal can be used.

*

* @name no-array-constructor

* @memberof rules

* @type {string}

* @default 'error'

* @see [no-array-constructor]{@link https://eslint.org/docs/rules/no-array-constructor}

*

* @example

* // Bad...

* var arr = new Array( 1, 2, 3 );

*

* @example

* // Good...

* var arr = [ 1, 2, 3 ];

*

* @example

* // Good...

* var arr = new Array( 10 );

*/

rules[ 'no-array-constructor' ] = 'error';

/**

* Allow the use of bitwise operators.

*

* @name no-bitwise

* @memberof rules

* @type {string}

* @default 'off'

* @see [no-bitwise]{@link https://eslint.org/docs/rules/no-bitwise}

*

* @example

* var isOdd = x & 1;

*/

rules[ 'no-bitwise' ] = 'off';

/**

* Allow the use of the `continue` statement.

*

* @name no-continue

* @memberof rules

* @type {string}

* @default 'off'

* @see [no-continue]{@link https://eslint.org/docs/rules/no-continue}

*

* @example

* // Okay...

* var i;

* for ( i = 0; i < 10; i++ ) {

* if ( i < 5 ) {

* continue;

* }

* // Do something...

* }

*/

rules[ 'no-continue' ] = 'off';

/**

* Allow inline comments.

*

* @name no-inline-comments

* @memberof rules

* @type {string}

* @default 'off'