feat: add prefer-global/crypto rule (#514)

Author: Pixel998

README.md

@@ -165,6 +165,7 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
 | [no-unsupported-features/node-builtins](docs/rules/no-unsupported-features/node-builtins.md) | disallow unsupported Node.js built-in APIs on the specified version         | 🟢 ✅ |    |    |
 | [prefer-global/buffer](docs/rules/prefer-global/buffer.md)                                   | enforce either `Buffer` or `require("buffer").Buffer`                       |      |    |    |
 | [prefer-global/console](docs/rules/prefer-global/console.md)                                 | enforce either `console` or `require("console")`                            |      |    |    |
+| [prefer-global/crypto](docs/rules/prefer-global/crypto.md)                                   | enforce either `crypto` or `require("crypto").webcrypto`                    |      |    |    |
 | [prefer-global/process](docs/rules/prefer-global/process.md)                                 | enforce either `process` or `require("process")`                            |      |    |    |
 | [prefer-global/text-decoder](docs/rules/prefer-global/text-decoder.md)                       | enforce either `TextDecoder` or `require("util").TextDecoder`               |      |    |    |
 | [prefer-global/text-encoder](docs/rules/prefer-global/text-encoder.md)                       | enforce either `TextEncoder` or `require("util").TextEncoder`               |      |    |    |

docs/rules/prefer-global/crypto.md

@@ -0,0 +1,71 @@
+# Enforce either `crypto` or `require("crypto").webcrypto` (`n/prefer-global/crypto`)
+
+<!-- end auto-generated rule header -->
+
+An implementation of the Web Crypto API is defined as a global variable.
+
+```js
+console.log(crypto === require("node:crypto").webcrypto) //→ true
+```
+
+It will be readable if we use `crypto` consistently.
+
+## 📖 Rule Details
+
+This rule enforces whether to use the global `crypto` variable or the `webcrypto` property from the `crypto` module.
+
+### Options
+
+This rule has a string option.
+
+```json
+{
+    "n/prefer-global/crypto": ["error", "always" | "never"]
+}
+```
+
+- `"always"` (default) ... enforces to use the global variable `crypto` rather than `require("crypto").webcrypto`.
+- `"never"` ... enforces to use `require("crypto").webcrypto` rather than the global variable `crypto`.
+
+#### always
+
+Examples of 👎 **incorrect** code for this rule:
+
+```js
+/*eslint n/prefer-global/crypto: [error]*/
+
+const { webcrypto } = require("crypto")
+webcrypto.randomUUID()
+```
+
+Examples of 👍 **correct** code for this rule:
+
+```js
+/*eslint n/prefer-global/crypto: [error]*/
+
+crypto.randomUUID()
+```
+
+#### never
+
+Examples of 👎 **incorrect** code for the `"never"` option:
+
+```js
+/*eslint n/prefer-global/crypto: [error, never]*/
+
+crypto.randomUUID()
+```
+
+Examples of 👍 **correct** code for the `"never"` option:
+
+```js
+/*eslint n/prefer-global/crypto: [error, never]*/
+
+const { webcrypto } = require("crypto")
+webcrypto.randomUUID()
+```
+
+## 🔎 Implementation
+
+- [Rule source](../../../lib/rules/prefer-global/crypto.js)
+- [Test source](../../../tests/lib/rules/prefer-global/crypto.js)

lib/all-rules.js

@@ -38,6 +38,7 @@ module.exports = {
     "no-unsupported-features/node-builtins": require("./rules/no-unsupported-features/node-builtins"),
     "prefer-global/buffer": require("./rules/prefer-global/buffer"),
     "prefer-global/console": require("./rules/prefer-global/console"),
+    "prefer-global/crypto": require("./rules/prefer-global/crypto"),
     "prefer-global/process": require("./rules/prefer-global/process"),
     "prefer-global/text-decoder": require("./rules/prefer-global/text-decoder"),
     "prefer-global/text-encoder": require("./rules/prefer-global/text-encoder"),

lib/rules/prefer-global/crypto.js

@@ -0,0 +1,47 @@
+/**
+ * @author Pixel998
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+const { READ } = require("@eslint-community/eslint-utils")
+const checkForPreferGlobal = require("../../util/check-prefer-global")
+
+const traceMap = {
+    globals: {
+        crypto: { [READ]: true },
+    },
+    modules: {
+        crypto: { webcrypto: { [READ]: true } },
+        "node:crypto": { webcrypto: { [READ]: true } },
+    },
+}
+
+/** @type {import('../rule-module').RuleModule} */
+module.exports = {
+    meta: {
+        docs: {
+            description:
+                'enforce either `crypto` or `require("crypto").webcrypto`',
+            recommended: false,
+            url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/crypto.md",
+        },
+        type: "suggestion",
+        fixable: null,
+        schema: [{ enum: ["always", "never"] }],
+        messages: {
+            preferGlobal:
+                "Unexpected use of 'require(\"crypto\").webcrypto'. Use the global variable 'crypto' instead.",
+            preferModule:
+                "Unexpected use of the global variable 'crypto'. Use 'require(\"crypto\").webcrypto' instead.",
+        },
+    },
+
+    create(context) {
+        return {
+            "Program:exit"() {
+                checkForPreferGlobal(context, traceMap)
+            },
+        }
+    },
+}

tests/lib/rules/prefer-global/crypto.js

@@ -0,0 +1,57 @@
+/**
+ * @author Pixel998
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+const RuleTester = require("#test-helpers").RuleTester
+const rule = require("../../../../lib/rules/prefer-global/crypto")
+
+const provideModuleMethods = ["require", "process.getBuiltinModule"]
+
+new RuleTester().run("prefer-global/crypto", rule, {
+    valid: [
+        "crypto.randomUUID()",
+        {
+            code: "crypto.randomUUID()",
+            options: ["always"],
+        },
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `const { webcrypto } = ${method}('crypto'); webcrypto.randomUUID()`,
+                options: ["never"],
+            },
+            {
+                code: `const { webcrypto } = ${method}('node:crypto'); webcrypto.randomUUID()`,
+                options: ["never"],
+            },
+        ]),
+    ],
+    invalid: [
+        ...provideModuleMethods.flatMap(method => [
+            {
+                code: `const { webcrypto } = ${method}('crypto'); webcrypto.randomUUID()`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `const { webcrypto } = ${method}('node:crypto'); webcrypto.randomUUID()`,
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `const { webcrypto } = ${method}('crypto'); webcrypto.randomUUID()`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+            {
+                code: `const { webcrypto } = ${method}('node:crypto'); webcrypto.randomUUID()`,
+                options: ["always"],
+                errors: [{ messageId: "preferGlobal" }],
+            },
+        ]),
+        {
+            code: "crypto.randomUUID()",
+            options: ["never"],
+            errors: [{ messageId: "preferModule" }],
+        },
+    ],
+})