@w5s/eslint-config 1.0.0-alpha.1

package/rules/base.js

@@ -0,0 +1,464 @@
+const { off, warn, error } = require('./_rule');
+
+module.exports = {
+  env: {
+    es6: true,
+  },
+  extends: [require.resolve('./node')], // TODO: remove that extends and provide a standalone configuration
+  plugins: [],
+  rules: {
+    'accessor-pairs': error,
+    'array-bracket-newline': off,
+    'array-bracket-spacing': [error, 'never'],
+    'array-callback-return': error,
+    'array-element-newline': off,
+    'arrow-body-style': [error, 'always'],
+    'arrow-parens': [error, 'always'],
+    'arrow-spacing': [error, { after: true, before: true }],
+    'block-scoped-var': error,
+    'block-spacing': [error, 'always'],
+    'brace-style': [error, '1tbs', { allowSingleLine: false }],
+    camelcase: off,
+    'capitalized-comments': off,
+    'class-methods-use-this': off,
+    'comma-dangle': [error, 'always-multiline'],
+    'comma-spacing': [error, { after: true, before: false }],
+    'comma-style': [error, 'last'],
+    complexity: [error, 20],
+    'computed-property-spacing': [error, 'never'],
+    'consistent-return': error,
+    'consistent-this': [error, 'self'],
+    'constructor-super': error,
+    curly: error,
+    'default-case': [error, { commentPattern: '^no default$' }], // require default case in switch statements or ignore by adding `//no default`
+    'dot-location': [error, 'property'],
+    'dot-notation': error,
+    'eol-last': error,
+    eqeqeq: [error, 'smart'],
+    'for-direction': error,
+    'func-call-spacing': [error, 'never'],
+    'func-name-matching': error,
+    'func-names': off,
+    'func-style': off,
+    'function-paren-newline': [error, 'consistent'],
+    'generator-star-spacing': [error, { after: false, before: true }],
+    'getter-return': [error, { allowImplicit: true }],
+    'guard-for-in': error,
+    'id-length': [error, { exceptions: ['t', '$', '_', 'x', 'y', 'z'], max: 50, min: 2, properties: 'never' }],
+    'id-match': off,
+    'implicit-arrow-linebreak': [error, 'beside'],
+    indent: [error, 2],
+    'init-declarations': off,
+    'jsx-quotes': [error, 'prefer-double'],
+    'key-spacing': [
+      error,
+      {
+        afterColon: true,
+        beforeColon: false,
+      },
+    ],
+    'keyword-spacing': [
+      error,
+      {
+        after: true,
+        before: true,
+      },
+    ],
+    'line-comment-position': 0,
+    'linebreak-style': [error, 'unix'],
+    'lines-around-comment': [
+      error,
+      {
+        allowArrayEnd: true,
+        allowArrayStart: true,
+        allowBlockEnd: true,
+        allowBlockStart: true,
+        allowObjectEnd: true,
+        allowObjectStart: true,
+        beforeBlockComment: true,
+        beforeLineComment: true,
+      },
+    ],
+    'lines-around-directive': [error, 'always'],
+    'lines-between-class-members': [error, 'always', { exceptAfterSingleLine: true }],
+    'max-len': [
+      warn,
+      {
+        code: 160,
+      },
+    ],
+    'max-nested-callbacks': [warn, { max: 5 }],
+    'max-statements-per-line': [
+      error,
+      {
+        max: 1,
+      },
+    ],
+    'multiline-comment-style': off,
+    'multiline-ternary': off,
+    'new-cap': [
+      off,
+      {
+        capIsNew: false,
+        newIsCap: true,
+      },
+    ],
+    'new-parens': error,
+    'newline-after-var': off,
+    'newline-before-return': error,
+    'newline-per-chained-call': off,
+    'no-alert': error,
+    'no-array-constructor': error,
+    'no-async-promise-executor': error,
+    'no-await-in-loop': error,
+    'no-caller': error,
+    'no-case-declarations': error,
+    'no-catch-shadow': error,
+    'no-class-assign': error,
+    'no-compare-neg-zero': error,
+    'no-cond-assign': error,
+    'no-confusing-arrow': error,
+    'no-console': error,
+    'no-const-assign': error,
+    'no-constant-condition': warn,
+    'no-continue': off,
+    'no-control-regex': error,
+    'no-debugger': error,
+    'no-delete-var': error,
+    'no-div-regex': error,
+    'no-dupe-args': error,
+    'no-dupe-class-members': error,
+    'no-dupe-else-if': error,
+    'no-dupe-keys': error,
+    'no-duplicate-case': error,
+    'no-duplicate-imports': off,
+    'no-else-return': [error, { allowElseIf: false }],
+    'no-empty': error,
+    'no-empty-character-class': error,
+    'no-empty-function': [error, { allow: ['arrowFunctions', 'functions', 'methods'] }],
+    'no-empty-pattern': error,
+    'no-eq-null': off,
+    'no-eval': error,
+    'no-ex-assign': error,
+    'no-extend-native': error,
+    'no-extra-bind': error,
+    'no-extra-boolean-cast': error,
+    'no-extra-parens': error,
+    'no-extra-semi': error,
+    'no-fallthrough': error,
+    'no-floating-decimal': error,
+    'no-func-assign': error,
+    'no-global-assign': error,
+    'no-implicit-coercion': error,
+    'no-implicit-globals': off,
+    'no-implied-eval': error,
+    'no-import-assign': error,
+    'no-inline-comments': off,
+    'no-inner-declarations': error,
+    'no-invalid-regexp': error,
+    'no-invalid-this': off,
+    'no-irregular-whitespace': error,
+    'no-iterator': error,
+    'no-label-var': error,
+    'no-labels': error,
+    'no-lone-blocks': error,
+    'no-lonely-if': error,
+    'no-loop-func': error,
+    'no-loss-of-precision': error,
+    'no-magic-numbers': off,
+    'no-misleading-character-class': error,
+    'no-mixed-spaces-and-tabs': error,
+    'no-multi-spaces': [
+      error,
+      {
+        ignoreEOLComments: false,
+      },
+    ],
+    'no-multi-str': error,
+    'no-multiple-empty-lines': [
+      error,
+      {
+        max: 1,
+        maxBOF: 0,
+        maxEOF: 1,
+      },
+    ],
+    'no-native-reassign': error,
+    'no-negated-condition': off,
+    'no-negated-in-lhs': error,
+    'no-nested-ternary': off,
+    'no-new': error,
+    'no-new-func': error,
+    'no-new-object': error,
+    'no-new-require': error,
+    'no-new-symbol': error,
+    'no-new-wrappers': error,
+    'no-obj-calls': error,
+    'no-octal': error,
+    'no-octal-escape': error,
+    'no-param-reassign': [
+      error,
+      {
+        props: false,
+      },
+    ],
+    'no-plusplus': error,
+    'no-promise-executor-return': error,
+    'no-proto': error,
+    'no-prototype-builtins': error,
+    'no-redeclare': [
+      error,
+      {
+        builtinGlobals: true,
+      },
+    ],
+    'no-regex-spaces': error,
+    'no-restricted-globals': off,
+    'no-restricted-properties': [
+      error,
+      {
+        message: 'arguments.callee is deprecated',
+        object: 'arguments',
+        property: 'callee',
+      },
+      {
+        message: 'Please use Number.isFinite instead',
+        object: 'global',
+        property: 'isFinite',
+      },
+      {
+        message: 'Please use Number.isFinite instead',
+        object: 'self',
+        property: 'isFinite',
+      },
+      {
+        message: 'Please use Number.isFinite instead',
+        object: 'window',
+        property: 'isFinite',
+      },
+      {
+        message: 'Please use Number.isNaN instead',
+        object: 'global',
+        property: 'isNaN',
+      },
+      {
+        message: 'Please use Number.isNaN instead',
+        object: 'self',
+        property: 'isNaN',
+      },
+      {
+        message: 'Please use Number.isNaN instead',
+        object: 'window',
+        property: 'isNaN',
+      },
+      {
+        message: 'Please use Object.defineProperty instead.',
+        property: '__defineGetter__',
+      },
+      {
+        message: 'Please use Object.defineProperty instead.',
+        property: '__defineSetter__',
+      },
+      {
+        message: 'Use the exponentiation operator (**) instead.',
+        object: 'Math',
+        property: 'pow',
+      },
+    ],
+    'no-restricted-syntax': [
+      error,
+      {
+        message:
+          'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
+        selector: 'ForInStatement',
+      },
+      {
+        message: 'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
+        selector: 'LabeledStatement',
+      },
+      {
+        message: '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',
+        selector: 'WithStatement',
+      },
+    ],
+    'no-return-assign': error,
+    'no-return-await': error,
+    'no-script-url': error,
+    'no-self-assign': error,
+    'no-self-compare': error,
+    'no-sequences': error,
+    'no-setter-return': error,
+    'no-shadow': [
+      error,
+      {
+        builtinGlobals: false,
+        hoist: 'all',
+      },
+    ],
+    'no-shadow-restricted-names': error,
+    'no-spaced-func': error,
+    'no-sparse-arrays': error,
+    'no-sync': off,
+    'no-tabs': error,
+    'no-template-curly-in-string': error,
+    'no-ternary': off,
+    'no-this-before-super': error,
+    'no-throw-literal': error,
+    'no-trailing-spaces': error,
+    'no-undef': error,
+    'no-undef-init': error,
+    'no-undefined': off,
+    'no-underscore-dangle': off,
+    'no-unexpected-multiline': error,
+    'no-unmodified-loop-condition': error,
+    'no-unneeded-ternary': off, // error,
+    'no-unreachable': error,
+    'no-unreachable-loop': error,
+    'no-unsafe-finally': error,
+    'no-unsafe-negation': error,
+    'no-unsafe-optional-chaining': [error, { disallowArithmeticOperators: true }],
+    'no-unused-expressions': [
+      error,
+      {
+        allowShortCircuit: false,
+        allowTaggedTemplates: true,
+        allowTernary: false,
+      },
+    ],
+    'no-unused-vars': [
+      error,
+      {
+        args: 'none',
+        ignoreRestSiblings: true,
+        vars: 'all',
+      },
+    ],
+    'no-use-before-define': [
+      error,
+      {
+        classes: false,
+        functions: false,
+        variables: false,
+      },
+    ],
+    'no-useless-backreference': error,
+    'no-useless-call': error,
+    'no-useless-catch': error,
+    'no-useless-computed-key': error,
+    'no-useless-concat': error,
+    'no-useless-constructor': error,
+    'no-useless-escape': error,
+    'no-useless-rename': [
+      error,
+      {
+        ignoreDestructuring: false,
+        ignoreExport: false,
+        ignoreImport: false,
+      },
+    ],
+    'no-useless-return': error,
+    'no-var': error,
+    'no-void': error,
+    'no-warning-comments': [
+      off,
+      {
+        location: 'start',
+        terms: ['todo', '@todo'],
+      },
+    ],
+    'no-whitespace-before-property': error,
+    'no-with': error,
+    'nonblock-statement-body-position': [error, 'below'],
+    'object-curly-spacing': [off, 'never'],
+    'object-property-newline': [
+      error,
+      {
+        allowMultiplePropertiesPerLine: false,
+      },
+    ],
+    'object-shorthand': [error, 'always'],
+    'one-var': [error, 'never'],
+    'one-var-declaration-per-line': error,
+    'operator-assignment': [error, 'always'],
+    'operator-linebreak': [error, 'after'],
+    'padded-blocks': [error, 'never'],
+    'padding-line-between-statements': off,
+    'prefer-arrow-callback': error,
+    'prefer-const': error,
+    'prefer-destructuring': off,
+    'prefer-named-capture-group': off,
+    'prefer-numeric-literals': error,
+    'prefer-promise-reject-errors': error,
+    'prefer-reflect': off,
+    'prefer-rest-params': error,
+    'prefer-spread': error,
+    'prefer-template': error,
+    'quote-props': [error, 'as-needed'],
+    quotes: [error, 'single'],
+    radix: error,
+    'require-await': off, // https://github.com/airbnb/javascript/issues/2013
+    'require-jsdoc': off,
+    'require-yield': error,
+    semi: [error, 'always'],
+    'semi-spacing': [
+      error,
+      {
+        after: true,
+        before: false,
+      },
+    ],
+    'semi-style': [error, 'last'],
+    'sort-keys': off /* [
+      error,
+      'asc',
+      {
+        caseSensitive: false,
+        natural: true
+      }
+    ], */,
+    'sort-vars': error,
+    'space-before-blocks': [error, 'always'],
+    'space-before-function-paren': [error, 'always'],
+    'space-in-parens': [error, 'never'],
+    'space-infix-ops': error,
+    'space-unary-ops': [
+      error,
+      {
+        nonwords: false,
+        words: true,
+      },
+    ],
+    'spaced-comment': [
+      error,
+      'always',
+      {
+        block: {
+          balanced: true,
+          exceptions: ['*'],
+          markers: ['*package', '!', ',', ':', '::', 'flow-include'],
+        },
+        line: {
+          markers: ['*package', '!', '/', ',', '='],
+        },
+      },
+    ],
+    strict: [error, 'never'],
+    'switch-colon-spacing': [
+      error,
+      {
+        after: true,
+        before: false,
+      },
+    ],
+    'symbol-description': error,
+    'template-tag-spacing': [error, 'never'],
+    'unicode-bom': [error, 'never'],
+    'use-isnan': error,
+    'valid-jsdoc': off,
+    'valid-typeof': [error, { requireStringLiterals: true }],
+    'vars-on-top': error,
+    'wrap-iife': [error, 'inside'],
+    'wrap-regex': off,
+    yoda: off,
+  },
+};

