tools: enforce use of trailing commas in tools/

PR-URL: #45889 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
nodejs · Jan 5, 2023 · 794611a · 794611a
1 parent eff92a6
commit 794611a
Show file tree

Hide file tree

Showing 41 changed files with 128 additions and 121 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -68,7 +68,7 @@ module.exports = {
       files: ['**/*.md/*.cjs', '**/*.md/*.js'],
       parserOptions: {
         sourceType: 'script',
-        ecmaFeatures: { impliedStrict: true }
+        ecmaFeatures: { impliedStrict: true },
       },
       rules: { strict: 'off' },
     },
@@ -103,11 +103,11 @@ module.exports = {
         },
         {
           name: 'Buffer',
-          message: 'Import Buffer instead of using the global'
+          message: 'Import Buffer instead of using the global',
         },
         {
           name: 'process',
-          message: 'Import process instead of using the global'
+          message: 'Import process instead of using the global',
         },
       ] },
     },
@@ -134,13 +134,7 @@ module.exports = {
         ignorePattern: '.*',
       },
     }],
-    'comma-dangle': ['error', {
-      arrays: 'always-multiline',
-      exports: 'only-multiline',
-      functions: 'only-multiline',
-      imports: 'only-multiline',
-      objects: 'only-multiline',
-    }],
+    'comma-dangle': ['error', 'always-multiline'],
     'comma-spacing': 'error',
     'comma-style': 'error',
     'computed-property-spacing': 'error',

diff --git a/benchmark/.eslintrc.yaml b/benchmark/.eslintrc.yaml
@@ -5,4 +5,11 @@ env:
   es6: true
 
 rules:
+  comma-dangle: [error, {
+    arrays: always-multiline,
+    exports: only-multiline,
+    functions: only-multiline,
+    imports: only-multiline,
+    objects: only-multiline,
+  }]
   prefer-arrow-callback: error
diff --git a/doc/.eslintrc.yaml b/doc/.eslintrc.yaml
@@ -15,4 +15,3 @@ rules:
 
   # Stylistic Issues
   no-multiple-empty-lines: [error, {max: 1, maxEOF: 0, maxBOF: 0}]
-  comma-dangle: [error, always-multiline]
diff --git a/lib/.eslintrc.yaml b/lib/.eslintrc.yaml
@@ -2,6 +2,13 @@ env:
   es6: true
 
 rules:
+  comma-dangle: [error, {
+    arrays: always-multiline,
+    exports: only-multiline,
+    functions: only-multiline,
+    imports: only-multiline,
+    objects: only-multiline,
+  }]
   prefer-object-spread: error
   no-buffer-constructor: error
   no-mixed-operators:

diff --git a/tools/build-addons.mjs b/tools/build-addons.mjs
@@ -31,7 +31,7 @@ async function buildAddon(dir) {
     await execFile(process.execPath, [nodeGyp, 'rebuild', `--directory=${dir}`],
                    {
                      stdio: 'inherit',
-                     env: { ...process.env, MAKEFLAGS: '-j1' }
+                     env: { ...process.env, MAKEFLAGS: '-j1' },
                    });
 
   // We buffer the output and print it out once the process is done in order

diff --git a/tools/doc/addon-verify.mjs b/tools/doc/addon-verify.mjs
@@ -38,7 +38,7 @@ tree.children.forEach((node) => {
 
 await Promise.all(
   Object.keys(addons).flatMap(
-    (header) => verifyFiles(addons[header].files, header)
+    (header) => verifyFiles(addons[header].files, header),
   ));
 
 function verifyFiles(files, blockName) {
@@ -82,8 +82,8 @@ ${files[name].replace(
           sources: files.map(({ name }) => name),
           includes: ['../common.gypi'],
         },
-      ]
-    })
+      ],
+    }),
   });
 
   const dirCreation = mkdir(dir);

diff --git a/tools/doc/allhtml.mjs b/tools/doc/allhtml.mjs
@@ -96,8 +96,8 @@ all = all.slice(0, apiStart.index + apiStart[0].length)
       '\n</head>',
       buildCSSForFlavoredJS(new Set(Array.from(
         apicontent.matchAll(/(?<=<pre class="with-)\d+(?=-chars">)/g),
-        (x) => Number(x[0])
-      ))) + '\n</head>'
+        (x) => Number(x[0]),
+      ))) + '\n</head>',
     ) +
   apicontent +
   all.slice(apiEnd);

diff --git a/tools/doc/alljson.mjs b/tools/doc/alljson.mjs
@@ -18,7 +18,7 @@ const results = {
   modules: [],
   classes: [],
   globals: [],
-  methods: []
+  methods: [],
 };
 
 // Identify files that should be skipped. As files are processed, they
