@whitetrefoil/eslint-config 0.24.1 → 0.25.0

package/.eslintrc.js

@@ -1,7 +1,12 @@
 module.exports = {
+  root: true,
 
   extends: ['./node'],
 
+  parserOptions: {
+    sourceType: 'script',
+  },
+
   rules: {
     'no-magic-numbers': [
       1,

package/README.md

@@ -1,7 +1,8 @@
 My Personal Default ESLint Rules Settings
+=========================================
 
 Installation
-============
+------------
 
 Install below package (just pick needed)：
 ```sh
@@ -26,124 +27,53 @@ npm install --save-dev @whitetrefoil/eslint-config \
                        typescript
 ```
 
-Type Info
-=========
-
-TypeScript rules may need or not type info.
-The rules require type info are much slower than ones needn't,
-so they're better for single-time full scan or CI scan a little more.
-
-Using type info requires a `"tsconfig.eslint.json"` file in the root dir,
-which contains all files to lint, e.g.:
-```json
-{
-  "extends"        : "./tsconfig.json",
-  "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext"
-  },
-  "include"        : [
-    "**/*.tsx",
-    "**/*.ts",
-    "**/*.jsx",
-    "**/*.js"
-  ],
-  "exclude"        : [
-    "**/node_modules",
-    "**/.*",
-    "**/~*"
-  ]
-}
-```
+Example
+-------
 
-Rule Presets
-============
+```js
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+module.exports = {
+  root: true,
 
-Includes 7 presets can be used in `extends` in `eslintrc.xxx`:
-* `@whitetrefoil/eslint-config/presets/js` - Basic JS rules, disallow tailing semi;
-* `@whitetrefoil/eslint-config/presets/js/semi` - Same as above, excepts requiring tailing semi;
-* `@whitetrefoil/eslint-config/presets/node` - node.js rules;
-* `@whitetrefoil/eslint-config/presets/react` - React rules;
-* `@whitetrefoil/eslint-config/presets/ts` - TypeScript rules (needn't type info), disallow tailing semi;
-* `@whitetrefoil/eslint-config/presets/ts/semi` - Same as above, excepts requiring tailing semi;
-* `@whitetrefoil/eslint-config/presets/ts-with-type` - TypeScript rules require type info，append to `@whitetrefoil/eslint-config/presets/ts` if enabled;
-* `@whitetrefoil/eslint-config/presets/vue` - Vue2.x Rules;
-* `@whitetrefoil/eslint-config/presets/vue3` - Vue3.x Rules;
-
-Use 1 from 2 JS presets in the root `extends`.
-Pick what needed in the 5 detail presets for the `overrides` section.
-E.g.
-
-```json
-{
-  "root": true,
-  "settings": {
-    "react": {
-      "version": "detect"
-    }
-  },
-  "parserOptions": {
-    "sourceType"  : "module",
-    "ecmaFeatures": {
-      "legacyDecorators": true
-    }
+  // In case the project structure is too complex, try specify `tsconfigRootDir` to boost performance
+  parserOptions: {
+    tsconfigRootDir: __dirname,
   },
-  "env": {
-    "es6" : true,
-    "node": true
-  },
-  "extends": ["@whitetrefoil/eslint-config/preset/js"],
-  "overrides": [
-    {
-      "files": ["Gulpfile.js", "dev/**/*.ts", "stubapi/**/*.ts"],
-      "extends": ["@whitetrefoil/eslint-config/presets/node"]
-    },
-    {
-      "files": ["**/*.ts", "**/*.tsx"],
-      "extends": ["@whitetrefoil/eslint-config/presets/ts"]
-    },
-    {
-      "files": ["**/*.tsx"],
-      "extends": ["@whitetrefoil/eslint-config/presets/react"]
-    }
-  ]
+
+  extends: [
+    '@whitetrefoil/eslint-config/web-react',
+  ],
 }
 ```
 
+Project Level Presets
+---------------------
 
-Full Presets
-============
+Presets for usual project types:
+* `@whitetrefoil/eslint-config/web-react` - Web projects base on React (app or lib);
+* `@whitetrefoil/eslint-config/web-others` - Other web projects (app or lib);
+* `@whitetrefoil/eslint-config/node` - Node.js；
+* `@whitetrefoil/eslint-config/base` - Base of above, includes only basic JS & TS stuff;
 
-* `@whitetrefoil/eslint-config` - For general project, no semi;
-* `@whitetrefoil/eslint-config/semi` - For general project, with semi;
-* `@whitetrefoil/eslint-config/node` - For node.js project, no semi；
-* `@whitetrefoil/eslint-config/node-semi` - For node.js project, with semi；
-* `@whitetrefoil/eslint-config/react` - For react project, no semi;
-* `@whitetrefoil/eslint-config/react-semi` - For react project, with semi;
-* `@whitetrefoil/eslint-config/vue` - For Vue2.x project, no semi;
-* `@whitetrefoil/eslint-config/vue-semi` - For Vue2.x project, with semi;
-* `@whitetrefoil/eslint-config/vue3` - For Vue3.x project, no semi;
-* `@whitetrefoil/eslint-config/vue3-semi` - For Vue3.x project, with semi;
-
-Above 4 don't include rules require type info.
-The full ones locate in `/with-type` for full / CI scan:
-* `@whitetrefoil/eslint-config/with-type`
-* `@whitetrefoil/eslint-config/with-type/semi`
-* `@whitetrefoil/eslint-config/with-type/node`；
-* `@whitetrefoil/eslint-config/with-type/node-semi`；
-* `@whitetrefoil/eslint-config/with-type/react`
-* `@whitetrefoil/eslint-config/with-type/react-semi`
-* `@whitetrefoil/eslint-config/with-type/vue`；
-* `@whitetrefoil/eslint-config/with-type/vue-semi`；
-* `@whitetrefoil/eslint-config/with-type/vue3`；
-* `@whitetrefoil/eslint-config/with-type/vue3-semi`；
-
-Each preset contains nearly full settings includes `overrides`.
-The example in the above section is actually the `@whitetrefoil/eslint-config/react` preset.
+Rule Presets
+============
 
+Including some rule presets which will be helpful when constructing special config if the project type is unusual:
+* `@whitetrefoil/eslint-config/rules/base` - **Basic JS** rules (no tailing semi);
+* `@whitetrefoil/eslint-config/rules/base-semi` - **Basic JS** rules (w/ tailing semi);
+* `@whitetrefoil/eslint-config/rules/dependencies` - **`implicit-dependencies`** rules；
+* `@whitetrefoil/eslint-config/rules/node` - **Node.js** rules；
+* `@whitetrefoil/eslint-config/rules/react` - **React** rules；
+* `@whitetrefoil/eslint-config/rules/ts` - **`eslint-typescript`** rules no type info required (no tailing semi);
+* `@whitetrefoil/eslint-config/rules/ts-semi` - **`eslint-typescript`** rules no type info required (w/ tailing semi);
+* `@whitetrefoil/eslint-config/rules/ts-types` - **`eslint-typescript`** rules require type info;
+* `@whitetrefoil/eslint-config/rules/vue2` - **Vue 2.x** official rules;
+* `@whitetrefoil/eslint-config/rules/vue3` - **Vue 3.x** official rules;
 
 See Also
-========
+--------
 
 1. [ESLint Rules](https://eslint.org/docs/rules/)
 2. [ESLint Configuring](https://eslint.org/docs/user-guide/configuring)
@@ -154,11 +84,15 @@ See Also
 
 
 Changelog
-=========
+---------
+
+### v0.25.0
+
+* Totally refactored in order to simplify usage;
 
 ### v0.24.1
 
-* Disable `"prefer-object-has-own"` for TS due to TS hasn't support it yet.
+* Disable `"prefer-object-has-own"` for TS due to TS hasn't support it yet;
 
 ### v0.24.0
 

package/base.js

@@ -0,0 +1,40 @@
+module.exports = {
+  parserOptions: {
+    tsconfigRootDir: process.cwd(),
+    project        : [
+      '**/tsconfig.json',
+      '!**/node_modules/**',
+    ],
+    ecmaVersion    : 'latest',
+    sourceType     : 'module',
+    ecmaFeatures   : {
+      globalReturn : true,
+      impliedStrict: true,
+    },
+  },
+
+  env: {
+    es6   : true,
+    es2017: true,
+    es2020: true,
+    es2021: true,
+  },
+
+  extends: [
+    './rules/base',
+  ],
+
+  overrides: [
+    {
+      files  : [
+        '**/*.ts',
+        '**/*.tsx',
+      ],
+      parser : '@typescript-eslint/parser',
+      extends: [
+        './rules/ts',
+        './rules/ts-types',
+      ],
+    },
+  ],
+}

package/node.js

@@ -1,18 +1,56 @@
 module.exports = {
-
-  root: true,
-
   extends: [
-    './presets/js',
-    './presets/node',
+    './base',
   ],
 
   overrides: [
     {
-      files  : ['**/*.ts'],
+      files  : [
+        'src/**/*.ts',
+      ],
+      excludedFiles: [
+        'src/**/*.spec.ts',
+      ],
+      extends: [
+        './rules/dependencies',
+      ],
+    },
+
+    {
+      files: [
+        'src/**/*.spec.ts',
+        'tests/**/*.ts',
+      ],
+      env  : {
+        jest: true,
+      },
+    },
+
+    {
+      files  : [
+        '*.ts',
+        '*.cjs',
+        '*.js',
+        'dev/*.ts',
+        'dev/*.cjs',
+        'dev/*.js',
+        'scripts/*.ts',
+        'scripts/*.cjs',
+        'scripts/*.js',
+        'stubapi/*.ts',
+        'stubapi/*.cjs',
+        'stubapi/*.js',
+      ],
       extends: [
-        './presets/ts',
+        './rules/node',
       ],
+      env    : {
+        node: true,
+      },
+      rules  : {
+        'no-console'          : [0],
+        'node/no-process-exit': [0],
+      },
     },
   ],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whitetrefoil/eslint-config",
-  "version": "0.24.1",
+  "version": "0.25.0",
   "author": "WhiteTrefoil <whitetrefoil@gmail.com>",
   "license": "Unlicense",
   "engines": {
@@ -8,8 +8,7 @@
   },
   "files": [
     "*.js",
-    "presets",
-    "with-type"
+    "rules"
   ],
   "dependencies": {
     "eslint": "^8.5.0",

package/{presets/js/semi.js → rules/base-semi.js}

@@ -1,7 +1,6 @@
 module.exports = {
-
   extends: [
-    './index',
+    './base',
   ],
 
   rules: {

package/{presets/js/index.js → rules/base.js}

@@ -2,25 +2,6 @@
 // @see https://github.com/eslint/eslint/releases
 
 module.exports = {
-
-  plugins: [
-    'implicit-dependencies',
-  ],
-
-  parserOptions: {
-    sourceType: 'module',
-    // eslint-disable-next-line no-magic-numbers
-    ecmaVersion : 2021,
-    ecmaFeatures: {
-      legacyDecorators: true,
-      impliedStrict   : true,
-    },
-  },
-
-  env: {
-    es6: true,
-  },
-
   extends: [
     'eslint:recommended',
   ],
@@ -150,7 +131,7 @@ module.exports = {
     'no-implicit-coercion'          : [1],
     'no-implicit-globals'           : [2],
     'no-implied-eval'               : [2],
-    'no-inline-comments'            : [2],
+    'no-inline-comments'            : [0],
     'no-invalid-this'               : [2],
     'no-iterator'                   : [2],
     'no-label-var'                  : [2],

package/rules/dependencies.js

@@ -0,0 +1,9 @@
+module.exports = {
+  plugins: [
+    'implicit-dependencies',
+  ],
+
+  rules: {
+    'implicit-dependencies/no-implicit': [2, { peer: true, optional: true }],
+  },
+}

package/{presets/node/index.js → rules/node.js}

@@ -2,20 +2,13 @@
 // @see https://github.com/mysticatea/eslint-plugin-node/releases
 
 module.exports = {
-
   plugins: ['node'],
 
-  env: {
-    es6 : true,
-    node: true,
-  },
-
   extends: [
     'plugin:node/recommended',
   ],
 
   rules: {
-
     // eslint-plugin-node
     // ------------------
     'node/handle-callback-err'                  : [1],
@@ -37,9 +30,9 @@ module.exports = {
     'node/process-exit-as-throw'                : [2],
     'node/shebang'                              : [2],
 
-    'node/no-deprecated-api': [2],
+    'node/no-deprecated-api': [0],
 
-    'node/callback-return'                : [1],
+    'node/callback-return'                : [0],
     'node/exports-style'                  : [2],
     'node/file-extension-in-import'       : [0],
     'node/global-require'                 : [1],

package/{presets/react/index.js → rules/react.js}

@@ -2,16 +2,6 @@
 // @see https://github.com/yannickcr/eslint-plugin-react/blob/master/CHANGELOG.md
 
 module.exports = {
-  settings: {
-    react: {
-      version: 'detect',
-    },
-  },
-
-  parserOptions: {
-    jsx: true,
-  },
-
   plugins: [
     'react',
     'react-hooks',

package/{presets/ts/semi.js → rules/ts-semi.js}

@@ -1,7 +1,6 @@
 module.exports = {
-
   extends: [
-    './index',
+    './ts',
   ],
 
   rules: {

package/{presets/ts-with-type/index.js → rules/ts-types.js}

@@ -4,6 +4,8 @@
 // These are rules need type info which will be much slower
 
 module.exports = {
+  plugins: ['@typescript-eslint'],
+
   rules: {
     '@typescript-eslint/await-thenable'                        : [1],
     '@typescript-eslint/consistent-type-exports'               : [1],

package/{presets/ts/index.js → rules/ts.js}

@@ -4,17 +4,6 @@
 // These are rules don't need type info
 
 module.exports = {
-
-  parser: '@typescript-eslint/parser',
-
-  parserOptions: {
-    parser: '@typescript-eslint/parser',
-  },
-
-  env: {
-    es6: true,
-  },
-
   plugins: ['@typescript-eslint'],
 
   extends: [

package/{presets/vue/index.js → rules/vue2.js}

@@ -2,7 +2,6 @@
 // @see https://eslint.vuejs.org/user-guide/
 
 module.exports = {
-
   parser: 'vue-eslint-parser',
 
   extends: [

package/{presets/vue3/index.js → rules/vue3.js}

@@ -2,7 +2,6 @@
 // @see https://eslint.vuejs.org/user-guide/
 
 module.exports = {
-
   parser: 'vue-eslint-parser',
 
   extends: [

package/web-others.js

@@ -0,0 +1,90 @@
+module.exports = {
+  parserOptions: {
+    tsconfigRootDir: process.cwd(),
+    project        : [
+      '**/tsconfig.json',
+      '!**/node_modules/**',
+    ],
+    ecmaVersion    : 'latest',
+    sourceType     : 'module',
+    ecmaFeatures   : {
+      globalReturn : true,
+      impliedStrict: true,
+    },
+  },
+
+  env: {
+    es6   : true,
+    es2017: true,
+    es2020: true,
+    es2021: true,
+  },
+
+  extends: [
+    './rules/base',
+  ],
+
+  overrides: [
+    {
+      files  : [
+        '**/*.ts',
+        '**/*.tsx',
+      ],
+      parser : '@typescript-eslint/parser',
+      extends: [
+        './rules/ts',
+        './rules/ts-types',
+      ],
+    },
+
+    {
+      files  : [
+        'src/**/*.ts',
+        'src/**/*.tsx',
+      ],
+      excludedFiles: [
+        'src/**/*.spec.ts',
+      ],
+      extends: [
+        './rules/dependencies',
+      ],
+    },
+
+    {
+      files: [
+        'src/**/*.spec.ts',
+        'tests/**/*.ts',
+      ],
+      env  : {
+        jest: true,
+      },
+    },
+
+    {
+      files  : [
+        '*.ts',
+        '*.cjs',
+        '*.js',
+        'dev/*.ts',
+        'dev/*.cjs',
+        'dev/*.js',
+        'scripts/*.ts',
+        'scripts/*.cjs',
+        'scripts/*.js',
+        'stubapi/*.ts',
+        'stubapi/*.cjs',
+        'stubapi/*.js',
+      ],
+      extends: [
+        './rules/node',
+      ],
+      env    : {
+        node: true,
+      },
+      rules  : {
+        'no-console'          : [0],
+        'node/no-process-exit': [0],
+      },
+    },
+  ],
+}

package/web-react.js

@@ -0,0 +1,97 @@
+module.exports = {
+  parserOptions: {
+    tsconfigRootDir: process.cwd(),
+    project        : [
+      '**/tsconfig.json',
+      '!**/node_modules/**',
+    ],
+    ecmaVersion    : 'latest',
+    sourceType     : 'module',
+    ecmaFeatures   : {
+      globalReturn : true,
+      impliedStrict: true,
+    },
+  },
+
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+
+  env: {
+    es6   : true,
+    es2017: true,
+    es2020: true,
+    es2021: true,
+  },
+
+  extends: [
+    './rules/base',
+  ],
+
+  overrides: [
+    {
+      files  : [
+        '**/*.ts',
+        '**/*.tsx',
+      ],
+      parser : '@typescript-eslint/parser',
+      extends: [
+        './rules/ts',
+        './rules/ts-types',
+      ],
+    },
+
+    {
+      files  : [
+        'src/**/*.ts',
+        'src/**/*.tsx',
+      ],
+      excludedFiles: [
+        'src/**/*.spec.ts',
+      ],
+      extends: [
+        './rules/react',
+        './rules/dependencies',
+      ],
+    },
+
+    {
+      files: [
+        'src/**/*.spec.ts',
+        'tests/**/*.ts',
+      ],
+      env  : {
+        jest: true,
+      },
+    },
+
+    {
+      files  : [
+        '*.ts',
+        '*.cjs',
+        '*.js',
+        'dev/*.ts',
+        'dev/*.cjs',
+        'dev/*.js',
+        'scripts/*.ts',
+        'scripts/*.cjs',
+        'scripts/*.js',
+        'stubapi/*.ts',
+        'stubapi/*.cjs',
+        'stubapi/*.js',
+      ],
+      extends: [
+        './rules/node',
+      ],
+      env    : {
+        node: true,
+      },
+      rules  : {
+        'no-console'          : [0],
+        'node/no-process-exit': [0],
+      },
+    },
+  ],
+}