Document how to configure node version

matejchalk · matejchalk · commit 150ac195c172 · 2025-01-06T13:50:01.000+01:00
diff --git a/docs/angular.md b/docs/angular.md
@@ -11,8 +11,7 @@ Config for **Angular** projects.
    npm install -D angular-eslint eslint-plugin-rxjs-x
    ```
 
-3. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.
-4. Add to your `eslint.config.js` file:
+3. Add to your `eslint.config.js` file:
 
    ```js
    import angular from '@code-pushup/eslint-config/angular.js';
@@ -52,6 +51,8 @@ Config for **Angular** projects.
    );
    ```
 
+4. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.
+
 ## 📏 Rules (425)
 
 **345** rules are included from [`typescript` config](./typescript.md#📏-rules-345). For brevity, only the **80** additional rules are listed in this document.
diff --git a/docs/graphql.md b/docs/graphql.md
@@ -11,7 +11,16 @@ Config for **GraphQL servers** implemented in Node.js.
    npm install -D @graphql-eslint/eslint-plugin eslint-plugin-n
    ```
 
-3. The GraphQL ESLint plugin needs to know where your GraphQL schema is located. For more information, refer to [_Extended Linting Rules with GraphQL Schema_ in GraphQL ESLint docs](https://the-guild.dev/graphql/eslint/docs/getting-started#extended-linting-rules-with-graphql-schema).
+3. Add to your `eslint.config.js` file:
+
+   ```js
+   import graphql from '@code-pushup/eslint-config/graphql.js';
+   import tseslint from 'typescript-eslint';
+   
+   export default tseslint.config(...graphql);
+   ```
+
+4. The GraphQL ESLint plugin needs to know where your GraphQL schema is located. For more information, refer to [_Extended Linting Rules with GraphQL Schema_ in GraphQL ESLint docs](https://the-guild.dev/graphql/eslint/docs/getting-started#extended-linting-rules-with-graphql-schema).
    - If you're using [graphql-config](https://the-guild.dev/graphql/config/docs), then your GraphQL schema will be loaded automatically from your `.graphqlrc.yml` (or equivalent) file. So no extra setup is required in this case.
    - Otherwise, you can use [`parserOptions.schema`](https://the-guild.dev/graphql/eslint/docs/getting-started/parser-options#schema), e.g.:
    
@@ -30,14 +39,6 @@ Config for **GraphQL servers** implemented in Node.js.
        }
      );
      ```
-4. Add to your `eslint.config.js` file:
-
-   ```js
-   import graphql from '@code-pushup/eslint-config/graphql.js';
-   import tseslint from 'typescript-eslint';
-   
-   export default tseslint.config(...graphql);
-   ```
 
 ## 📏 Rules (317)
 
diff --git a/docs/ngrx.md b/docs/ngrx.md
@@ -11,8 +11,7 @@ Config for **Angular** projects using **NgRx** library.
    npm install -D @ngrx/eslint-plugin angular-eslint eslint-plugin-rxjs-x
    ```
 
-3. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.
-4. Add to your `eslint.config.js` file:
+3. Add to your `eslint.config.js` file:
 
    ```js
    import ngrx from '@code-pushup/eslint-config/ngrx.js';
@@ -52,6 +51,8 @@ Config for **Angular** projects using **NgRx** library.
    );
    ```
 
+4. Refer to [step 3 in TypeScript config's setup docs](./typescript.md#🏗️-setup) for how to set up tsconfig properly.
+
 ## 📏 Rules (455)
 
 **425** rules are included from [`angular` config](./angular.md#📏-rules-425). For brevity, only the **30** additional rules are listed in this document.
diff --git a/docs/node.md b/docs/node.md
@@ -20,6 +20,36 @@ Config for **Node.js** projects.
    export default tseslint.config(...node);
    ```
 
+4. Some rules (e.g. `n/no-unsupported-features/node-builtins`) need to know which Node version is being used. Configuration options include:
+   - `engines` field in `package.json`: 
+   
+     ```jsonc
+     {
+       // ...
+       "engines": {
+         "node": ">=22.12.0"
+       }
+     
+     ```
+   
+   - `settings.node.version` in `eslint.config.js`: 
+   
+     ```js
+     export default tseslint.config({
+       // ...
+       {
+         settings: {
+            node: {
+              version: '>=22.12.0'
+            }
+         }
+       }
+     });
+     
+     ```
+
+   For more information, refer to [`eslint-plugin-n` docs](https://github.com/eslint-community/eslint-plugin-n?tab=readme-ov-file#configured-nodejs-version-range).
+
 ## 📏 Rules (294)
 
 **290** rules are included from [`javascript` config](./javascript.md#📏-rules-290). For brevity, only the **4** additional rules are listed in this document.
diff --git a/docs/typescript.md b/docs/typescript.md
@@ -5,7 +5,16 @@ Config for strict **TypeScript** projects.
 ## 🏗️ Setup
 
 1. If you haven't already, make sure to [install `@code-pushup/eslint-config` and its required peer dependencies](../README.md#🏗️-setup).
-2. Because this config includes rules which require type information, make sure to configure `parserOptions.project` in your .eslintrc points to your project's tsconfig.
+2. Add to your `eslint.config.js` file:
+
+   ```js
+   import typescript from '@code-pushup/eslint-config/typescript.js';
+   import tseslint from 'typescript-eslint';
+   
+   export default tseslint.config(...typescript);
+   ```
+
+3. Because this config includes rules which require type information, make sure to configure `parserOptions.project` in your `eslint.config.js` points to your project's tsconfig.
    For more information, refer to [_Linting with Type Information_ (typescript-eslint)](https://typescript-eslint.io/linting/typed-linting).
    
    - Example for library in Nx monorepo:
@@ -54,14 +63,6 @@ Config for strict **TypeScript** projects.
        }
      );
      ```
-3. Add to your `eslint.config.js` file:
-
-   ```js
-   import typescript from '@code-pushup/eslint-config/typescript.js';
-   import tseslint from 'typescript-eslint';
-   
-   export default tseslint.config(...typescript);
-   ```
 
 ## 📏 Rules (345)
 
diff --git a/scripts/helpers/configs.js b/scripts/helpers/configs.js
@@ -71,7 +71,7 @@ const tsConfigDocsReference = md`Refer to ${md.link('./typescript.md#🏗️-set
 /** @type {Partial<Record<keyof typeof configDescriptions, import('build-md').FormattedText>>} */
 export const configsExtraSetupDocs = {
   typescript: md`${md.paragraph(
-    md`Because this config includes rules which require type information, make sure to configure ${md.code('parserOptions.project')} in your .eslintrc points to your project's tsconfig.
+    md`Because this config includes rules which require type information, make sure to configure ${md.code('parserOptions.project')} in your ${md.code('eslint.config.js')} points to your project's tsconfig.
 For more information, refer to ${md.link('https://typescript-eslint.io/linting/typed-linting', md`${md.italic('Linting with Type Information')} (typescript-eslint)`)}.${md.list(
       [
         md`Example for library in Nx monorepo:${md.codeBlock(
@@ -122,6 +122,34 @@ export default tseslint.config(
   angular: tsConfigDocsReference,
   ngrx: tsConfigDocsReference,
 
+  node: md`Some rules (e.g. ${md.code('n/no-unsupported-features/node-builtins')}) need to know which Node version is being used. Configuration options include:${md.list(
+    [
+      md`${md.code('engines')} field in ${md.code('package.json')}: ${md.codeBlock(
+        'jsonc',
+        `{
+  // ...
+  "engines": {
+    "node": ">=22.12.0"
+  }
+`,
+      )}`,
+      md`${md.code('settings.node.version')} in ${md.code('eslint.config.js')}: ${md.codeBlock(
+        'js',
+        `export default tseslint.config({
+  // ...
+  {
+    settings: {
+       node: {
+         version: '>=22.12.0'
+       }
+    }
+  }
+});
+`,
+      )}`,
+    ],
+  )}${md.paragraph(md`For more information, refer to ${md.link('https://github.com/eslint-community/eslint-plugin-n?tab=readme-ov-file#configured-nodejs-version-range', md`${md.code('eslint-plugin-n')} docs`)}.`)}`,
+
   graphql: md`The GraphQL ESLint plugin needs to know where your GraphQL schema is located. For more information, refer to ${md.link('https://the-guild.dev/graphql/eslint/docs/getting-started#extended-linting-rules-with-graphql-schema', md`${md.italic('Extended Linting Rules with GraphQL Schema')} in GraphQL ESLint docs`)}.${md.list(
     [
       md`If you're using ${md.link('https://the-guild.dev/graphql/config/docs', 'graphql-config')}, then your GraphQL schema will be loaded automatically from your ${md.code('.graphqlrc.yml')} (or equivalent) file. So no extra setup is required in this case.`,
diff --git a/scripts/helpers/format-config.js b/scripts/helpers/format-config.js
@@ -70,7 +70,6 @@ export function configRulesToMarkdown(
                 )}`,
               ]
             : []),
-          ...(extraSetupDocs ? [extraSetupDocs] : []),
           md`Add to your ${md.code('eslint.config.js')} file:${md.codeBlock(
             'js',
             [
@@ -86,6 +85,7 @@ export function configRulesToMarkdown(
                 : [`export default tseslint.config(...${config});`]),
             ].join('\n'),
           )}`,
+          ...(extraSetupDocs ? [extraSetupDocs] : []),
         ]),
     )
     .heading(2, `📏 Rules (${totalRulesCount})`)

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,6 @@ export function configRulesToMarkdown(`
`70`	`70`	)}`,
`71`	`71`	`]`
`72`	`72`	`: []),`
`73`		`- ...(extraSetupDocs ? [extraSetupDocs] : []),`
`74`	`73`	md`Add to your ${md.code('eslint.config.js')} file:${md.codeBlock(
`75`	`74`	`'js',`
`76`	`75`	`[`
`@@ -86,6 +85,7 @@ export function configRulesToMarkdown(`
`86`	`85`	: [`export default tseslint.config(...${config});`]),
`87`	`86`	`].join('\n'),`
`88`	`87`	)}`,
	`88`	`+ ...(extraSetupDocs ? [extraSetupDocs] : []),`
`89`	`89`	`]),`
`90`	`90`	`)`
`91`	`91`	.heading(2, `📏 Rules (${totalRulesCount})`)