@w5s/eslint-config 1.0.0-alpha.3 → 1.0.0-alpha.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/eslint-config",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "description": "ESLint configuration presets",
   "keywords": [
     "eslint",
@@ -77,5 +77,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9935d3a478d08c3c6c02f467f65c623a16749753"
+  "gitHead": "cd7eb2b021bb3c9dbc91375cece5349173a7c81a"
 }

package/rules/base.js

@@ -7,7 +7,7 @@ module.exports = concatESConfig(
   require('eslint-config-airbnb-base/rules/errors'),
   // @ts-ignore
   require('eslint-config-airbnb-base/rules/es6'),
-  // we use our own import configuration
+  /** {@link ./import.js} */
   // require('eslint-config-airbnb-base/rules/imports'),
   // @ts-ignore
   require('eslint-config-airbnb-base/rules/node'),

package/rules/import.js

@@ -1,4 +1,4 @@
-const { off, warn, error } = require('./_rule');
+const { off, warn, error, concatESConfig, fixme } = require('./_rule');
 
 /**
  * @see https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
@@ -7,110 +7,17 @@ const { off, warn, error } = require('./_rule');
 // eslint-disable-next-line no-unused-vars
 const performanceIssue = (_status) => 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'],
-      },
+module.exports = concatESConfig(
+  // @ts-ignore
+  require('eslint-config-airbnb-base/rules/imports'),
+  // Overrides
+  {
+    rules: {
+      'import/no-deprecated': performanceIssue(warn),
+      'import/no-named-as-default': performanceIssue(error),
+      'import/no-unused-modules': performanceIssue(error),
+      'import/prefer-default-export': off, // Not aligned, default export does not bring sufficient semantic
+      'import/unambiguous': fixme(off), // Disable because proposal still in progress
     },
-  },
-};
+  }
+);

package/rules/jest.js

@@ -1,25 +1,13 @@
-const { off, error } = require('./_rule');
+const { off, error, concatESConfig } = 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(
-    {
+module.exports = concatESConfig(
+  {
+    env: {
+      jest: true,
+    },
+    extends: ['plugin:jest/recommended'],
+    plugins: ['jest'],
+    rules: {
       '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,
@@ -41,6 +29,18 @@ module.exports = {
       'jest/valid-expect': error,
       'jest/valid-title': [error, { ignoreTypeOfDescribeName: true }],
     },
-    tsDisabled
-  ),
-};
+  },
+  /**
+   * Typescript config is set to be less strict because we often have "hack", "mock" in tests
+   */
+  {
+    rules: {
+      '@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,
+    },
+  }
+);

package/rules/typescript.js

@@ -1,56 +1,24 @@
-const { fixme, off, warn, error } = require('./_rule');
+// Inspired by https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+const { fixme, off, warn, error, concatESConfig } = require('./_rule');
 const { rules: _baseRules } = require('./base');
+const { rules: _baseImportRules } = require('./import');
 
-// Fix : TS pluging seems to modify the rules
-const baseRules = JSON.parse(JSON.stringify(_baseRules));
+// Fix Hack : TS pluging seems to modify the rules
+const deepClone = (/** @type {Record<string, unknown>} */ anyValue) => JSON.parse(JSON.stringify(anyValue));
+const baseRules = deepClone(_baseRules);
+const baseImportRules = deepClone(_baseImportRules);
 
 const duplicateTSC = off; // = "off because tsc already checks that"
 