package/rules/import.js

@@ -0,0 +1,118 @@
+const { off, warn, error } = require('./_rule');
+
+/**
+ * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
+ * @param {string} _status
+ */
+// eslint-disable-next-line no-unused-vars
+const performanceIssue = (_status) => {
+  return off;
+};
+
+module.exports = {
+  plugins: ['import'],
+  rules: {
+    'import/default': error,
+    'import/export': error,
+    'import/exports-last': off,
+    'import/extensions': [
+      error,
+      'ignorePackages',
+      {
+        js: 'never',
+        json: 'always',
+        jsx: 'never',
+        mjs: 'never',
+        ts: 'never',
+        tsx: 'never',
+      },
+    ],
+    'import/first': [error, 'absolute-first'],
+    'import/group-exports': off,
+    'import/max-dependencies': [
+      off,
+      {
+        max: 10,
+      },
+    ],
+    'import/named': error,
+    'import/namespace': error,
+    'import/newline-after-import': error,
+    'import/no-absolute-path': error,
+    'import/no-amd': error,
+    'import/no-anonymous-default-export': off,
+    'import/no-commonjs': off, // Still used widely by nodejs programs
+    'import/no-cycle': [error, { maxDepth: Number.POSITIVE_INFINITY }], // Elm, ReasonML forbids circular dependency
+    'import/no-default-export': off,
+    'import/no-deprecated': performanceIssue(warn),
+    'import/no-duplicates': error,
+    'import/no-dynamic-require': error,
+    'import/no-extraneous-dependencies': [
+      error,
+      {
+        // https://github.com/airbnb/javascript/blob/1eadb93e377da1e56c3f91f26610e5d0a00738a9/packages/eslint-config-airbnb-base/rules/imports.js#L71
+        devDependencies: [
+          'test/**', // tape, common npm pattern
+          'tests/**', // also common npm pattern
+          'spec/**', // mocha, rspec-like pattern
+          '**/__tests__/**', // jest pattern
+          '**/__mocks__/**', // jest pattern
+          'test.{js,jsx,ts,tsx}', // repos with a single test file
+          'test-*.{js,jsx,ts,tsx}', // repos with multiple top-level test files
+          '**/*{.,_}{test,spec}.{js,jsx,ts,tsx}', // tests where the extension or filename suffix denotes that it is a test
+          '**/jest.config.{js,ts}', // jest config
+          '**/jest.setup.{js,ts}', // jest setup
+          '**/vue.config.{js,ts}', // vue-cli config
+          '**/webpack.config.js', // webpack config
+          '**/webpack.config.*.js', // webpack config
+          '**/rollup.config.js', // rollup config
+          '**/rollup.config.*.js', // rollup config
+          '**/gulpfile.js', // gulp config
+          '**/gulpfile.*.js', // gulp config
+          '**/Gruntfile{,.js}', // grunt config
+          '**/protractor.conf.js', // protractor config
+          '**/protractor.conf.*.js', // protractor config
+          '**/karma.conf.js', // karma config
+          '**/.eslintrc.js', // eslint config,
+          '**/markdown.config.js', // markdown magic config,
+        ],
+        optionalDependencies: false,
+      },
+    ],
+    'import/no-internal-modules': off,
+    'import/no-mutable-exports': error,
+    'import/no-named-as-default': performanceIssue(error),
+    'import/no-named-as-default-member': error,
+    'import/no-named-default': error,
+    'import/no-named-export': off,
+    'import/no-namespace': off,
+    'import/no-nodejs-modules': off,
+    'import/no-relative-parent-imports': off,
+    'import/no-restricted-paths': off,
+    'import/no-self-import': error,
+    'import/no-unassigned-import': off,
+    'import/no-unresolved': [error, { caseSensitive: true, commonjs: true }],
+    'import/no-unused-modules': [performanceIssue(error), { unusedExports: true }],
+    'import/no-useless-path-segments': error,
+    'import/no-webpack-loader-syntax': error,
+    'import/order': [
+      error,
+      {
+        groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+        'newlines-between': 'never',
+      },
+    ],
+    'import/prefer-default-export': off,
+    'import/unambiguous': off, // Disable because proposal still in progress
+  },
+  settings: {
+    'import/core-modules': [],
+    'import/extensions': ['.js', '.mjs', '.jsx'],
+    'import/ignore': ['node_modules', '\\.(coffee|scss|css|less|hbs|svg|json)$'],
+    'import/resolver': {
+      node: {
+        extensions: ['.mjs', '.js', '.json'],
+      },
+    },
+  },
+};

