feat: 修改 rules/node 中已被 eslint 废弃的 node rules，引入 eslint-plugin-node 及自定规则 (#57)

* fix(node): 修改已被 eslint 废弃的 node rules，增加 eslint-plugin-node 及自定规则
* style(node): 修改代码格式
* fix: 关闭 prefer-global 对不常用变量的限制

Co-authored-by: 年翼 <nianyi.zxy@alibaba-inc.com>

Author: zhaoxingyue

lib/rules/node.js

@@ -4,66 +4,230 @@ module.exports = {
   env: {
     node: true,
   },
-
+  plugins: [
+    'node',
+  ],
   rules: {
     /**
-     * not enforce return after a callback
-     * @see http://eslint.org/docs/rules/callback-return
+     * disallow new operators with calls to require
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-new-require.md
+     */
+    'node/no-new-require': 'error',
+
+    /**
+     * enforce either Buffer or require("buffer").Buffer
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/buffer.md
+     */
+    'node/prefer-global/buffer': [ 'error', 'always' ],
+
+    /**
+     * enforce either console or require("console")
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/console.md
+     */
+    'node/prefer-global/console': [ 'error', 'always' ],
+
+    /**
+     * enforce either process or require("process")
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/process.md
+     */
+    'node/prefer-global/process': [ 'error', 'always' ],
+
+    /**
+     * enforce either TextDecoder or require("util").TextDecoder
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/text-decoder.md
+     */
+    'node/prefer-global/text-decoder': 'off',
+
+    /**
+     * enforce either TextEncoder or require("util").TextEncoder
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/text-encoder.md
+     */
+    'node/prefer-global/text-encoder': 'off',
+
+    /**
+     * enforce either URLSearchParams or require("url").URLSearchParams
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/url-search-params.md
+     */
+    'node/prefer-global/url-search-params': 'off',
+
+    /**
+     * enforce either URL or require("url").URL
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-global/url.md
+     */
+    'node/prefer-global/url': 'off',
+
+    /**
+     * enforce require("dns").promises
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-promises/dns.md
+     */
+    'node/prefer-promises/dns': 'warn',
+
+    /**
+     * enforce require("fs").promises
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/prefer-promises/fs.md
+     */
+    'node/prefer-promises/fs': 'warn',
+
+    /**
+     * disallow import declarations which import private modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-import.md
+     */
+    'node/no-unpublished-import': 'off',
+
+    /**
+     * disallow unsupported ECMAScript built-ins on the specified version
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-builtins.md
+     */
+    'node/no-unsupported-features/es-builtins': 'off',
+
+    /**
+     * suggest correct usage of shebang
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/shebang.md
+     */
+    'node/shebang': 'off',
+
+    /**
+     * disallow unsupported ECMAScript syntax on the specified version
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/es-syntax.md
+     */
+    'node/no-unsupported-features/es-syntax': 'off',
+
+    /**
+     * disallow unsupported Node.js built-in APIs on the specified version
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unsupported-features/node-builtins.md
+     */
+    'node/no-unsupported-features/node-builtins': 'off',
+
+    /**
+     * make process.exit() expressions the same code path as throw
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/process-exit-as-throw.md
+     */
+    'node/process-exit-as-throw': 'off',
+
+    /**
+     * disallow deprecated APIs
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-deprecated-api.md
+     */
+    'node/no-deprecated-api': 'off',
+
+    /**
+     * require error handling in callbacks
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/handle-callback-err.md
+     */
+    'node/handle-callback-err': 'off',
+
+    /**
+     * ensure Node.js-style error-first callback pattern is followed
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-callback-literal.md
+     */
+    'node/no-callback-literal': 'off',
+
+    /**
+     * disallow the assignment to exports
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-exports-assign.md
+     */
+    'node/no-exports-assign': 'off',
+
+    /**
+     * disallow import declarations which import extraneous modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-extraneous-import.md
+     */
+    'node/no-extraneous-import': 'off',
+
+    /**
+     * disallow require() expressions which import extraneous modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-extraneous-require.md
+     */
+    'node/no-extraneous-require': 'off',
+
+    /**
+     * disallow import declarations which import non-existence modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-missing-import.md
+     */
+    'node/no-missing-import': 'off',
+
+    /**
+     * disallow require() expressions which import non-existence modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-missing-require.md
+     */
+    'node/no-missing-require': 'off',
+
+    /**
+     * disallow string concatenation with __dirname and __filename
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-path-concat.md
+     */
+    'node/no-path-concat': 'off',
+
+    /**
+     * disallow the use of process.exit()
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-exit.md
+     */
+    'node/no-process-exit': 'off',
+
+    /**
+     * disallow bin files that npm ignores
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-bin.md
+     */
+    'node/no-unpublished-bin': 'off',
+
+    /**
+     * disallow require() expressions which import private modules
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-unpublished-require.md
      */
-    'callback-return': 'off',
+    'node/no-unpublished-require': 'off',
 
     /**
-     * not require all requires be top-level
-     * @see http://eslint.org/docs/rules/global-require
+     * require return statements after callbacks
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/callback-return.md
      */
-    'global-require': 'off',
+    'node/callback-return': 'off',
 
     /**
-     * not enforces error handling in callbacks (node environment)
-     * @see http://eslint.org/docs/rules/handle-callback-err
+     * enforce the style of file extensions in import declarations
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md
      */
-    'handle-callback-err': 'off',
+    'node/file-extension-in-import': 'off',
 
     /**
-     * allow mixing regular variable and require declarations
-     * @see http://eslint.org/docs/rules/no-mixed-requires
+     * equire require() calls to be placed at top-level module scope
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/global-require.md
      */
-    'no-mixed-requires': 'off',
+    'node/global-require': 'off',
 
     /**
-     * allow use of new operator with the require function
-     * @see http://eslint.org/docs/rules/no-new-require
+     * disallow require calls to be mixed with regular variable declarations
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-mixed-requires.md
      */
-    'no-new-require': 'off',
+    'node/no-mixed-requires': 'off',
 
     /**
-     * allow string concatenation with __dirname and __filename
-     * @see http://eslint.org/docs/rules/no-path-concat
+     * disallow the use of process.env
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-process-env.md
      */
-    'no-path-concat': 'off',
+    'node/no-process-env': 'off',
 
     /**
-     * allow use of process.env
-     * @see http://eslint.org/docs/rules/no-process-env
+     * disallow specified modules when loaded by import declarations
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-import.md
      */
-    'no-process-env': 'off',
+    'node/no-restricted-import': 'off',
 
     /**
-     * allow process.exit()
-     * @see http://eslint.org/docs/rules/no-process-exit
+     * disallow specified modules when loaded by require
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-restricted-require.md
      */
-    'no-process-exit': 'off',
+    'node/no-restricted-require': 'off',
 
     /**
-     * not restrict usage of specified node modules
-     * @see http://eslint.org/docs/rules/no-restricted-modules
+     * disallow synchronous methods
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/no-sync.md
      */
-    'no-restricted-modules': 'off',
+    'node/no-sync': 'off',
 
     /**
-     * allow use of synchronous methods
-     * @see http://eslint.org/docs/rules/no-sync
+     * enforce either module.exports or exports
+     * @see https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/exports-style.md
      */
-    'no-sync': 'off',
+    'node/exports-style': 'off',
   },
 };

package.json

@@ -19,6 +19,7 @@
     "eslint-plugin-import": "^2.14.0",
     "eslint-plugin-jsdoc": "^4.1.1",
     "eslint-plugin-jsx-a11y": "^6.1.1",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-react": "^7.11.1"
   },
   "devDependencies": {

test/fixtures/node-app/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../index.js"
+}

