Generate definitions for eslint-plugin-node

Author: Shinigami92

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Next
 
-[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.1.0...main)
+[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.1.1...main)
+
+# 1.1.1
+
+[diff](https://github.com/Shinigami92/eslint-define-config/compare/1.1.0...1.1.1)
+
+- Automatically generate rule definitions for `node`
+- Fix rules JSDoc hovering
 
 # 1.1.0
 
@@ -11,6 +18,7 @@
   - `@typescript-eslint`
   - `jsdoc`
   - `spellcheck`
+  - `unicorn`
   - `vue`
 
 [#69]: https://github.com/Shinigami92/eslint-define-config/pull/69

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-define-config",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Provide a defineConfig function for .eslintrc.js files",
   "main": "src/index.js",
   "scripts": {
@@ -49,6 +49,7 @@
     "eslint-config-prettier": "~8.3.0",
     "eslint-plugin-inclusive-language": "~2.1.1",
     "eslint-plugin-jsdoc": "~36.1.0",
+    "eslint-plugin-node": "~11.1.0",
     "eslint-plugin-prettier": "~4.0.0",
     "eslint-plugin-spellcheck": "~0.0.19",
     "eslint-plugin-unicorn": "~36.0.0",

pnpm-lock.yaml

@@ -6,6 +6,8 @@ import * as eslint from 'eslint';
 // @ts-expect-error
 import eslintPluginJSDoc from 'eslint-plugin-jsdoc';
 // @ts-expect-error
+import eslintPluginNode from 'eslint-plugin-node';
+// @ts-expect-error
 import eslintPluginSpellcheck from 'eslint-plugin-spellcheck';
 // @ts-expect-error
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
@@ -51,6 +53,10 @@ const generationMap: Record<string, Plugin> = {
     name: 'JSDoc',
     rules: (eslintPluginJSDoc as Plugin).rules
   },
+  node: {
+    name: 'Node',
+    rules: (eslintPluginNode as Plugin).rules
+  },
   spellcheck: {
     name: 'Spellcheck',
     rules: (eslintPluginSpellcheck as Plugin).rules

scripts/generate-rule-files.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/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/callback-return.md)
+ */
+export type CallbackReturnRuleConfig = RuleConfig<CallbackReturnOptions>;
+
+/**
+ * Require `return` statements after callbacks.
+ *
+ * @see [callback-return](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/callback-return.md)
+ */
+export interface CallbackReturnRule {
+  /**
+   * Require `return` statements after callbacks.
+   *
+   * @see [callback-return](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/callback-return.md)
+   */
+  'node/callback-return': CallbackReturnRuleConfig;
+}

src/rules/node/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/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/exports-style.md)
+ */
+export type ExportsStyleRuleConfig = RuleConfig<ExportsStyleOptions>;
+
+/**
+ * Enforce either `module.exports` or `exports`.
+ *
+ * @see [exports-style](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/exports-style.md)
+ */
+export interface ExportsStyleRule {
+  /**
+   * Enforce either `module.exports` or `exports`.
+   *
+   * @see [exports-style](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/exports-style.md)
+   */
+  'node/exports-style': ExportsStyleRuleConfig;
+}

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

@@ -0,0 +1,43 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Config.
+ */
+export type FileExtensionInImportConfig =
+  | {
+      tryExtensions?: string[];
+    }
+  | {
+      [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/mysticatea/eslint-plugin-node/blob/v11.1.0/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/mysticatea/eslint-plugin-node/blob/v11.1.0/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/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/file-extension-in-import.md)
+   */
+  'node/file-extension-in-import': FileExtensionInImportRuleConfig;
+}

src/rules/node/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/mysticatea/eslint-plugin-node/blob/v11.1.0/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/mysticatea/eslint-plugin-node/blob/v11.1.0/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/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/global-require.md)
+   */
+  'node/global-require': GlobalRequireRuleConfig;
+}

src/rules/node/global-require.d.ts

@@ -0,0 +1,32 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Option.
+ */
+export type HandleCallbackErrOption = string;
+
+/**
+ * Options.
+ */
+export type HandleCallbackErrOptions = [HandleCallbackErrOption?];
+
+/**
+ * Require error handling in callbacks.
+ *
+ * @see [handle-callback-err](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/handle-callback-err.md)
+ */
+export type HandleCallbackErrRuleConfig = RuleConfig<HandleCallbackErrOptions>;
+
+/**
+ * Require error handling in callbacks.
+ *
+ * @see [handle-callback-err](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/handle-callback-err.md)
+ */
+export interface HandleCallbackErrRule {
+  /**
+   * Require error handling in callbacks.
+   *
+   * @see [handle-callback-err](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/handle-callback-err.md)
+   */
+  'node/handle-callback-err': HandleCallbackErrRuleConfig;
+}