-// https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
-const ruleDisabled = {
-  camelcase: off,
-  'constructor-super': off,
-  'dot-notation': off,
-  'getter-return': off,
-  'import/default': duplicateTSC,
-  'import/export': fixme(error), // https://github.com/benmosher/eslint-plugin-import/issues/1964
-  'import/named': duplicateTSC,
-  'import/namespace': duplicateTSC,
-  'import/no-named-as-default-member': duplicateTSC,
-  'import/no-unresolved': duplicateTSC,
-  'no-array-constructor': off,
-  'no-const-assign': off,
-  'no-dupe-args': off,
-  'no-dupe-class-members': off,
-  'no-dupe-keys': off,
-  'no-empty-function': off,
-  'no-func-assign': off,
-  'no-import-assign': off,
-  'no-inner-declarations': fixme(error), // https://github.com/typescript-eslint/typescript-eslint/issues/239
-  'no-new-symbol': off,
-  'no-obj-calls': off,
-  'no-redeclare': off,
-  'no-setter-return': off,
-  'no-shadow': off, // https://github.com/typescript-eslint/typescript-eslint/issues/2483
-  'no-this-before-super': off,
-  'no-undef': off,
-  'no-unreachable': off,
-  'no-unsafe-negation': off,
-  'no-unused-vars': off,
-  'no-use-before-define': off,
-  'no-useless-constructor': off,
-  'no-var': error,
-  'prefer-const': error,
-  'prefer-rest-params': error,
-  'prefer-spread': error,
-  'valid-typeof': off,
-};
-
-module.exports = {
-  extends: ['plugin:@typescript-eslint/recommended-requiring-type-checking'],
-  plugins: ['@typescript-eslint', 'import'],
-  rules: Object.assign(
-    {
+module.exports = concatESConfig(
+  /**
+   * Plugin rules
+   */
+  {
+    extends: ['plugin:@typescript-eslint/recommended-requiring-type-checking'],
+    plugins: ['@typescript-eslint', 'import'],
+    rules: {
       '@typescript-eslint/adjacent-overload-signatures': error,
       '@typescript-eslint/ban-ts-comment': [
         warn,
@@ -63,13 +31,29 @@ module.exports = {
         },
       ],
       '@typescript-eslint/ban-types': error,
+      '@typescript-eslint/brace-style': baseRules['brace-style'],
+      '@typescript-eslint/comma-dangle': [
+        baseRules['comma-dangle'][0],
+        {
+          ...baseRules['comma-dangle'][1],
+          enums: baseRules['comma-dangle'][1].arrays,
+          generics: baseRules['comma-dangle'][1].arrays,
+          tuples: baseRules['comma-dangle'][1].arrays,
+        },
+      ],
+      '@typescript-eslint/comma-spacing': baseRules['comma-spacing'],
       '@typescript-eslint/consistent-type-assertions': [
         error,
         { assertionStyle: 'as', objectLiteralTypeAssertions: 'never' },
       ],
+      '@typescript-eslint/default-param-last': baseRules['default-param-last'],
       '@typescript-eslint/dot-notation': baseRules['dot-notation'],
       '@typescript-eslint/explicit-function-return-type': off,
       '@typescript-eslint/explicit-module-boundary-types': off,
+      '@typescript-eslint/func-call-spacing': baseRules['func-call-spacing'],
+      '@typescript-eslint/indent': baseRules.indent,
+      '@typescript-eslint/keyword-spacing': baseRules['keyword-spacing'],
+      '@typescript-eslint/lines-between-class-members': baseRules['lines-between-class-members'],
       '@typescript-eslint/member-delimiter-style': error,
       '@typescript-eslint/naming-convention': [
         error,
@@ -96,28 +80,43 @@ module.exports = {
           selector: 'typeLike',
         },
       ],
-      '@typescript-eslint/no-array-constructor': error,
+      '@typescript-eslint/no-array-constructor': baseRules['no-array-constructor'],
       '@typescript-eslint/no-base-to-string': error,
+      '@typescript-eslint/no-dupe-class-members': baseRules['no-dupe-class-members'],
       '@typescript-eslint/no-empty-function': baseRules['no-empty-function'],
       '@typescript-eslint/no-empty-interface': [error, { allowSingleExtends: true }],
       '@typescript-eslint/no-explicit-any': off, // if any is explicit then it's wanted
+      '@typescript-eslint/no-extra-parens': baseRules['no-extra-parens'],
+      '@typescript-eslint/no-extra-semi': baseRules['no-extra-semi'],
       '@typescript-eslint/no-implicit-any-catch': error,
       '@typescript-eslint/no-inferrable-types': error,
+      '@typescript-eslint/no-loop-func': baseRules['no-loop-func'],
+      '@typescript-eslint/no-loss-of-precision': baseRules['no-loss-of-precision'],
+      '@typescript-eslint/no-magic-numbers': baseRules['no-magic-numbers'],
       '@typescript-eslint/no-misused-new': error,
       '@typescript-eslint/no-namespace': off, // We don't agree with community, namespaces are great and not deprecated
       '@typescript-eslint/no-non-null-assertion': error,
-      '@typescript-eslint/no-redeclare': fixme(error /* baseRules['no-redeclare'] */), // Error level so it is strongly discouraged
+      '@typescript-eslint/no-redeclare': fixme(baseRules['no-redeclare']),
       '@typescript-eslint/no-require-imports': error,
-      '@typescript-eslint/no-shadow': baseRules['no-shadow'], // Does not allow to declare type and const with same name
+      '@typescript-eslint/no-shadow': baseRules['no-shadow'],
       '@typescript-eslint/no-this-alias': error,
+      '@typescript-eslint/no-throw-literal': baseRules['no-throw-literal'],
       '@typescript-eslint/no-unnecessary-condition': error,
       '@typescript-eslint/no-unsafe-argument': error,
+      '@typescript-eslint/no-unused-expressions': baseRules['no-unused-expressions'],
       '@typescript-eslint/no-unused-vars': baseRules['no-unused-vars'],
       '@typescript-eslint/no-use-before-define': baseRules['no-use-before-define'],
       '@typescript-eslint/no-useless-constructor': baseRules['no-useless-constructor'],
       '@typescript-eslint/no-var-requires': error,
+      '@typescript-eslint/object-curly-spacing': baseRules['object-curly-spacing'],
       '@typescript-eslint/prefer-namespace-keyword': error,
       '@typescript-eslint/prefer-reduce-type-parameter': error,
+      '@typescript-eslint/quotes': baseRules.quotes,
+      '@typescript-eslint/require-await': baseRules['require-await'],
+      '@typescript-eslint/return-await': baseRules['no-return-await'],
+      '@typescript-eslint/semi': baseRules.semi,
+      '@typescript-eslint/space-before-function-paren': baseRules['space-before-function-paren'],
+      '@typescript-eslint/space-infix-ops': baseRules['space-infix-ops'],
       '@typescript-eslint/strict-boolean-expressions': [
         error,
         {
@@ -130,6 +129,106 @@ module.exports = {
       '@typescript-eslint/triple-slash-reference': error,
       '@typescript-eslint/type-annotation-spacing': error,
     },
-    ruleDisabled
-  ),
-};
+  },
+  /**
+   * Import overrides
+   */
+  {
+    rules: {
+      'import/extensions': [
+        baseImportRules['import/extensions'][0],
+        baseImportRules['import/extensions'][1],
+        {
+          ...baseImportRules['import/extensions'][2],
+          ts: 'never',
+          tsx: 'never',
+        },
+      ],
+      'import/no-extraneous-dependencies': [
+        baseImportRules['import/no-extraneous-dependencies'][0],
+        {
+          ...baseImportRules['import/no-extraneous-dependencies'][1],
+          devDependencies: baseImportRules['import/no-extraneous-dependencies'][1].devDependencies.reduce(
+            (/** @type {string[]} */ result, /** @type {string} */ devDep) => {
+              const toAppend = [devDep];
+              const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, 'ts$1');
+              if (devDepWithTs !== devDep) {
+                toAppend.push(devDepWithTs);
+              }
+              return [...result, ...toAppend];
+            },
+            []
+          ),
+        },
+      ],
+    },
+  },
+  /**
+   * Disabled rules
+   */
+  {
+    // https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#eslint-plugin-import
+    rules: {
+      'brace-style': off,
+      camelcase: off,
+      'comma-dangle': off,
+      'comma-spacing': off,
+      'constructor-super': off,
+      'default-param-last': off,
+      'dot-notation': off,
+      'func-call-spacing': off,
+      'getter-return': off,
+      'import/default': duplicateTSC,
+      'import/export': fixme(error), // https://github.com/benmosher/eslint-plugin-import/issues/1964
+      'import/named': duplicateTSC,
+      'import/namespace': duplicateTSC,
+      'import/no-named-as-default-member': duplicateTSC,
+      'import/no-unresolved': duplicateTSC,
+      indent: off,
+      'keyword-spacing': off,
+      'lines-between-class-members': off,
+      'no-array-constructor': off,
+      'no-const-assign': off,
+      'no-dupe-args': off,
+      'no-dupe-class-members': off,
+      'no-dupe-keys': off,
+      'no-empty-function': off,
+      'no-extra-parens': off,
+      'no-extra-semi': off,
+      'no-func-assign': off,
+      'no-implied-eval': off,
+      'no-import-assign': off,
+      'no-inner-declarations': fixme(error), // https://github.com/typescript-eslint/typescript-eslint/issues/239
+      'no-loop-func': off,
+      'no-loss-of-precision': off,
+      'no-magic-numbers': off,
+      'no-new-func': off,
+      'no-new-symbol': off,
+      'no-obj-calls': off,
+      'no-redeclare': off,
+      'no-return-await': off,
+      'no-setter-return': off,
+      'no-shadow': off,
+      'no-this-before-super': off,
+      'no-throw-literal': off,
+      'no-undef': off,
+      'no-unreachable': off,
+      'no-unsafe-negation': off,
+      'no-unused-expression': off,
+      'no-unused-vars': off,
+      'no-use-before-define': off,
+      'no-useless-constructor': off,
+      'no-var': error,
+      'object-curly-spacing': off,
+      'prefer-const': error,
+      'prefer-rest-params': error,
+      'prefer-spread': error,
+      quotes: off,
+      'require-await': off,
+      semi: off,
+      'space-before-function-paren': off,
+      'space-infix-ops': off,
+      'valid-typeof': off,
+    },
+  }
+);

package/rules/unicorn.js

@@ -1,18 +1,10 @@
-const { off, warn, error } = require('./_rule');
+const { off, warn, error, concatESConfig } = require('./_rule');
 
-const unsafeRules = {
-  'unicorn/consistent-destructuring': off,
-  'unicorn/no-array-for-each': off, // This rule could change browser compatibility
-  'unicorn/no-object-as-default-parameter': off,
-  'unicorn/prefer-default-parameters': off,
-  'unicorn/prevent-abbreviations': off, // This rule is so dangerous : it potentially break code while fixing in many cases !!
-};
-
-module.exports = {
-  extends: ['plugin:unicorn/recommended'],
-  plugins: ['unicorn'],
-  rules: Object.assign(
-    {
+module.exports = concatESConfig(
+  {
+    extends: ['plugin:unicorn/recommended'],
+    plugins: ['unicorn'],
+    rules: {
       'unicode-bom': [error, 'never'],
       'unicorn/better-regex': error,
       'unicorn/catch-error-name': [error, { name: error }],
@@ -53,6 +45,14 @@ module.exports = {
       'unicorn/prefer-type-error': error,
       'unicorn/throw-new-error': error,
     },
-    unsafeRules
-  ),
-};
+  },
+  {
+    rules: {
+      'unicorn/consistent-destructuring': off,
+      'unicorn/no-array-for-each': off, // This rule could change browser compatibility
+      'unicorn/no-object-as-default-parameter': off,
+      'unicorn/prefer-default-parameters': off,
+      'unicorn/prevent-abbreviations': off, // This rule is so dangerous : it potentially break code while fixing in many cases !!
+    },
+  }
+);

package/ts.js

@@ -14,4 +14,23 @@ module.exports = {
   parserOptions: {
     sourceType: 'module',
   },
+  settings: {
+    // Append 'ts' extensions to Airbnb 'import/extensions' setting
+    'import/extensions': ['.js', '.mjs', '.jsx', '.ts', '.tsx', '.d.ts'],
+
+    // Resolve type definition packages
+    'import/external-module-folders': ['node_modules', 'node_modules/@types'],
+
+    // Apply special parsing for TypeScript files
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx', '.d.ts'],
+    },
+
+    // Append 'ts' extensions to Airbnb 'import/resolver' setting
+    'import/resolver': {
+      node: {
+        extensions: ['.mjs', '.js', '.json', '.ts', '.d.ts'],
+      },
+    },
+  },
 };