Lint all JavaScript and TypeScript files (#1294)

* Lint all JavaScript and TypeScript files

* Fix repository-wide lint violations

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: Copilot

eslint.config.mjs

@@ -1,16 +1,21 @@
 import github from 'eslint-plugin-github'
 import globals from 'globals'
 
-const {browser, internal, react, recommended} = github.getFlatConfigs()
+const {browser, internal, react, recommended, typescript} = github.getFlatConfigs()
+const javascriptFiles = ['**/*.{js,mjs,cjs,jsx}']
+const typescriptFiles = ['**/*.{ts,mts,cts,tsx}']
+const configFiles = ['**/*.config.{js,mjs,cjs,ts,mts,cts}']
+const declarationFiles = ['**/*.d.{ts,mts,cts}']
 const nodeFiles = ['tests/**/*.js', 'lib/octicons_node/{index.js,tests/**/*.js}']
-const reactFiles = ['lib/octicons_{react,styled}/{pages,script,src}/**/*.{js,mjs}']
-const lintFiles = [...nodeFiles, ...reactFiles]
+const reactFiles = ['lib/octicons_{react,styled}/{pages,script,src,ts-tests}/**/*.{js,mjs,jsx,ts,tsx}']
+const testFiles = ['**/{__tests__,tests,ts-tests}/**/*.{js,mjs,cjs,jsx,ts,tsx}']
+const typeTestFiles = ['**/ts-tests/**/*.{ts,mts,cts,tsx}']
+const lintFiles = [...javascriptFiles, ...typescriptFiles]
 
 export default [
-  {
-    ignores: ['lib/octicons_react/src/__generated__/**', 'lib/octicons_styled/src/__generated__/**'],
-  },
+  {ignores: ['**/__generated__/**', '**/{build,coverage,dist}/**', '**/.{cache,next}/**', 'public/**', 'vendor/**']},
   {...recommended, files: lintFiles},
+  ...typescript.map(config => ({...config, files: typescriptFiles})),
   {...internal, files: nodeFiles},
   {...browser, files: reactFiles},
   {...react, files: reactFiles},
@@ -42,6 +47,34 @@ export default [
       'import/no-commonjs': 'off',
     },
   },
+  {
+    files: configFiles,
+    rules: {
+      'github/filenames-match-regex': 'off',
+      'import/extensions': 'off',
+      'import/no-commonjs': 'off',
+      'import/no-named-as-default': 'off',
+      'import/no-unresolved': 'off',
+    },
+  },
+  {
+    files: testFiles,
+    rules: {
+      'import/extensions': 'off',
+      'import/no-commonjs': 'off',
+      'import/no-dynamic-require': 'off',
+      'import/no-named-as-default': 'off',
+      'import/no-namespace': 'off',
+    },
+  },
+  {
+    files: declarationFiles,
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      'import/extensions': 'off',
+      'import/no-namespace': 'off',
+    },
+  },
   {
     files: reactFiles,
     rules: {
@@ -52,7 +85,7 @@ export default [
     },
   },
   {
-    files: ['lib/octicons_{react,styled}/script/**/*.js'],
+    files: ['**/script/**/*.js'],
     rules: {
       'import/extensions': 'off',
       'import/no-commonjs': 'off',
@@ -73,4 +106,11 @@ export default [
       'i18n-text/no-en': 'off',
     },
   },
+  {
+    files: typeTestFiles,
+    rules: {
+      '@typescript-eslint/no-unused-vars': 'off',
+      'no-unused-vars': 'off',
+    },
+  },
 ]

lib/octicons_react/next.config.mjs

@@ -2,7 +2,7 @@
 const nextConfig = {
   reactStrictMode: true,
   transpilePackages: ['@primer/components'],
-  pageExtensions: ['js', 'jsx', 'mjs', 'ts', 'tsx'],
+  pageExtensions: ['js', 'jsx', 'mjs', 'ts', 'tsx']
 }
 
 export default nextConfig

lib/octicons_react/src/index.d.ts

@@ -1,7 +1,5 @@
-// eslint-disable-next-line import/no-namespace
 import * as React from 'react'
 
-// eslint-disable-next-line prettier/prettier
 import {Icon} from './__generated__/icons/index.js'
 
 type Size = 'small' | 'medium' | 'large'

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "build": "script/build.js --input icons/**/*.svg --output lib/build/data.json",
     "changeset:version": "changeset version && script/version lib/octicons_node/package.json",
-    "lint": "eslint tests",
+    "lint": "eslint .",
     "svgo": "svgo icons --config svgo.config.js",
     "test": "vitest",
     "version": "script/version"

script/build.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-/* eslint-env node */
 const fs = require('fs-extra')
 const path = require('path')
 const globby = require('globby')
@@ -20,20 +19,19 @@ const {argv} = yargs
     alias: 'i',
     type: 'array',
     demandOption: true,
-    describe: 'Input SVG files'
+    describe: 'Input SVG files',
   })
   .option('output', {
     alias: 'o',
     type: 'string',
-    describe: 'Output JSON file. Defaults to stdout if no output file is provided.'
+    describe: 'Output JSON file. Defaults to stdout if no output file is provided.',
   })
 
 // The `argv.input` array could contain globs (e.g. "**/*.svg").
 const filepaths = globby.sync(argv.input)
 const svgFilepaths = filepaths.filter(filepath => path.parse(filepath).ext === '.svg')
 
 if (svgFilepaths.length === 0) {
-  // eslint-disable-next-line no-console
   console.error('No input SVG file(s) found')
   process.exit(1)
 }
