prefer-node-protocol: Add checkRequire option (#1206)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: fisker

docs/rules/prefer-node-protocol.md

@@ -45,3 +45,21 @@ import _ from 'lodash';
 ```js
 import fs from './fs.js';
 ```
+
+## Options
+
+Type: `object`
+
+### `checkRequire`
+
+Type: `boolean`\
+Default: `false`
+
+Currently, `require(…)` with the `node:` protocol is only available on Node.js 16. If you don't care about old versions, you can set this to `true`.
+
+We'll remove this option and check `require(…)` by default once this feature get backported to v12.
+
+```js
+// eslint unicorn/prefer-node-protocol: ["error", {"checkRequire": true}]
+const fs = require('fs'); // Fails
+```

rules/prefer-node-protocol.js

@@ -7,14 +7,32 @@ const messages = {
 	[MESSAGE_ID]: 'Prefer `node:{{moduleName}}` over `{{moduleName}}`.'
 };
 
-const selector = [
+const importExportSelector = [
 	':matches(ImportDeclaration, ExportNamedDeclaration, ImportExpression)',
 	' > ',
 	'Literal.source'
 ].join('');
 
+const requireSelector = [
+	'CallExpression',
+	'[optional!=true]',
+	'[callee.type="Identifier"]',
+	'[callee.name="require"]',
+	'[arguments.length=1]',
+	' > ',
+	'Literal.arguments'
+].join('');
+
 /** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
+	const {checkRequire} = {
+		checkRequire: false,
+		...context.options[0]
+	};
+	const selector = checkRequire ?
+		`:matches(${importExportSelector}, ${requireSelector})` :
+		importExportSelector;
+
 	return {
 		[selector](node) {
 			const {value} = node;
@@ -38,6 +56,19 @@ const create = context => {
 	};
 };
 
+const schema = [
+	{
+		type: 'object',
+		properties: {
+			checkRequire: {
+				type: 'boolean',
+				default: false
+			}
+		},
+		additionalProperties: false
+	}
+];
+
 module.exports = {
 	create,
 	meta: {
@@ -47,7 +78,7 @@ module.exports = {
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',
-		schema: [],
+		schema,
 		messages
 	}
 };

test/prefer-node-protocol.mjs

@@ -60,6 +60,29 @@ test.snapshot({
 	]
 });
 
+// `options`
+const checkRequireOptions = [{checkRequire: true}];
+test.snapshot({
+	valid: [
+		'const fs = require("node:fs");',
+		'const fs = require("node:fs/promises");',
+		'const fs = require(fs);',
+		'const fs = notRequire("fs");',
+		'const fs = foo.require("fs");',
+		'const fs = require.resolve("fs");',
+		'const fs = require(`fs`);',
+		'const fs = require?.("fs");',
+		'const fs = require("fs", extra);',
+		'const fs = require();',
+		'const fs = require(...["fs"]);',
+		'const fs = require("unicorn");'
+	].map(code => ({code, options: checkRequireOptions})),
+	invalid: [
+		'const {promises} = require("fs")',
+		'const fs = require(\'fs/promises\')'
+	].map(code => ({code, options: checkRequireOptions}))
+});
+
 test.babel({
 	valid: [
 		'export fs from "node:fs";'

test/snapshots/prefer-node-protocol.mjs.md

@@ -251,3 +251,55 @@ Generated by [AVA](https://avajs.dev).
     > 1 | import "timers/promises";␊
         |        ^^^^^^^^^^^^^^^^^ Prefer \`node:timers/promises\` over \`timers/promises\`.␊
     `
+
+## Invalid #1
+      1 | const {promises} = require("fs")
+
+> Options
+
+    `␊
+    [␊
+      {␊
+        "checkRequire": true␊
+      }␊
+    ]␊
+    `
+
+> Output
+
+    `␊
+      1 | const {promises} = require("node:fs")␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | const {promises} = require("fs")␊
+        |                            ^^^^ Prefer \`node:fs\` over \`fs\`.␊
+    `
+
+## Invalid #2
+      1 | const fs = require('fs/promises')
+
+> Options
+
+    `␊
+    [␊
+      {␊
+        "checkRequire": true␊
+      }␊
+    ]␊
+    `
+
+> Output
+
+    `␊
+      1 | const fs = require('node:fs/promises')␊
+    `
+
+> Error 1/1
+
+    `␊
+    > 1 | const fs = require('fs/promises')␊
+        |                    ^^^^^^^^^^^^^ Prefer \`node:fs/promises\` over \`fs/promises\`.␊
+    `