@jcoreio/toolchain 5.9.0 → 5.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain",
-  "version": "5.9.0",
+  "version": "5.10.1",
   "description": "base JS build toolchain",
   "repository": {
     "type": "git",
@@ -17,6 +17,7 @@
     "@babel/generator": "^7.27.0",
     "@babel/parser": "^7.27.0",
     "@babel/template": "^7.27.0",
+    "@babel/traverse": "^7.26.4",
     "@babel/types": "^7.27.0",
     "@eslint/compat": "^1.2.8",
     "@eslint/js": "^9.23.0",

package/plugins/getConfigFiles.cjs

@@ -48,7 +48,6 @@ module.exports = [
       'toolchain.config.cjs': async (existing) => {
         if (existing) return existing
         return dedent`
-          /* eslint-env node, es2018 */
           module.exports = {
             buildIgnore: ${JSON.stringify(await initBuildIgnore(), null, 2)},
             // scripts: {
@@ -69,7 +68,6 @@ module.exports = [
           )
         }
         return dedent`
-          /* eslint-env node, es2018 */
           const base = require('${name}/prettierConfig.cjs')
           module.exports = {
             ...base,
@@ -84,7 +82,6 @@ module.exports = [
       files[file] = async (existing) =>
         existing && fromVersion ? existing : (
           dedent`
-            /* eslint-env node, es2018 */
             const base = require('${name}/${file}')
             module.exports = {
               ...base,

package/plugins/getEslintConfigs.cjs

@@ -6,6 +6,7 @@ const path = require('path')
 const fs = require('../util/projectFs.cjs')
 const { globSync } = require('../util/glob.cjs')
 const execa = require('../util/execa.cjs')
+const globals = require('globals')
 
 module.exports = [
   () => {
@@ -21,7 +22,8 @@ module.exports = [
       if (globalGitignore && fs.pathExistsSync(globalGitignore)) {
         gitignores.push(globalGitignore)
       }
-    } catch {
+      // eslint-disable-next-line no-unused-vars
+    } catch (err) {
       // ignore
     }
     if (fs.pathExistsSync('.eslintignore')) {
@@ -75,6 +77,17 @@ module.exports = [
           ],
         },
       },
+      {
+        files: ['**/*.{js,cjs,mjs,ts,cts,mts}'],
+        ignores: ['src/**', 'test/**'],
+        languageOptions: {
+          ecmaVersion: 2018,
+          globals: {
+            ...globals.es2018,
+            ...globals.node,
+          },
+        },
+      },
       require('eslint-config-prettier'),
     ])
   },

package/scripts/migrate/migrateEslintEnvComments.cjs

@@ -0,0 +1,120 @@
+const { gte } = require('semver')
+
+async function migrateEslintEnvComments({ fromVersion }) {
+  // istanbul ignore next
+  if (fromVersion && gte(fromVersion, '5.10.1')) {
+    return
+  }
+
+  const fs = require('../../util/projectFs.cjs')
+  const { glob } = require('../../util/glob.cjs')
+  const path = require('path')
+  const replaceRanges = require('../../util/replaceRanges.cjs')
+  const getBabelParseOpts = require('../../util/getBabelParseOpts.cjs')
+  const chalk = require('chalk')
+  const dedent = require('dedent-js')
+  const { parse } = require('@babel/parser')
+
+  /** env name -> array of paths from proj root to file */
+  const envFileMap = new Map()
+  const warnings = {}
+  for (const file of await glob('**/*.{js,jsx,cjs,mjs,ts,cts,mts,tsx}', {
+    dot: true,
+  })) {
+    function warn(warning) {
+      ;(warnings[file] || (warnings[file] = [])).push(warning)
+    }
+
+    const source = await fs.readFile(file, 'utf8')
+    let parsed
+    try {
+      parsed = parse(source, getBabelParseOpts(file))
+    } catch (error) {
+      warn(`parse error: ${error.message}`)
+      continue
+    }
+
+    if (!parsed || !('comments' in parsed) || !Array.isArray(parsed.comments)) {
+      continue
+    }
+
+    const replacements = []
+    for (const comment of parsed.comments) {
+      const { start, end, value } = comment
+      const match = /^\s*eslint-env\s+(.*?)\s*$/.exec(value)
+      const envs = match ? match[1].split(/\s*,\s*/g) : undefined
+      if (envs == null) continue
+      replacements.push({ start, end, value: '' })
+
+      if (file.startsWith('src/') || file.startsWith('test/')) {
+        for (const env of envs) {
+          let group = envFileMap.get(env)
+          if (!group) envFileMap.set(env, (group = []))
+          group.push(file)
+        }
+      }
+    }
+
+    if (!replacements.length) continue
+    await fs.writeFile(file, replaceRanges(source, replacements), 'utf8')
+    // eslint-disable-next-line no-console
+    console.error(
+      `removed eslint-env comments from ${path.relative(process.cwd(), file)}`
+    )
+  }
+
+  if (warnings.length) {
+    for (const [file, fileWarnings] of Object.entries(warnings)) {
+      // eslint-disable-next-line no-console
+      console.warn(
+        chalk.yellow(
+          dedent`
+            WARNING: ${file} could not be completely migrated because of the following:
+              ${fileWarnings.map((w) => `- ${w}`).join('\n  ')} 
+            
+          `
+        )
+      )
+    }
+  }
+  if (!envFileMap.size) return
+
+  const t = require('@babel/types')
+  const addEslintConfigsCodemod = require('../../util/addEslintConfigsCodemod.cjs')
+
+  const newConfigs = [...envFileMap].map(([env, files]) =>
+    t.objectExpression([
+      t.objectProperty(
+        t.identifier('files'),
+        t.arrayExpression(files.map((file) => t.stringLiteral(file)))
+      ),
+      t.objectProperty(
+        t.identifier('languageOptions'),
+        t.objectExpression([
+          t.objectProperty(
+            t.identifier('globals'),
+            t.memberExpression(
+              t.identifier('globals'),
+              /^[_a-z$][_a-z0-9$]*$/.test(env) ?
+                t.identifier(env)
+              : t.stringLiteral(env)
+            )
+          ),
+        ])
+      ),
+    ])
+  )
+
+  await fs.writeFile(
+    'eslint.config.cjs',
+    await addEslintConfigsCodemod({
+      file: 'eslint.config.cjs',
+      source: await fs.readFile('eslint.config.cjs', 'utf8'),
+      configs: newConfigs,
+      requireGlobals: true,
+    }),
+    'utf8'
+  )
+}
+
+module.exports = migrateEslintEnvComments

package/scripts/migrate.cjs

@@ -14,6 +14,7 @@ async function migrate(args = []) {
   const installGitHooks = require('./install-git-hooks.cjs')
   const migrateProjectPackageJson = require('./migrate/migrateProjectPackageJson.cjs')
   const migrateEslintConfigs = require('./migrate/migrateEslintConfigs.cjs')
+  const migrateEslintEnvComments = require('./migrate/migrateEslintEnvComments.cjs')
   const migrateConfigFiles = require('./migrate/migrateConfigFiles.cjs')
   const migrateMoveTypeDefs = require('./migrate/migrateMoveTypeDefs.cjs')
   const migrateGitignore = require('./migrate/migrateGitignore.cjs')
@@ -32,6 +33,7 @@ async function migrate(args = []) {
   }
   await migrateConfigFiles({ fromVersion })
   await migrateEslintConfigs({ fromVersion })
+  await migrateEslintEnvComments({ fromVersion })
   if (!fromVersion) await migrateMoveTypeDefs()
   await migrateGitignore({ fromVersion })
   await getPluginsAsyncFunction('migrate')(args, { fromVersion })

package/util/addEslintConfigsCodemod.cjs

@@ -0,0 +1,73 @@
+const traverse = require('@babel/traverse').default
+const { generate } = require('@babel/generator')
+const { parse } = require('@babel/parser')
+const getBabelParseOpts = require('./getBabelParseOpts.cjs')
+const { format } = require('prettier')
+const prettierConfig = require('../prettierConfig.cjs')
+const replaceRanges = require('./replaceRanges.cjs')
+
+async function addEslintConfigsCodemod({
+  file,
+  source,
+  configs,
+  requireGlobals,
+}) {
+  const ast = parse(source, getBabelParseOpts(file))
+  const replacements = []
+
+  let needsRequireGlobals = requireGlobals
+
+  traverse(ast, {
+    VariableDeclarator(path) {
+      const { id, init } = path.node
+      if (
+        id.type === 'Identifier' &&
+        id.name === 'globals' &&
+        init.type === 'CallExpression' &&
+        init.callee.type === 'Identifier' &&
+        init.callee.name === 'require' &&
+        init.arguments.length === 1 &&
+        init.arguments[0].type === 'StringLiteral' &&
+        init.arguments[0].value === 'globals'
+      ) {
+        needsRequireGlobals = false
+      }
+    },
+    CallExpression(path) {
+      const { callee, arguments: args } = path.node
+      const arg0 = args ? args[0] : undefined
+      if (
+        callee.type !== 'Identifier' ||
+        callee.name !== 'defineConfig' ||
+        arg0 == null ||
+        arg0.type !== 'ArrayExpression'
+      ) {
+        return
+      }
+
+      const { start, end } = arg0
+      const needsComma = !/,\s*\]\s*$/.test(source.substring(start, end))
+      replacements.push({
+        start: end - 1,
+        end: end - 1,
+        value:
+          (needsComma ? ',' : '') +
+          configs.map((config) => generate(config).code).join(','),
+      })
+    },
+  })
+
+  if (needsRequireGlobals) {
+    replacements.push({
+      start: 0,
+      end: 0,
+      value: `const globals = require('globals')\n`,
+    })
+  }
+
+  return await format(replaceRanges(source, replacements), {
+    ...prettierConfig,
+    parser: 'babel',
+  })
+}
+module.exports = addEslintConfigsCodemod

package/util/findUps.cjs

@@ -17,7 +17,8 @@ function matchNamedPackageJson(directory) {
   try {
     const json = fs.readJsonSync(Path.join(directory, 'package.json'))
     if (json.name) return 'package.json'
-  } catch {
+    // eslint-disable-next-line no-unused-vars
+  } catch (err) {
     return undefined
   }
 }

package/util/getBabelParseOpts.cjs

@@ -0,0 +1,151 @@
+const commonPlugins = [
+  'asyncGenerators',
+  'bigInt',
+  'classProperties',
+  'classPrivateProperties',
+  'classPrivateMethods',
+  'classStaticBlock',
+  'functionSent',
+  'logicalAssignment',
+  'moduleStringNames',
+  'nullishCoalescingOperator',
+  'numericSeparator',
+  'objectRestSpread',
+  'optionalCatchBinding',
+  'optionalChaining',
+  'privateIn',
+]
+
+const modulePlugins = [
+  'dynamicImport',
+  'exportNamespaceFrom',
+  'exportDefaultFrom',
+  'importMeta',
+  'topLevelAwait',
+]
+
+const babelParseOpts = {
+  js: {
+    sourceType: 'unambiguous',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      ['flow', { all: true }],
+      'flowComments',
+      'jsx',
+    ],
+  },
+  jsx: {
+    sourceType: 'unambiguous',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      ['flow', { all: true }],
+      'flowComments',
+      'jsx',
+    ],
+  },
+  cjs: {
+    sourceType: 'commonjs',
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+  },
+  mjs: {
+    sourceType: 'module',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [...commonPlugins, ...modulePlugins],
+  },
+  ts: {
+    sourceType: 'unambiguous',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      'typescript',
+      'decorators-legacy',
+    ],
+  },
+  'd.ts': {
+    sourceType: 'unambiguous',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      ['typescript', { dts: true }],
+      'decorators-legacy',
+    ],
+  },
+  tsx: {
+    sourceType: 'unambiguous',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      'jsx',
+      'typescript',
+      'decorators-legacy',
+    ],
+  },
+  cts: {
+    sourceType: 'commonjs',
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [...commonPlugins, 'typescript', 'decorators-legacy'],
+  },
+  'd.cts': {
+    sourceType: 'commonjs',
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ['typescript', { dts: true }],
+      'decorators-legacy',
+    ],
+  },
+  mts: {
+    sourceType: 'module',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      'typescript',
+      'decorators-legacy',
+    ],
+  },
+  'd.mts': {
+    sourceType: 'module',
+    allowImportExportEverywhere: true,
+    allowReturnOutsideFunction: true,
+    startLine: 1,
+    plugins: [
+      ...commonPlugins,
+      ...modulePlugins,
+      ['typescript', { dts: true }],
+      'decorators-legacy',
+    ],
+  },
+}
+
+function getBabelParseOpts(file) {
+  const match = /\.(js|cjs|mjs|jsx|tsx|(d\.)?(ts|cts|mts))$/i.exec(file)
+  const ext = (match ? match[1] : undefined) || 'js'
+  return babelParseOpts[ext]
+}
+
+module.exports = getBabelParseOpts