@@ -47,7 +45,7 @@ const icons = svgFilepaths.map(filepath => {
 
     if (!filenamePattern.test(filename)) {
       throw new Error(
-        `${filename}: Invalid filename. Please append the height of the SVG to the end of the filename (e.g. alert-16.svg).`
+        `${filename}: Invalid filename. Please append the height of the SVG to the end of the filename (e.g. alert-16.svg).`,
       )
     }
 
@@ -59,7 +57,7 @@ const icons = svgFilepaths.map(filepath => {
     const svgViewBox = svgElement.attr('viewBox')
     const svgPath = trimNewlines(svgElement.html()).trim()
     const ast = parseSync(svg, {
-      camelcase: true
+      camelcase: true,
     })
 
     if (!svgWidth) {
@@ -82,7 +80,7 @@ const icons = svgFilepaths.map(filepath => {
 
     if (!viewBoxPattern.test(svgViewBox)) {
       throw new Error(
-        `${filename}: Invalid viewBox attribute. The viewBox attribute should be in the following format: "0 0 <width> <height>"`
+        `${filename}: Invalid viewBox attribute. The viewBox attribute should be in the following format: "0 0 <width> <height>"`,
       )
     }
 
@@ -102,10 +100,9 @@ const icons = svgFilepaths.map(filepath => {
       width: svgWidth,
       height: svgHeight,
       path: svgPath,
-      ast
+      ast,
     }
   } catch (error) {
-    // eslint-disable-next-line no-console
     console.error(error)
     // Instead of exiting immediately, we set exitCode to 1 and continue
     // iterating through the rest of the SVGs. This allows us to identify all
@@ -132,12 +129,12 @@ const iconsByName = icons.reduce(
           [icon.height]: {
             width: icon.width,
             path: icon.path,
-            ast: icon.ast
-          }
-        }
-      }
+            ast: icon.ast,
+          },
+        },
+      },
     }),
-  {}
+  {},
 )
 
 if (argv.output) {

svgo.config.js

@@ -1,22 +1,20 @@
-/* eslint-disable import/no-commonjs,filenames/match-regex */
-
 module.exports = {
   multipass: true,
   plugins: [
     {
       name: 'preset-default',
       params: {
         overrides: {
-          removeViewBox: false
-        }
-      }
+          removeViewBox: false,
+        },
+      },
     },
     'removeStyleElement',
     {
       name: 'removeAttrs',
       params: {
-        attrs: ['xmlns:xlink', 'id', 'class', 'data-name', 'fill', 'transform', 'href', 'clip-path', 'clip-rule']
-      }
-    }
-  ]
+        attrs: ['xmlns:xlink', 'id', 'class', 'data-name', 'fill', 'transform', 'href', 'clip-path', 'clip-rule'],
+      },
+    },
+  ],
 }

tests/build.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-commonjs */
 const path = require('path')
 const execa = require('execa')
 

tests/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-commonjs */
 /* eslint-disable i18n-text/no-en */
 
 const fs = require('fs-extra')

vitest.config.mjs

@@ -7,13 +7,13 @@ export default defineConfig({
         test: {
           name: 'octicons',
           globals: true,
-          include: ['tests/*.js']
-        }
+          include: ['tests/*.js'],
+        },
       },
       './lib/octicons_node/vitest.config.mjs',
       './lib/octicons_react/vitest.config.mjs',
       './lib/octicons_react/vitest.browser.config.mjs',
-      './lib/octicons_styled/vitest.config.mjs'
-    ]
-  }
+      './lib/octicons_styled/vitest.config.mjs',
+    ],
+  },
 })