tools: use stylistic ESLint plugin for formatting

Refs: https://eslint.org/blog/2023/10/deprecating-formatting-rules/ PR-URL: #50714 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
nodejs · May 3, 2024 · b4d7032 · b4d7032
1 parent 29d2011
commit b4d7032
Show file tree

Hide file tree

Showing 1,049 changed files with 14,778 additions and 4,478 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -19,6 +19,7 @@ const hacks = [
   'eslint-plugin-markdown',
   '@babel/eslint-parser',
   '@babel/plugin-syntax-import-attributes',
+  '@stylistic/eslint-plugin-js',
 ];
 Module._findPath = (request, paths, isMain) => {
   const r = ModuleFindPath(request, paths, isMain);
@@ -39,7 +40,7 @@ module.exports = {
     es2022: true,
   },
   extends: ['eslint:recommended', 'plugin:jsdoc/recommended'],
-  plugins: ['jsdoc', 'markdown', 'node-core'],
+  plugins: ['jsdoc', 'markdown', 'node-core', '@stylistic/js'],
   parser: '@babel/eslint-parser',
   parserOptions: {
     babelOptions: {
@@ -133,11 +134,7 @@ module.exports = {
     // https://eslint.org/docs/rules/
     'accessor-pairs': 'error',
     'array-callback-return': 'error',
-    'arrow-parens': 'error',
-    'arrow-spacing': 'error',
     'block-scoped-var': 'error',
-    'block-spacing': 'error',
-    'brace-style': ['error', '1tbs', { allowSingleLine: true }],
     'capitalized-comments': ['error', 'always', {
       line: {
         // Ignore all lines that have less characters than 20 and all lines that
@@ -150,49 +147,17 @@ module.exports = {
         ignorePattern: '.*',
       },
     }],
-    'comma-dangle': ['error', 'always-multiline'],
-    'comma-spacing': 'error',
-    'comma-style': 'error',
-    'computed-property-spacing': 'error',
     'default-case-last': 'error',
-    'dot-location': ['error', 'property'],
     'dot-notation': 'error',
-    'eol-last': 'error',
     'eqeqeq': ['error', 'smart'],
-    'func-call-spacing': 'error',
     'func-name-matching': 'error',
     'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
-    'indent': ['error', 2, {
-      ArrayExpression: 'first',
-      CallExpression: { arguments: 'first' },
-      FunctionDeclaration: { parameters: 'first' },
-      FunctionExpression: { parameters: 'first' },
-      MemberExpression: 'off',
-      ObjectExpression: 'first',
-      SwitchCase: 1,
-    }],
-    'key-spacing': 'error',
-    'keyword-spacing': 'error',
-    'linebreak-style': 'error',
-    'max-len': ['error', {
-      code: 120,
-      ignorePattern: '^// Flags:',
-      ignoreRegExpLiterals: true,
-      ignoreTemplateLiterals: true,
-      ignoreUrls: true,
-      tabWidth: 2,
-    }],
-    'new-parens': 'error',
-    'no-confusing-arrow': 'error',
     'no-constant-condition': ['error', { checkLoops: false }],
     'no-constructor-return': 'error',
     'no-duplicate-imports': 'error',
     'no-else-return': 'error',
-    'no-extra-parens': ['error', 'functions'],
     'no-lonely-if': 'error',
     'no-mixed-requires': 'error',
-    'no-multi-spaces': ['error', { ignoreEOLComments: true }],
-    'no-multiple-empty-lines': ['error', { max: 2, maxEOF: 0, maxBOF: 0 }],
     'no-new-require': 'error',
     'no-path-concat': 'error',
     'no-proto': 'error',
@@ -257,10 +222,8 @@ module.exports = {
       },
     ],
     'no-self-compare': 'error',
-    'no-tabs': 'error',
     'no-template-curly-in-string': 'error',
     'no-throw-literal': 'error',
-    'no-trailing-spaces': 'error',
     'no-undef': ['error', { typeof: true }],
     'no-undef-init': 'error',
     'no-unused-expressions': ['error', { allowShortCircuit: true }],
@@ -276,39 +239,11 @@ module.exports = {
     'no-useless-return': 'error',
     'no-var': 'error',
     'no-void': 'error',
-    'no-whitespace-before-property': 'error',
-    'object-curly-newline': 'error',
-    'object-curly-spacing': ['error', 'always'],
     'one-var': ['error', { initialized: 'never' }],
-    'one-var-declaration-per-line': 'error',
-    'operator-linebreak': ['error', 'after'],
-    'padding-line-between-statements': [
-      'error',
-      { blankLine: 'always', prev: 'function', next: 'function' },
-    ],
     'prefer-const': ['error', { ignoreReadBeforeAssign: true }],
     'prefer-object-has-own': 'error',
-    'quotes': ['error', 'single', { avoidEscape: true }],
-    'quote-props': ['error', 'consistent'],
-    'rest-spread-spacing': 'error',
-    'semi': 'error',
-    'semi-spacing': 'error',
-    'space-before-blocks': ['error', 'always'],
-    'space-before-function-paren': ['error', {
-      anonymous: 'never',
-      named: 'never',
-      asyncArrow: 'always',
-    }],
-    'space-in-parens': 'error',
-    'space-infix-ops': 'error',
-    'space-unary-ops': 'error',
-    'spaced-comment': ['error', 'always', {
-      'block': { 'balanced': true },
-      'exceptions': ['-'],
-    }],
     'strict': ['error', 'global'],
     'symbol-description': 'error',
-    'template-curly-spacing': 'error',
     'unicode-bom': 'error',
     'valid-typeof': ['error', { requireStringLiterals: true }],
 
@@ -327,6 +262,74 @@ module.exports = {
     'jsdoc/check-tag-names': 'off',
     'jsdoc/require-returns': 'off',
 
+    // Stylistic rules
+    '@stylistic/js/arrow-parens': 'error',
+    '@stylistic/js/arrow-spacing': 'error',
+    '@stylistic/js/block-spacing': 'error',
+    '@stylistic/js/brace-style': ['error', '1tbs', { allowSingleLine: true }],
+    '@stylistic/js/comma-dangle': ['error', 'always-multiline'],
+    '@stylistic/js/comma-spacing': 'error',
+    '@stylistic/js/comma-style': 'error',
+    '@stylistic/js/computed-property-spacing': 'error',
+    '@stylistic/js/dot-location': ['error', 'property'],
+    '@stylistic/js/eol-last': 'error',
+    '@stylistic/js/func-call-spacing': 'error',
+    '@stylistic/js/indent': ['error', 2, {
+      ArrayExpression: 'first',
+      CallExpression: { arguments: 'first' },
+      FunctionDeclaration: { parameters: 'first' },
+      FunctionExpression: { parameters: 'first' },
+      MemberExpression: 'off',
+      ObjectExpression: 'first',
+      SwitchCase: 1,
+    }],
+    '@stylistic/js/key-spacing': 'error',
+    '@stylistic/js/keyword-spacing': 'error',
+    '@stylistic/js/linebreak-style': 'error',
+    '@stylistic/js/max-len': ['error', {
+      code: 120,
+      ignorePattern: '^// Flags:',
+      ignoreRegExpLiterals: true,
+      ignoreTemplateLiterals: true,
+      ignoreUrls: true,
+      tabWidth: 2,
+    }],
+    '@stylistic/js/new-parens': 'error',
+    '@stylistic/js/no-confusing-arrow': 'error',
+    '@stylistic/js/no-extra-parens': ['error', 'functions'],
+    '@stylistic/js/no-multi-spaces': ['error', { ignoreEOLComments: true }],
+    '@stylistic/js/no-multiple-empty-lines': ['error', { max: 2, maxEOF: 0, maxBOF: 0 }],
+    '@stylistic/js/no-tabs': 'error',
+    '@stylistic/js/no-trailing-spaces': 'error',
+    '@stylistic/js/no-whitespace-before-property': 'error',
+    '@stylistic/js/object-curly-newline': 'error',
+    '@stylistic/js/object-curly-spacing': ['error', 'always'],
+    '@stylistic/js/one-var-declaration-per-line': 'error',
+    '@stylistic/js/operator-linebreak': ['error', 'after'],
+    '@stylistic/js/padding-line-between-statements': [
+      'error',
+      { blankLine: 'always', prev: 'function', next: 'function' },
+    ],
+    '@stylistic/js/quotes': ['error', 'single', { avoidEscape: true }],
+    '@stylistic/js/quote-props': ['error', 'consistent'],
+    '@stylistic/js/rest-spread-spacing': 'error',
+    '@stylistic/js/semi': 'error',
+    '@stylistic/js/semi-spacing': 'error',
+    '@stylistic/js/space-before-blocks': ['error', 'always'],
+    '@stylistic/js/space-before-function-paren': ['error', {
+      anonymous: 'never',
+      named: 'never',
+      asyncArrow: 'always',
+    }],
+    '@stylistic/js/space-in-parens': 'error',
+    '@stylistic/js/space-infix-ops': 'error',
+    '@stylistic/js/space-unary-ops': 'error',
+    '@stylistic/js/spaced-comment': ['error', 'always', {
+      'block': { 'balanced': true },
+      'exceptions': ['-'],
+    }],
+    '@stylistic/js/template-curly-spacing': 'error',
+
     // Custom rules from eslint-plugin-node-core
     'node-core/no-unescaped-regexp-dot': 'error',
     'node-core/no-duplicate-requires': 'error',

diff --git a/doc/.eslintrc.yaml b/doc/.eslintrc.yaml
@@ -13,5 +13,5 @@ rules:
   prefer-rest-params: error
   prefer-template: error
 
-  # Stylistic Issues
-  no-multiple-empty-lines: [error, {max: 1, maxEOF: 0, maxBOF: 0}]
+  # Stylistic rules
+  '@stylistic/js/no-multiple-empty-lines': [error, {max: 1, maxEOF: 0, maxBOF: 0}]
diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -163,7 +163,7 @@ Returns an array of IP address strings, formatted according to [RFC 5952][],
 that are currently configured for DNS resolution. A string will include a port
 section if a custom port is used.
 
-<!-- eslint-disable semi-->
+<!-- eslint-disable @stylistic/js/semi-->
 
 ```js
 [
@@ -468,7 +468,7 @@ will be present on the object:
 
 Here is an example of the `ret` object passed to the callback:
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 [ { type: 'A', address: '127.0.0.1', ttl: 299 },
@@ -932,7 +932,7 @@ Returns an array of IP address strings, formatted according to [RFC 5952][],
 that are currently configured for DNS resolution. A string will include a port
 section if a custom port is used.
 
-<!-- eslint-disable semi-->
+<!-- eslint-disable @stylistic/js/semi-->
 
 ```js
 [
@@ -1133,7 +1133,7 @@ present on the object:
 
 Here is an example of the result object:
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 [ { type: 'A', address: '127.0.0.1', ttl: 299 },

diff --git a/doc/api/http.md b/doc/api/http.md
@@ -38,7 +38,7 @@ property, which is an array of `[key, value, key2, value2, ...]`. For
 example, the previous message header object might have a `rawHeaders`
 list like the following:
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 [ 'ConTent-Length', '123456',

diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -3585,7 +3585,7 @@ Accept: text/plain
 
 Then `request.url` will be:
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 '/status?name=ryan'

diff --git a/doc/api/os.md b/doc/api/os.md
@@ -91,7 +91,7 @@ The properties included on each object include:
   * `idle` {number} The number of milliseconds the CPU has spent in idle mode.
   * `irq` {number} The number of milliseconds the CPU has spent in irq mode.
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 [

diff --git a/doc/api/process.md b/doc/api/process.md
@@ -1722,7 +1722,7 @@ Results in `process.execArgv`:
 
 And `process.argv`:
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 ['/usr/local/bin/node', 'script.js', '--version']
@@ -1742,7 +1742,7 @@ added: v0.1.100
 The `process.execPath` property returns the absolute pathname of the executable
 that started the Node.js process. Symbolic links, if any, are resolved.
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 '/usr/local/bin/node'

diff --git a/doc/api/zlib.md b/doc/api/zlib.md
@@ -264,7 +264,7 @@ From `zlib/zconf.h`, modified for Node.js usage:
 
 The memory requirements for deflate are (in bytes):
 
-<!-- eslint-disable semi -->
+<!-- eslint-disable @stylistic/js/semi -->
 
 ```js
 (1 << (windowBits + 2)) + (1 << (memLevel + 9))

diff --git a/lib/.eslintrc.yaml b/lib/.eslintrc.yaml
@@ -4,9 +4,6 @@ env:
 rules:
   prefer-object-spread: error
   no-buffer-constructor: error
-  no-mixed-operators:
-    - error
-    - groups: [['&&', '||']]
   no-restricted-syntax:
     # Config copied from .eslintrc.js
     - error
@@ -179,6 +176,12 @@ rules:
     - error
     - name: url
       message: Require `internal/url` instead of `url`.
+
+  # Stylistic rules
+  '@stylistic/js/no-mixed-operators':
+    - error
+    - groups: [['&&', '||']]
+
   # Custom rules in tools/eslint-rules
   node-core/avoid-prototype-pollution: error
   node-core/lowercase-name-for-primitive: error

diff --git a/test/.eslintrc.yaml b/test/.eslintrc.yaml
@@ -8,7 +8,6 @@ rules:
   multiline-comment-style: [error, separate-lines]
   prefer-const: error
   symbol-description: off
-  comma-dangle: [error, always-multiline]
 
   no-restricted-syntax:
     # Config copied from .eslintrc.js
@@ -54,6 +53,9 @@ rules:
     - selector: Identifier[name='webcrypto']
       message: Use `globalThis.crypto`.
 
+  # Stylistic rules
+  '@stylistic/js/comma-dangle': [error, always-multiline]
+
   # Custom rules in tools/eslint-rules
   node-core/prefer-assert-iferror: error
   node-core/prefer-assert-methods: error
@@ -83,7 +85,7 @@ overrides:
       - sequential/*.js
       - sequential/*.mjs
     rules:
-      comma-dangle: [error, {
+      '@stylistic/js/comma-dangle': [error, {
         arrays: always-multiline,
         exports: always-multiline,
         functions: only-multiline,

diff --git a/test/common/dns.js b/test/common/dns.js
@@ -40,7 +40,7 @@ function readDomainFromPacket(buffer, offset) {
   }
   // Pointer to another part of the packet.
   assert.strictEqual(length & 0xC0, 0xC0);
-  // eslint-disable-next-line space-infix-ops, space-unary-ops
+  // eslint-disable-next-line @stylistic/js/space-infix-ops, @stylistic/js/space-unary-ops
   const pointeeOffset = buffer.readUInt16BE(offset) &~ 0xC000;
   return {
     nread: 2,