package/rules/jest.js

@@ -0,0 +1,46 @@
+const { off, error } = require('./_rule');
+
+/**
+ * Typescript config is loose because we often have "hack", "mock" in tests
+ */
+const tsDisabled = {
+  '@typescript-eslint/no-unsafe-assignment': off,
+  '@typescript-eslint/no-unsafe-call': off,
+  '@typescript-eslint/no-unsafe-member-access': off,
+  '@typescript-eslint/no-unsafe-return': off,
+  '@typescript-eslint/restrict-template-expressions': off,
+  '@typescript-eslint/unbound-method': off,
+};
+
+module.exports = {
+  env: {
+    jest: true,
+  },
+  extends: ['plugin:jest/recommended'],
+  plugins: ['jest'],
+  rules: Object.assign(
+    {
+      'jest/expect-expect': off, // Disabled because it does not handle functions that does the expect
+      'jest/no-alias-methods': error,
+      'jest/no-commented-out-tests': error,
+      'jest/no-deprecated-functions': off,
+      'jest/no-disabled-tests': off,
+      'jest/no-done-callback': error,
+      'jest/no-export': off,
+      'jest/no-focused-tests': error,
+      'jest/no-identical-title': error,
+      'jest/no-restricted-matchers': [
+        error,
+        {
+          toBeFalsy: 'Avoid `toBeFalsy`',
+          toBeTruthy: 'Avoid `toBeTruthy`',
+        },
+      ],
+      'jest/prefer-spy-on': error,
+      'jest/prefer-to-contain': error,
+      'jest/valid-expect': error,
+      'jest/valid-title': [error, { ignoreTypeOfDescribeName: true }],
+    },
+    tsDisabled
+  ),
+};

