feat: add eslint-plugin-node 💪

Author: robertrossmann

environments/nodejs/recommended.js

@@ -23,6 +23,10 @@ module.exports = {
     node: true,
   },
 
+  plugins: [
+    'node',
+  ],
+
   rules: {
     // Enforce `require()` on the top-level module scope
     // It's arguably harder to identify dependencies when they are deeply nested inside of functions
@@ -67,6 +71,40 @@ module.exports = {
     'no-sync': ['warn', {
       allowAtRootLevel: true,
     }],
+
+    // Disallow unsupported ECMAScript features on the specified version
+    // This rule reports unsupported ECMAScript built-in variables on the configured Node.js version
+    // as lint errors. This rule reads the engines field of package.json to detect which Node.js
+    // versions your module is supporting.
+    'node/no-unsupported-features/es-builtins': 'error',
+
+    // Disallow unsupported ECMAScript syntax on the specified version
+    // This rule reports unsupported ECMAScript syntax on the configured Node.js version as lint
+    // errors. This rule reads the engines field of package.json to detect which Node.js versions
+    // your module is supporting.
+    'node/no-unsupported-features/es-syntax': 'error',
+
+    // Disallow unsupported Node.js built-in APIs on the specified version
+    // This rule reports unsupported Node.js built-in APIs on the configured Node.js version as lint
+    // errors. This rule reads the engines field of package.json to detect which Node.js versions
+    // your module is supporting.
+    'node/no-unsupported-features/node-builtins': 'error',
+
+    // Treat process.exit() the same code path as throw
+    // If you turn this rule on, ESLint comes to address process.exit() as throw in code path
+    // analysis.
+    'node/process-exit-as-throw': 'error',
+
+    // Suggest correct usage of shebang
+    // This rule checks bin field of package.json, then if a target file matches one of bin files,
+    // it checks whether or not there is a correct shebang. Otherwise it checks whether or not there
+    // is not a shebang.
+    'node/shebang': 'warn',
+
+    // Disallow deprecated API
+    // Node has many deprecated API. The community is going to remove those API from Node in future,
+    // so we should not use those.
+    'node/no-deprecated-api': 'warn',
   },
 
   overrides: [{

package-lock.json

@@ -19,6 +19,7 @@
     "eslint-plugin-import": "^2.14.0",
     "eslint-plugin-jsx-a11y": "^6.1.2",
     "eslint-plugin-mocha": "^5.2.0",
+    "eslint-plugin-node": "^8.0.0",
     "eslint-plugin-react": "^7.11.1"
   },
   "devDependencies": {

package.json

@@ -251,5 +251,41 @@ module.exports = {
     // Disallow the use of type aliases
     // Unused, type aliases seem useful.
     'typescript/no-type-alias': 0,
+
+    // Disallow import declarations which import extraneous modules
+    // Unused, already implemented using eslint-plugin-import
+    'node/no-extraneous-import': 0,
+
+    // Disallow require declarations which require extraneous modules
+    // Unused, already implemented using eslint-plugin-import
+    'node/no-extraneous-require': 0,
+
+    // Disallow import, export and require declarations for files that don't exist
+    // Unused, already implemented using eslint-plugin-import
+    'node/no-missing-import': 0,
+    'node/no-missing-require': 0,
+
+    // disallow 'bin' files that npm ignores
+    // Unused, not very useful and the rule does not work well with compiled files (JSX, Babel etc.)
+    'node/no-unpublished-bin': 0,
+
+    // Disallow import/require declarations which import unpublished files/modules
+    // Unused, already implemented using eslint-plugin-import
+    'node/no-unpublished-import': 0,
+    'node/no-unpublished-require': 0,
+
+    // enforce either module.exports or exports
+    // Unused, implemented in eslint-plugin-import/group-exports
+    'node/exports-style': 0,
+
+    // Prefer global variants of these core modules
+    // Unused, already being handled by `no-shadow` rule in combination with env: node: true
+    'node/prefer-global/buffer': 0,
+    'node/prefer-global/console': 0,
+    'node/prefer-global/process': 0,
+    'node/prefer-global/text-decoder': 0,
+    'node/prefer-global/text-encoder': 0,
+    'node/prefer-global/url-search-params': 0,
+    'node/prefer-global/url': 0,
   },
 }