test/fixtures/node-app/no-new-require-fail.js

@@ -0,0 +1,4 @@
+'use strict';
+
+const fs = new require('fs');
+console.log(fs);

test/fixtures/node-app/no-new-require.js

@@ -0,0 +1,4 @@
+'use strict';
+
+const fs = require('fs');
+console.log(fs);

test/fixtures/node-app/prefer-global-fail.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const { Buffer } = require('buffer');
+Buffer.alloc(16);
+
+const console = require('console');
+console.log('hello');
+
+const process = require('process');
+process.exit(0);
+
+const { TextDecoder } = require('util');
+new TextDecoder();
+
+const { TextEncoder } = require('util');
+new TextEncoder()
+
+const { URLSearchParams } = require('url');
+new URLSearchParams();
+
+const { URL } = require('url');
+new URL();

test/fixtures/node-app/prefer-global.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Buffer.alloc(16);
+console.log('hello');
+new TextDecoder();
+new TextEncoder();
+new URLSearchParams();
+new URL();
+process.exit(0);

test/fixtures/node-app/prefer-promises-fail.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const dns = require('dns');
+const fs = require('fs');
+
+() => {
+  fs.readFile('./.eslintrc', 'utf8', (error, content) => {
+    console.log(error, content);
+  });
+};
+
+hostname => {
+  dns.lookup(hostname, (error, address, family) => {
+    console.log(error, address, family);
+  });
+};

test/fixtures/node-app/prefer-promises.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const { promises: dns } = require('dns');
+const { promises: fs } = require('fs');
+
+const readFile = async filePath => {
+  const content = await fs.readFile(filePath, 'utf8');
+  console.log(content);
+};
+readFile();
+
+const lookup = async hostname => {
+  const { address, family } = await dns.lookup(hostname);
+  console.log(address, family);
+};
+lookup();

test/node.test.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const path = require('path');
+const coffee = require('coffee');
+
+describe('test/node.test.js', () => {
+  const cwd = path.join(__dirname, 'fixtures/node-app');
+
+  describe('no-new-require', () => {
+    it('should success', () => {
+      return coffee.spawn('eslint', [ 'no-new-require.js' ], { cwd })
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should fail with new require', () => {
+      return coffee.spawn('eslint', [ 'no-new-require-fail.js' ], { cwd })
+        .expect('stdout', /no-new-require/)
+        .expect('code', 1)
+        .end();
+    });
+  });
+
+  describe('prefer-promises', () => {
+    it('should success', () => {
+      return coffee.spawn('eslint', [ 'prefer-promises.js' ], { cwd })
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should fail with unused promises', () => {
+      return coffee.spawn('eslint', [ 'prefer-promises-fail.js' ], { cwd })
+        .expect('stdout', /node\/prefer-promises\/fs/)
+        .expect('stdout', /node\/prefer-promises\/dns/)
+        .expect('code', 0)
+        .end();
+    });
+  });
+
+  describe('prefer-global', () => {
+    it('should success', () => {
+      return coffee.spawn('eslint', [ 'prefer-global.js' ], { cwd })
+        .expect('code', 0)
+        .end();
+    });
+
+    it('should fail with unused the global variable', () => {
+      return coffee.spawn('eslint', [ 'prefer-global-fail.js' ], { cwd })
+        .expect('stdout', /prefer-global\/buffer/)
+        .expect('stdout', /prefer-global\/console/)
+        .expect('stdout', /prefer-global\/process/)
+        .expect('code', 1)
+        .end();
+    });
+  });
+});