@foray1010/eslint-config 7.6.1 → 7.7.1

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.7.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.7.0...@foray1010/eslint-config@7.7.1) (2022-10-01)
+
+### Bug Fixes
+
+- **eslint-config:** allow commonjs globals as we haven't moved to es modules ([08ab8d0](https://github.com/foray1010/common-presets/commit/08ab8d09244e2314de611a4fb1fda8552a958515))
+- **eslint-config:** allow webextensions globals in frontend ([7624ed5](https://github.com/foray1010/common-presets/commit/7624ed5f5e2c710a5d1abbb831b476190aca32d5))
+
+## [7.7.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.6.1...@foray1010/eslint-config@7.7.0) (2022-10-01)
+
+### Features
+
+- **eslint-config:** do not allow node.js modules in frontend ([972f434](https://github.com/foray1010/common-presets/commit/972f434064891238cfc71db5379ac77be8f5e10d))
+- **eslint-config:** do not allow unknown global variables ([a62994e](https://github.com/foray1010/common-presets/commit/a62994e1aeee48202a03484ec1772a4016f86d93))
+
+### Bug Fixes
+
+- **eslint-config:** better error description when using global Buffer or process ([00e14ee](https://github.com/foray1010/common-presets/commit/00e14ee9c2f0afab8ebe78ecc89c3ab79b8a93f0))
+- **eslint-config:** skip nodejs related rules for react ([a7b12d7](https://github.com/foray1010/common-presets/commit/a7b12d7d0d428189ead3ecce7f4a59ae87c72536))
+
 ## [7.6.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@7.6.0...@foray1010/eslint-config@7.6.1) (2022-09-30)
 
 ### Bug Fixes

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "7.6.1",
+  "version": "7.7.1",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2db2510ae90fd5b609aaad1e8c41934d29e310b7"
+  "gitHead": "ecc4d8bbdfe9a51e4c6214723f029978a777a37e"
 }

package/presets/base.js

@@ -13,14 +13,31 @@ const cjsConfig = {
   env: {
     commonjs: true,
   },
+  rules: {
+    // commonjs must use strict mode
+    strict: ['error', 'global'],
+  },
 }
 
 /** @type {import('eslint').Linter.BaseConfig} */
-const esmConfigForJs = {
+const esmConfig = {
   parserOptions: {
     sourceType: 'module',
   },
+  plugins: ['eslint-plugin-simple-import-sort'],
   rules: {
+    // auto sort export statements
+    'simple-import-sort/exports': 'error',
+    // auto sort import statements
+    'simple-import-sort/imports': 'error',
+  },
+}
+
+/** @type {import('eslint').Linter.BaseConfig} */
+const esmConfigForJs = {
+  ...esmConfig,
+  rules: {
+    ...esmConfig.rules,
     'import/extensions': [
       'error',
       // https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_mandatory_file_extensions
@@ -47,7 +64,6 @@ module.exports = {
     'eslint-plugin-import',
     'eslint-plugin-jsdoc',
     'eslint-plugin-prettier',
-    'eslint-plugin-simple-import-sort',
   ],
   env: {
     // should align with parserOptions.ecmaVersion
@@ -110,12 +126,6 @@ module.exports = {
     'jsdoc/valid-types': 'off',
     // avoid assigning anonymous function to object key which is harder to trace when debug
     'object-shorthand': ['error', 'always'],
-    // auto sort export statements
-    'simple-import-sort/exports': 'error',
-    // auto sort import statements
-    'simple-import-sort/imports': 'error',
-    // commonjs must use strict mode
-    strict: ['error', 'global'],
   },
   overrides: [
     {
@@ -142,6 +152,10 @@ module.exports = {
     // typescript plugins are depended on `typescript` package
     ...(hasDep('typescript')
       ? [
+          {
+            files: ['*.{cts,mts,ts,tsx}'],
+            ...esmConfig,
+          },
           {
             files: ['*.{cts,mts,ts,tsx}'],
             extends: [
@@ -158,12 +172,15 @@ module.exports = {
               // turned off because @typescript-eslint/no-unsafe-* rules will output wrong errors
               // allowAutomaticSingleRunInference: true,
               project: ['./tsconfig*.json', './packages/*/tsconfig*.json'],
-              sourceType: 'module',
             },
             plugins: [
               '@typescript-eslint/eslint-plugin',
               'eslint-plugin-functional',
             ],
+            env: {
+              // allow commonjs globals as we haven't moved to es modules
+              commonjs: true,
+            },
             rules: {
               // extend existing rule
               '@typescript-eslint/ban-types': [
@@ -257,6 +274,9 @@ module.exports = {
               // forbid unnecessary callback wrapper
               // disabled due to https://github.com/eslint-functional/eslint-plugin-functional/issues/486
               // 'functional/prefer-tacit': 'error',
+              // @typescript-eslint/eslint-plugin suggests to disable it: https://github.com/typescript-eslint/typescript-eslint/blob/2588e9ea55f78352fdd6ae92a306135aabb49a1a/docs/linting/TROUBLESHOOTING.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+              // It is disabled in recommended config but re-enabled here to enforce a subset of global variables that supported by both node.js and browsers
+              'no-undef': 'error',
             },
             overrides: [
               {

package/presets/browser.js

@@ -8,6 +8,7 @@ module.exports = {
   plugins: ['eslint-plugin-compat'],
   env: {
     browser: true,
+    webextensions: true,
   },
   globals: {
     // keep it until webpack has an official way to define env: https://github.com/webpack/webpack/issues/15833
@@ -15,5 +16,7 @@ module.exports = {
   },
   rules: {
     'no-restricted-globals': ['error', ...restrictedGlobals],
+    // frontend environment doesn't support node.js modules
+    'import/no-nodejs-modules': 'error',
   },
 }

package/presets/node.js

@@ -3,6 +3,12 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
   plugins: ['eslint-plugin-n'],
+  globals: {
+    // hack to mute no-undef error, and show n/prefer-global/buffer error instead
+    Buffer: 'readonly',
+    // hack to mute no-undef error, and show n/prefer-global/process error instead
+    process: 'readonly',
+  },
   rules: {
     // disallow deprecated node APIs
     'n/no-deprecated-api': 'error',
@@ -12,6 +18,10 @@ module.exports = {
     'n/no-unpublished-bin': 'error',
     // disallow unsupported Node.js built-in APIs on the specified version
     'n/no-unsupported-features/node-builtins': 'error',
+    // prefer `import { Buffer } from 'node:buffer'`
+    'n/prefer-global/buffer': ['error', 'never'],
+    // prefer `import process from 'node:process'`
+    'n/prefer-global/process': ['error', 'never'],
     // make `process.exit()` expressions the same code path as `throw`
     'n/process-exit-as-throw': 'error',
     // enforce shebang on the entry bin file

package/react.js

@@ -1,10 +1,5 @@
 'use strict'
 
 module.exports = {
-  extends: [
-    './presets/base.js',
-    './presets/node.js',
-    './presets/browser.js',
-    './presets/react.js',
-  ],
+  extends: ['./presets/base.js', './presets/browser.js', './presets/react.js'],
 }