@@ -33,7 +33,7 @@ for (const link of toc.match(/<a.*?>/g)) {
   if (!jsonFiles.includes(json) || seen.has(json)) continue;
   const data = JSON.parse(
     fs.readFileSync(new URL(`./${json}`, source), 'utf8')
-      .replace(/<a href=\\"#/g, `<a href=\\"${href}#`)
+      .replace(/<a href=\\"#/g, `<a href=\\"${href}#`),
   );
 
   for (const property in data) {

diff --git a/tools/doc/apilinks.mjs b/tools/doc/apilinks.mjs
@@ -27,7 +27,7 @@ function execSync(command) {
   try {
     return child_process.execSync(
       command,
-      { stdio: ['ignore', null, 'ignore'] }
+      { stdio: ['ignore', null, 'ignore'] },
     ).toString().trim();
   } catch {
     return '';

diff --git a/tools/doc/deprecationCodes.mjs b/tools/doc/deprecationCodes.mjs
@@ -27,7 +27,7 @@ const testHeading = (headingNode, expectedDeprecationCode) => {
     assert.strictEqual(
       headingNode?.children[0]?.value.substring(0, 9),
       `${expectedDeprecationCode}: `,
-      'Ill-formed or out-of-order deprecation code.'
+      'Ill-formed or out-of-order deprecation code.',
     );
   } catch (e) {
     throw addMarkdownPathToErrorStack(e, headingNode);
@@ -39,7 +39,7 @@ const testYAMLComment = (commentNode) => {
     assert.match(
       commentNode?.value?.substring(0, 21),
       /^<!-- YAML\r?\nchanges:\r?\n/,
-      'Missing or ill-formed YAML comment.'
+      'Missing or ill-formed YAML comment.',
     );
   } catch (e) {
     throw addMarkdownPathToErrorStack(e, commentNode);
@@ -51,7 +51,7 @@ const testDeprecationType = (paragraphNode) => {
     assert.strictEqual(
       paragraphNode?.children[0]?.value?.substring(0, 6),
       'Type: ',
-      'Missing deprecation type.'
+      'Missing deprecation type.',
     );
   } catch (e) {
     throw addMarkdownPathToErrorStack(e, paragraphNode);
@@ -74,7 +74,7 @@ for (let i = 0; i < tree.children.length; i++) {
       assert.strictEqual(
         deprecationCodeAsText,
         expectedDeprecationCode,
-        'Deprecation codes are not ordered correctly.'
+        'Deprecation codes are not ordered correctly.',
       );
     } catch (e) {
       throw addMarkdownPathToErrorStack(e, node);

diff --git a/tools/doc/html.mjs b/tools/doc/html.mjs
@@ -220,7 +220,7 @@ export function preprocessElements({ filename }) {
       } else if (node.type === 'code') {
         if (!node.lang) {
           console.warn(
-            `No language set in ${filename}, line ${node.position.start.line}`
+            `No language set in ${filename}, line ${node.position.start.line}`,
           );
         }
         const className = isJSFlavorSnippet(node) ?
@@ -302,7 +302,7 @@ export function preprocessElements({ filename }) {
               (noLinking ? '' :
                 '<a href="documentation.html#stability-index">') +
               `${prefix} ${number}${noLinking ? '' : '</a>'}`
-                .replace(/\n/g, ' ')
+                .replace(/\n/g, ' '),
           });
 
           // Remove prefix and number from text
@@ -408,7 +408,7 @@ export function buildToc({ filename, apilinks }) {
 
       if (node.depth - depth > 1) {
         throw new Error(
-          `Inappropriate heading level:\n${JSON.stringify(node)}`
+          `Inappropriate heading level:\n${JSON.stringify(node)}`,
         );
       }
 
@@ -543,7 +543,7 @@ function gtocPicker(id) {
 
   // Highlight the current module and add a link to the index
   const gtoc = gtocHTML.replace(
-    `class="nav-${id}"`, `class="nav-${id} active"`
+    `class="nav-${id}"`, `class="nav-${id} active"`,
   ).replace('</ul>', `
       <li>
         <a href="index.html">Index</a>

diff --git a/tools/doc/json.mjs b/tools/doc/json.mjs
@@ -349,7 +349,7 @@ function parseSignature(text, sig) {
           throw new Error(
             `Invalid param "${sigParam}"\n` +
             ` > ${JSON.stringify(listParam)}\n` +
-            ` > ${text}`
+            ` > ${text}`,
           );
         }
       }
@@ -376,7 +376,7 @@ function parseListItem(item, file) {
 
   current.textRaw = item.children.filter((node) => node.type !== 'list')
     .map((node) => (
-      file.value.slice(node.position.start.offset, node.position.end.offset))
+      file.value.slice(node.position.start.offset, node.position.end.offset)),
     )
     .join('').replace(/\s+/g, ' ').replace(/<!--.*?-->/sg, '');
   let text = current.textRaw;

diff --git a/tools/doc/markdown.mjs b/tools/doc/markdown.mjs
@@ -10,7 +10,7 @@ export function replaceLinks({ filename, linksMapper }) {
       if (node.url) {
         node.url = node.url.replace(
           referenceToLocalMdFile,
-          (_, filename, hash) => `${filename}.html${hash || ''}`
+          (_, filename, hash) => `${filename}.html${hash || ''}`,
         );
       }
     });

diff --git a/tools/doc/type-parser.mjs b/tools/doc/type-parser.mjs
@@ -8,7 +8,7 @@ const jsPrimitives = {
   number: 'Number',
   string: 'String',
   symbol: 'Symbol',
-  undefined: 'Undefined'
+  undefined: 'Undefined',
 };
 
 const jsGlobalObjectsUrl = `${jsDocPrefix}Reference/Global_Objects/`;
@@ -301,7 +301,7 @@ export function toLink(typeInput) {
       } else {
         throw new Error(
           `Unrecognized type: '${typeTextFull}'.\n` +
-          `Please, edit the type or update '${import.meta.url}'.`
+          `Please, edit the type or update '${import.meta.url}'.`,
         );
       }
     } else {

diff --git a/tools/eslint-rules/alphabetize-errors.js b/tools/eslint-rules/alphabetize-errors.js
@@ -26,7 +26,7 @@ module.exports = {
           const message = [prefix, prev, opStr, curr].join('');
           context.report({ node, message });
         }
-      }
+      },
     };
-  }
+  },
 };
diff --git a/tools/eslint-rules/async-iife-no-unused-result.js b/tools/eslint-rules/async-iife-no-unused-result.js
@@ -13,7 +13,7 @@ const message =
 
 module.exports = {
   meta: {
-    fixable: 'code'
+    fixable: 'code',
   },
   create: function(context) {
     let hasCommonModule = false;
@@ -31,10 +31,10 @@ module.exports = {
             fix: (fixer) => {
               if (hasCommonModule)
                 return fixer.insertTextAfter(node, '.then(common.mustCall())');
-            }
+            },
           });
         }
-      }
+      },
     };
-  }
+  },
 };
diff --git a/tools/eslint-rules/avoid-prototype-pollution.js b/tools/eslint-rules/avoid-prototype-pollution.js
@@ -80,7 +80,7 @@ function createUnsafeStringMethodReport(context, name, lookedUpProperty) {
         node,
         message: `${name} looks up the ${lookedUpProperty} property on the first argument`,
       });
-    }
+    },
   };
 }
 
@@ -98,7 +98,7 @@ function createUnsafeStringMethodOnRegexReport(context, name, lookedUpProperty)
         node,
         message: `${name} looks up the ${lookedUpProperty} property of the passed regex, use ${safePrimordialName} directly`,
       });
-    }
+    },
   };
 }
 
@@ -155,7 +155,7 @@ module.exports = {
                 fixer.replaceTextRange(testRange, 'Exec'),
                 fixer.insertTextAfter(node, ' !== null'),
               ];
-            }
+            },
           }],
         });
       },

diff --git a/tools/eslint-rules/crypto-check.js b/tools/eslint-rules/crypto-check.js
@@ -78,7 +78,7 @@ module.exports = {
             if (beforeAllChecks) {
               context.report({
                 node: requireNode,
-                message: msg
+                message: msg,
               });
             }
           });
@@ -106,10 +106,10 @@ module.exports = {
                 commonModuleNode,
                 '\nif (!common.hasCrypto) {' +
                 ' common.skip("missing crypto");' +
-                '}'
+                '}',
               );
             }
-          }
+          },
         });
       });
     }
@@ -118,7 +118,7 @@ module.exports = {
       'CallExpression': (node) => testCryptoUsage(node),
       'IfStatement:exit': (node) => testIfStatement(node),
       'MemberExpression:exit': (node) => testMemberExpression(node),
-      'Program:exit': () => reportIfMissingCheck()
+      'Program:exit': () => reportIfMissingCheck(),
     };
-  }
+  },
 };
diff --git a/tools/eslint-rules/documented-errors.js b/tools/eslint-rules/documented-errors.js
@@ -34,7 +34,7 @@ module.exports = {
             `doc/api/errors.md does not have an anchor for "${code}"`;
           context.report({ node, message });
         }
-      }
+      },
     };
-  }
+  },
 };
diff --git a/tools/eslint-rules/eslint-check.js b/tools/eslint-rules/eslint-check.js
@@ -47,10 +47,10 @@ module.exports = {
               if (commonModuleNode) {
                 return fixer.insertTextAfter(
                   commonModuleNode,
-                  '\ncommon.skipIfEslintMissing();'
+                  '\ncommon.skipIfEslintMissing();',
                 );
               }
-            }
+            },
           });
         });
       }
@@ -59,7 +59,7 @@ module.exports = {
     return {
       'CallExpression': (node) => testEslintUsage(context, node),
       'MemberExpression': (node) => checkMemberExpression(context, node),
-      'Program:exit': () => reportIfMissing(context)
+      'Program:exit': () => reportIfMissing(context),
     };
-  }
+  },
 };