package/rules/jsdoc.js

@@ -0,0 +1,20 @@
+const { off, warn, error } = require('./_rule');
+
+module.exports = {
+  plugins: ['jsdoc'],
+  rules: {
+    'jsdoc/check-param-names': warn,
+    'jsdoc/check-tag-names': warn,
+    'jsdoc/check-types': warn,
+    'jsdoc/newline-after-description': [warn, 'always'],
+    'jsdoc/require-description': off,
+    'jsdoc/require-description-complete-sentence': off,
+    'jsdoc/require-hyphen-before-param-description': off,
+    'jsdoc/require-param': off,
+    'jsdoc/require-param-description': off,
+    'jsdoc/require-param-name': error,
+    'jsdoc/require-param-type': off,
+    'jsdoc/require-returns-description': off,
+    'jsdoc/require-returns-type': off,
+  },
+};

package/rules/node.js

@@ -0,0 +1,21 @@
+const { off, error } = require('./_rule');
+
+// @see https://eslint.org/blog/2020/02/whats-coming-in-eslint-7.0.0#deprecating-node-js-commonjs-specific-rules
+module.exports = {
+  env: {
+    node: true,
+  },
+  rules: {
+    'callback-return': off,
+    'global-require': error,
+    'handle-callback-err': off,
+    'no-buffer-constructor': error,
+    'no-mixed-requires': [off, false],
+    'no-new-require': error,
+    'no-path-concat': error,
+    'no-process-env': off,
+    'no-process-exit': off,
+    'no-restricted-modules': off,
+    'no-sync': off,
+  },
+};

package/rules/prettier.js

@@ -0,0 +1,16 @@
+const { error, off } = require('./_rule');
+
+module.exports = {
+  plugins: ['prettier'],
+  rules: {
+    'arrow-body-style': off,
+    'prefer-arrow-callback': off,
+    'prettier/prettier': [
+      error,
+      {
+        singleQuote: true,
+        trailingComma: 'es5',
+      },
+    ],
+  },
+};