Add support for N (#130)

Co-authored-by: Shinigami92 <[email protected]>

Author: Julien-R44

package.json

@@ -64,6 +64,7 @@
     "eslint-plugin-inclusive-language": "~2.2.0",
     "eslint-plugin-jsdoc": "~39.3.6",
     "eslint-plugin-mdx": "~2.0.5",
+    "eslint-plugin-n": "~15.3.0",
     "eslint-plugin-node": "~11.1.0",
     "eslint-plugin-prettier": "~4.2.1",
     "eslint-plugin-spellcheck": "~0.0.19",

pnpm-lock.yaml

@@ -13,6 +13,8 @@ import * as eslintPluginMdx from 'eslint-plugin-mdx';
 // @ts-expect-error
 import eslintPluginNode from 'eslint-plugin-node';
 // @ts-expect-error
+import eslintPluginN from 'eslint-plugin-n';
+// @ts-expect-error
 import eslintPluginSpellcheck from 'eslint-plugin-spellcheck';
 // @ts-expect-error
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
@@ -64,6 +66,10 @@ const generationMap: Record<string, Plugin> = {
     name: 'Mdx',
     rules: eslintPluginMdx.rules,
   },
+  n: {
+    name: 'N',
+    rules: (eslintPluginN as Plugin).rules,
+  },
   node: {
     name: 'Node',
     rules: (eslintPluginNode as Plugin).rules,

scripts/generate-rule-files.ts

@@ -0,0 +1,9 @@
+/**
+ * Eslint N (Node) extensions.
+ *
+ * @see [Eslint N extensions](https://github.com/eslint-community/eslint-plugin-n#-configs)
+ */
+export type NExtensions =
+  | 'plugin:n/recommended'
+  | 'plugin:n/recommended-module'
+  | 'plugin:n/recommended-script';

src/extends/eslint-plugin-n.d.ts

@@ -3,6 +3,7 @@ import type { EslintExtensions } from './eslint';
 import type { ImportExtensions } from './eslint-plugin-import';
 import type { JsdocExtensions } from './eslint-plugin-jsdoc';
 import type { MdxExtensions } from './eslint-plugin-mdx';
+import type { NExtensions } from './eslint-plugin-n';
 import type { NodeExtensions } from './eslint-plugin-node';
 import type { PrettierExtensions } from './eslint-plugin-prettier';
 import type { UnicornExtensions } from './eslint-plugin-unicorn';
@@ -20,6 +21,7 @@ export type KnownExtensions = LiteralUnion<
   | IntlifyVueI18nExtensions
   | JsdocExtensions
   | MdxExtensions
+  | NExtensions
   | NodeExtensions
   | PrettierExtensions
   | TypescriptEslintExtensions

src/extends/index.d.ts

@@ -1,6 +1,7 @@
 import type { EslintRules } from './eslint';
 import type { ImportRules } from './import';
 import type { JSDocRules } from './jsdoc';
+import type { NRules } from './n';
 import type { NodeRules } from './node';
 import type { RuleConfig } from './rule-config';
 import type { SpellcheckRules } from './spellcheck';
@@ -20,6 +21,7 @@ export type Rules = Partial<
     ImportRules &
     JSDocRules &
     NodeRules &
+    NRules &
     SpellcheckRules &
     TypeScriptRules &
     UnicornRules &

src/rules/index.d.ts

@@ -0,0 +1,32 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Option.
+ */
+export type CallbackReturnOption = string[];
+
+/**
+ * Options.
+ */
+export type CallbackReturnOptions = [CallbackReturnOption?];
+
+/**
+ * Require `return` statements after callbacks.
+ *
+ * @see [callback-return](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/callback-return.md)
+ */
+export type CallbackReturnRuleConfig = RuleConfig<CallbackReturnOptions>;
+
+/**
+ * Require `return` statements after callbacks.
+ *
+ * @see [callback-return](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/callback-return.md)
+ */
+export interface CallbackReturnRule {
+  /**
+   * Require `return` statements after callbacks.
+   *
+   * @see [callback-return](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/callback-return.md)
+   */
+  'n/callback-return': CallbackReturnRuleConfig;
+}

src/rules/n/callback-return.d.ts

@@ -0,0 +1,39 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Config.
+ */
+export interface ExportsStyleConfig {
+  allowBatchAssign?: boolean;
+}
+
+/**
+ * Option.
+ */
+export type ExportsStyleOption = 'module.exports' | 'exports';
+
+/**
+ * Options.
+ */
+export type ExportsStyleOptions = [ExportsStyleOption?, ExportsStyleConfig?];
+
+/**
+ * Enforce either `module.exports` or `exports`.
+ *
+ * @see [exports-style](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md)
+ */
+export type ExportsStyleRuleConfig = RuleConfig<ExportsStyleOptions>;
+
+/**
+ * Enforce either `module.exports` or `exports`.
+ *
+ * @see [exports-style](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md)
+ */
+export interface ExportsStyleRule {
+  /**
+   * Enforce either `module.exports` or `exports`.
+   *
+   * @see [exports-style](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/exports-style.md)
+   */
+  'n/exports-style': ExportsStyleRuleConfig;
+}

src/rules/n/exports-style.d.ts

@@ -0,0 +1,43 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Config.
+ */
+export interface FileExtensionInImportConfig {
+  [k: string]: 'always' | 'never';
+}
+
+/**
+ * Option.
+ */
+export type FileExtensionInImportOption = 'always' | 'never';
+
+/**
+ * Options.
+ */
+export type FileExtensionInImportOptions = [
+  FileExtensionInImportOption?,
+  FileExtensionInImportConfig?,
+];
+
+/**
+ * Enforce the style of file extensions in `import` declarations.
+ *
+ * @see [file-extension-in-import](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/file-extension-in-import.md)
+ */
+export type FileExtensionInImportRuleConfig =
+  RuleConfig<FileExtensionInImportOptions>;
+
+/**
+ * Enforce the style of file extensions in `import` declarations.
+ *
+ * @see [file-extension-in-import](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/file-extension-in-import.md)
+ */
+export interface FileExtensionInImportRule {
+  /**
+   * Enforce the style of file extensions in `import` declarations.
+   *
+   * @see [file-extension-in-import](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/file-extension-in-import.md)
+   */
+  'n/file-extension-in-import': FileExtensionInImportRuleConfig;
+}

src/rules/n/file-extension-in-import.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Require `require()` calls to be placed at top-level module scope.
+ *
+ * @see [global-require](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/global-require.md)
+ */
+export type GlobalRequireRuleConfig = RuleConfig<[]>;
+
+/**
+ * Require `require()` calls to be placed at top-level module scope.
+ *
+ * @see [global-require](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/global-require.md)
+ */
+export interface GlobalRequireRule {
+  /**
+   * Require `require()` calls to be placed at top-level module scope.
+   *
+   * @see [global-require](https://github.com/weiran-zsd/eslint-plugin-node/blob/HEAD/docs/rules/global-require.md)
+   */
+  'n/global-require': GlobalRequireRuleConfig;
+}