.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,52 @@
+name: "\U0001F41E Report a problem"
+description: "Report an issue with eslint-plugin-n"
+title: "Bug: (fill in)"
+labels:
+  - bug
+body:
+- type: markdown
+  attributes:
+    value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/conduct).
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      Please tell us about how you're running ESLint.
+    value: |
+        Node version:
+        npm version:
+        ESLint version:
+        eslint-plugin-n version:
+        Operating System:
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: What rule do you want to report?
+    description: Please provide the name of the rule you're having problems with.
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Link to Minimal Reproducible Example
+    description: 'Link to a [playground](https://eslint-online-playground.netlify.app/), [StackBlitz](https://stackblitz.com), or GitHub repo with a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be auto-closed.'
+    placeholder: 'https://eslint-online-playground.netlify.app/#'
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: What did you expect to happen?
+    description: |
+      You can use Markdown in this field.
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Participation
+    options:
+      - label: I am willing to submit a pull request for this issue.
+        required: false
+- type: textarea
+  attributes:
+    label: Additional comments
+    description: Is there anything else that's important for the team to know?

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/new-rule.yml

@@ -0,0 +1,41 @@
+name: "\U0001F680 Propose a new rule"
+description: "Propose a new rule to be added to the plugin"
+title: "New Rule: (fill in)"
+labels:
+  - rule
+  - feature
+body:
+- type: markdown
+  attributes:
+    value: By opening an issue, you agree to abide by the [Open JS Foundation Code of Conduct](https://eslint.org/conduct).
+- type: textarea
+  attributes:
+    label: Rule details
+    description: What should the new rule do?
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: What type of rule is this?
+    options:
+      - Warns about a potential problem
+      - Suggests an alternate way of doing something
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Example code
+    description: Please provide some example JavaScript code that this rule will warn about. This field will render as JavaScript.
+    render: js
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Participation
+    options:
+      - label: I am willing to submit a pull request to implement this rule.
+        required: false
+- type: textarea
+  attributes:
+    label: Additional comments
+    description: Is there anything else that's important for the team to know?

README.md

@@ -6,7 +6,7 @@
 [![Downloads](https://img.shields.io/npm/dm/eslint-plugin-n.svg)](https://www.npmjs.com/package/eslint-plugin-n)
 [![Build Status](https://github.com/eslint-community/eslint-plugin-n/workflows/CI/badge.svg)](https://github.com/eslint-community/eslint-plugin-n/actions)
 
-Additional ESLint's rules for Node.js
+Additional ESLint rules for Node.js
 
 ## 💿 Install & Usage
 

docs/rules/no-callback-literal.md

@@ -6,7 +6,7 @@ When invoking a callback function which uses the Node.js error-first callback pa
 
 ## 📖 Rule Details
 
-When a function is named `cb` or `callback`, then it must be invoked with a first argument that is `undefined`, `null`, an `Error` class, or a subclass or `Error`.
+When a function is named `cb` or `callback`, then it must be invoked with a first argument that is `undefined`, `null`, an `Error` class, or a subclass of `Error`.
 
 Examples of 👎 **incorrect** code for this rule:
 

lib/rules/callback-return.js

@@ -9,7 +9,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "require `return` statements after callbacks",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/callback-return.md",
         },

lib/rules/exports-style.js

@@ -227,7 +227,6 @@ module.exports = {
     meta: {
         docs: {
             description: "enforce either `module.exports` or `exports`",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/exports-style.md",
         },

lib/rules/file-extension-in-import.js

@@ -8,9 +8,6 @@ const path = require("path")
 const fs = require("fs")
 const mapTypescriptExtension = require("../util/map-typescript-extension")
 const visitImport = require("../util/visit-import")
-const packageNamePattern = /^(?:@[^/\\]+[/\\])?[^/\\]+$/u
-const corePackageOverridePattern =
-    /^(?:assert|async_hooks|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|http2|https|inspector|module|net|os|path|perf_hooks|process|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|trace_events|tty|url|util|v8|vm|worker_threads|zlib)[/\\]$/u
 
 /**
  * Get all file extensions of the files which have the same basename.
@@ -37,7 +34,6 @@ module.exports = {
         docs: {
             description:
                 "enforce the style of file extensions in `import` declarations",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/file-extension-in-import.md",
         },
@@ -67,13 +63,13 @@ module.exports = {
         const defaultStyle = context.options[0] || "always"
         const overrideStyle = context.options[1] || {}
 
-        function verify({ filePath, name, node }) {
+        /**
+         * @param {import("../util/import-target.js")} target
+         * @returns {void}
+         */
+        function verify({ filePath, name, node, moduleType }) {
             // Ignore if it's not resolved to a file or it's a bare module.
-            if (
-                !filePath ||
-                packageNamePattern.test(name) ||
-                corePackageOverridePattern.test(name)
-            ) {
+            if (moduleType !== "relative" && moduleType !== "absolute") {
                 return
             }
 

lib/rules/global-require.js

@@ -53,7 +53,6 @@ module.exports = {
         docs: {
             description:
                 "require `require()` calls to be placed at top-level module scope",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/global-require.md",
         },

lib/rules/handle-callback-err.js

@@ -9,7 +9,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "require error handling in callbacks",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/handle-callback-err.md",
         },

lib/rules/no-callback-literal.js

@@ -9,7 +9,6 @@ module.exports = {
         docs: {
             description:
                 "enforce Node.js-style error-first callback pattern is followed",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-callback-literal.md",
         },

lib/rules/no-deprecated-api.js

@@ -691,7 +691,6 @@ module.exports = {
     meta: {
         docs: {
             description: "disallow deprecated APIs",
-            category: "Best Practices",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-deprecated-api.md",
         },

lib/rules/no-exports-assign.js

@@ -38,7 +38,6 @@ module.exports = {
     meta: {
         docs: {
             description: "disallow the assignment to `exports`",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-exports-assign.md",
         },

lib/rules/no-extraneous-import.js

@@ -15,7 +15,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `import` declarations which import extraneous modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-extraneous-import.md",
         },

lib/rules/no-extraneous-require.js

@@ -16,7 +16,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `require()` expressions which import extraneous modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-extraneous-require.md",
         },

lib/rules/no-hide-core-modules.js

@@ -57,7 +57,6 @@ module.exports = {
         docs: {
             description:
                 "disallow third-party modules which are hiding core modules",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-hide-core-modules.md",
         },

lib/rules/no-missing-import.js

@@ -16,7 +16,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `import` declarations which import non-existence modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-missing-import.md",
         },

lib/rules/no-missing-require.js

@@ -17,7 +17,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `require()` expressions which import non-existence modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-missing-require.md",
         },

lib/rules/no-mixed-requires.js

@@ -71,7 +71,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `require` calls to be mixed with regular variable declarations",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-mixed-requires.md",
         },

lib/rules/no-new-require.js

@@ -9,7 +9,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow `new` operators with calls to `require`",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-new-require.md",
         },

lib/rules/no-path-concat.js

@@ -166,7 +166,6 @@ module.exports = {
         docs: {
             description:
                 "disallow string concatenation with `__dirname` and `__filename`",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-path-concat.md",
         },

lib/rules/no-process-env.js

@@ -13,7 +13,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow the use of `process.env`",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-process-env.md",
         },

lib/rules/no-process-exit.js

@@ -9,7 +9,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow the use of `process.exit()`",
-            category: "Possible Errors",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-process-exit.md",
         },

lib/rules/no-restricted-import.js

@@ -13,7 +13,6 @@ module.exports = {
         docs: {
             description:
                 "disallow specified modules when loaded by `import` declarations",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-restricted-import.md",
         },

lib/rules/no-restricted-require.js

@@ -13,7 +13,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow specified modules when loaded by `require`",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-restricted-require.md",
         },

lib/rules/no-sync.js

@@ -27,7 +27,6 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow synchronous methods",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-sync.md",
         },

lib/rules/no-unpublished-bin.js

@@ -33,7 +33,6 @@ module.exports = {
     meta: {
         docs: {
             description: "disallow `bin` files that npm ignores",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unpublished-bin.md",
         },

lib/rules/no-unpublished-import.js

@@ -15,7 +15,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `import` declarations which import private modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unpublished-import.md",
         },

lib/rules/no-unpublished-require.js

@@ -16,7 +16,6 @@ module.exports = {
         docs: {
             description:
                 "disallow `require()` expressions which import private modules",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unpublished-require.md",
         },

lib/rules/no-unsupported-features.js

@@ -1048,7 +1048,6 @@ module.exports = {
         docs: {
             description:
                 "disallow unsupported ECMAScript features on the specified version",
-            category: "Possible Errors",
             recommended: false,
 
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unsupported-features.md",

lib/rules/no-unsupported-features/es-builtins.js

@@ -143,7 +143,6 @@ module.exports = {
         docs: {
             description:
                 "disallow unsupported ECMAScript built-ins on the specified version",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unsupported-features/es-builtins.md",
         },

lib/rules/no-unsupported-features/es-syntax.js

@@ -523,7 +523,6 @@ module.exports = {
         docs: {
             description:
                 "disallow unsupported ECMAScript syntax on the specified version",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unsupported-features/es-syntax.md",
         },

lib/rules/no-unsupported-features/node-builtins.js

@@ -379,7 +379,6 @@ module.exports = {
         docs: {
             description:
                 "disallow unsupported Node.js built-in APIs on the specified version",
-            category: "Possible Errors",
             recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unsupported-features/node-builtins.md",
         },

lib/rules/prefer-global/buffer.js

@@ -23,7 +23,6 @@ module.exports = {
         docs: {
             description:
                 'enforce either `Buffer` or `require("buffer").Buffer`',
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/buffer.md",
         },

lib/rules/prefer-global/console.js

@@ -20,7 +20,6 @@ module.exports = {
     meta: {
         docs: {
             description: 'enforce either `console` or `require("console")`',
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/console.md",
         },

lib/rules/prefer-global/process.js

@@ -20,7 +20,6 @@ module.exports = {
     meta: {
         docs: {
             description: 'enforce either `process` or `require("process")`',
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/prefer-global/process.md",
         },