src/rules/node/handle-callback-err.d.ts

@@ -1,24 +1,64 @@
+import type { CallbackReturnRule } from './callback-return';
+import type { ExportsStyleRule } from './exports-style';
+import type { FileExtensionInImportRule } from './file-extension-in-import';
+import type { GlobalRequireRule } from './global-require';
+import type { HandleCallbackErrRule } from './handle-callback-err';
+import type { NoCallbackLiteralRule } from './no-callback-literal';
 import type { NoDeprecatedApiRule } from './no-deprecated-api';
+import type { NoExportsAssignRule } from './no-exports-assign';
 import type { NoExtraneousImportRule } from './no-extraneous-import';
 import type { NoExtraneousRequireRule } from './no-extraneous-require';
 import type { NoMissingImportRule } from './no-missing-import';
 import type { NoMissingRequireRule } from './no-missing-require';
-import type { NoProcessExitRuleConfig } from './no-process-exit';
+import type { NoMixedRequiresRule } from './no-mixed-requires';
+import type { NoNewRequireRule } from './no-new-require';
+import type { NoPathConcatRule } from './no-path-concat';
+import type { NoProcessEnvRule } from './no-process-env';
+import type { NoProcessExitRule } from './no-process-exit';
+import type { NoRestrictedImportRule } from './no-restricted-import';
 import type { NoRestrictedRequireRule } from './no-restricted-require';
+import type { NoSyncRule } from './no-sync';
+import type { NoUnpublishedBinRule } from './no-unpublished-bin';
 import type { NoUnpublishedImportRule } from './no-unpublished-import';
 import type { NoUnpublishedRequireRule } from './no-unpublished-require';
+import type { NoUnsupportedFeaturesEsBuiltinsRule } from './no-unsupported-features/es-builtins';
 import type { NoUnsupportedFeaturesEsSyntaxRule } from './no-unsupported-features/es-syntax';
+import type { NoUnsupportedFeaturesNodeBuiltinsRule } from './no-unsupported-features/node-builtins';
+import type { ProcessExitAsThrowRule } from './process-exit-as-throw';
+import type { ShebangRule } from './shebang';
+import type { NoHideCoreModulesRule } from './no-hide-core-modules';
+import type { NoUnsupportedFeaturesRule } from './no-unsupported-features';
 
 /**
- * All node rules.
+ * All Node rules.
  */
-export type NodeRules = NoDeprecatedApiRule &
+export type NodeRules = CallbackReturnRule &
+  ExportsStyleRule &
+  FileExtensionInImportRule &
+  GlobalRequireRule &
+  HandleCallbackErrRule &
+  NoCallbackLiteralRule &
+  NoDeprecatedApiRule &
+  NoExportsAssignRule &
   NoExtraneousImportRule &
   NoExtraneousRequireRule &
   NoMissingImportRule &
   NoMissingRequireRule &
-  // NoProcessExitRuleConfig & // TODO: This rule breaks somehow JSDoc hovering.
+  NoMixedRequiresRule &
+  NoNewRequireRule &
+  NoPathConcatRule &
+  NoProcessEnvRule &
+  NoProcessExitRule &
+  NoRestrictedImportRule &
   NoRestrictedRequireRule &
+  NoSyncRule &
+  NoUnpublishedBinRule &
   NoUnpublishedImportRule &
   NoUnpublishedRequireRule &
-  NoUnsupportedFeaturesEsSyntaxRule;
+  NoUnsupportedFeaturesEsBuiltinsRule &
+  NoUnsupportedFeaturesEsSyntaxRule &
+  NoUnsupportedFeaturesNodeBuiltinsRule &
+  ProcessExitAsThrowRule &
+  ShebangRule &
+  NoHideCoreModulesRule &
+  NoUnsupportedFeaturesRule;

src/rules/node/index.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Ensure Node.js-style error-first callback pattern is followed.
+ *
+ * @see [no-callback-literal](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/no-callback-literal.md)
+ */
+export type NoCallbackLiteralRuleConfig = RuleConfig<[]>;
+
+/**
+ * Ensure Node.js-style error-first callback pattern is followed.
+ *
+ * @see [no-callback-literal](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/no-callback-literal.md)
+ */
+export interface NoCallbackLiteralRule {
+  /**
+   * Ensure Node.js-style error-first callback pattern is followed.
+   *
+   * @see [no-callback-literal](https://github.com/mysticatea/eslint-plugin-node/blob/v11.1.0/docs/rules/no-callback-literal.md)
+   */
+  'node/no-callback-literal': NoCallbackLiteralRuleConfig;
+}