@jcoreio/toolchain 5.2.0 → 5.3.0

package/eslintConfig.cjs

@@ -1,8 +1,3 @@
 const getPluginsArraySync = require('./util/getPluginsArraySync.cjs')
 
-module.exports = {
-  extends: [
-    ...getPluginsArraySync('getEslintExtends'),
-    require.resolve('eslint-config-prettier'),
-  ],
-}
+module.exports = [...getPluginsArraySync('getEslintConfigs')]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "base JS build toolchain",
   "repository": {
     "type": "git",
@@ -14,6 +14,12 @@
   },
   "homepage": "https://github.com/jcoreio/toolchains/tree/main/packages/base",
   "dependencies": {
+    "@babel/generator": "^7.27.0",
+    "@babel/parser": "^7.27.0",
+    "@babel/template": "^7.27.0",
+    "@babel/types": "^7.27.0",
+    "@eslint/compat": "^1.2.8",
+    "@eslint/js": "^9.23.0",
     "@jcoreio/eslint-plugin-implicit-dependencies": "^1.1.1",
     "chalk": "^4.0.0",
     "dedent-js": "^1.0.1",
@@ -23,6 +29,7 @@
     "find-up": "^5.0.0",
     "fs-extra": "^10.0.0",
     "glob": "^11.0.0",
+    "globals": "^16.0.0",
     "js-yaml": "4.1.0",
     "json5": "^2.2.1",
     "lint-staged": "^15.2.2",
@@ -43,13 +50,12 @@
     "packageManager": "pnpm@10.6.5",
     "devDependencies": {
       "eslint": "*",
-      "@jcoreio/eslint-plugin-implicit-dependencies": "*"
+      "globals": "*",
+      "lint-staged": "*",
+      "prettier": "*"
     }
   },
   "bin": {
-    "eslint": "./bin/eslint",
-    "lint-staged": "./bin/lint-staged",
-    "prettier": "./bin/prettier",
     "tc": "./scripts/toolchain.cjs",
     "toolchain": "./scripts/toolchain.cjs"
   },

package/plugins/getConfigFiles.cjs

@@ -1,23 +1,15 @@
 const { name } = require('../package.json')
 const dedent = require('dedent-js')
 const fs = require('../util/projectFs.cjs')
-const JSON5 = require('json5')
 const { isMonorepoSubpackage } = require('../util/findUps.cjs')
 const getPluginsArraySync = require('../util/getPluginsArraySync.cjs')
 const initBuildIgnore = require('../util/initBuildIgnore.cjs')
-
-async function getRootEslintConfig() {
-  if (await fs.pathExists('.eslintrc.json')) {
-    return JSON5.parse(await fs.readFile('.eslintrc.json', 'utf8'))
-  }
-  if (await fs.pathExists('.eslintrc')) {
-    return JSON5.parse(await fs.readFile('.eslintrc', 'utf8'))
-  }
-}
+const migrateLegacyEslintConfigs = require('../util/migrateLegacyEslintConfigs.cjs')
+const chalk = require('chalk')
+const { glob } = require('../util/glob.cjs')
 
 module.exports = [
   async function getConfigFiles({ fromVersion }) {
-    const { env, rules } = (await getRootEslintConfig()) || {}
     const files = {
       ...(isMonorepoSubpackage
         ? {}
@@ -26,29 +18,29 @@ module.exports = [
               optional=false
             `,
           }),
-      '.eslintrc.cjs': async (existing) =>
-        existing && fromVersion
-          ? existing
-          : dedent`
-        /* eslint-env node, es2018 */
-        module.exports = {
-          extends: [require.resolve('${name}/eslintConfig.cjs')],${
-            env
-              ? `\nenv: ${JSON.stringify(env, null, 2).replace(
-                  /\n/gm,
-                  '\n  '
-                )},`
-              : ''
-          }${
-            rules
-              ? `\nrules: ${JSON.stringify(rules, null, 2).replace(
-                  /\n/gm,
-                  '\n  '
-                )}`
-              : ''
+      'eslint.config.cjs': async (existing) => {
+        if (existing && fromVersion) return existing
+        const configs = {}
+        for (const file of await glob('**/.eslintrc{,.json,.js,.cjs}')) {
+          configs[file] = await fs.readFile(file)
+        }
+        const { migrated, warnings } = await migrateLegacyEslintConfigs(configs)
+        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  ')} 
+                  
+                `
+              )
+            )
           }
         }
-      `,
+        return migrated
+      },
       'toolchain.config.cjs': async (existing) => {
         if (existing) return existing
         return dedent`

package/plugins/getEslintConfigs.cjs

@@ -0,0 +1,105 @@
+const js = require('@eslint/js')
+const { defineConfig } = require('eslint/config')
+const { includeIgnoreFile } = require('@eslint/compat')
+const { projectDir } = require('../util/findUps.cjs')
+const path = require('path')
+const fs = require('../util/projectFs.cjs')
+const { globSync } = require('../util/glob.cjs')
+
+module.exports = [
+  () => {
+    const gitignores = globSync('**/.gitignore')
+    if (fs.pathExistsSync('.eslintignore')) {
+      gitignores.push('.eslintignore')
+    }
+    return defineConfig([
+      ...gitignores.map((file) =>
+        includeIgnoreFile(path.resolve(projectDir, file))
+      ),
+      js.configs.recommended,
+      {
+        files: ['**/*.{js,cjs,mjs}'],
+        plugins: {
+          '@jcoreio/implicit-dependencies': require('@jcoreio/eslint-plugin-implicit-dependencies'),
+        },
+        rules: {
+          '@jcoreio/implicit-dependencies/no-implicit': [
+            'error',
+            {
+              dev: true,
+              peer: true,
+              optional: true,
+            },
+          ],
+          'arrow-spacing': 'error',
+          'comma-spacing': 'error',
+          'computed-property-spacing': ['error', 'never'],
+          'eol-last': 'error',
+          'jsx-quotes': 'error',
+          'keyword-spacing': 'error',
+          'key-spacing': [
+            'error',
+            {
+              mode: 'strict',
+            },
+          ],
+          'linebreak-style': 'error',
+          'no-console': 'error',
+          'no-unused-vars': [
+            'error',
+            {
+              args: 'none',
+              varsIgnorePattern: 'React',
+            },
+          ],
+          'no-extra-semi': 'error',
+          'no-multi-spaces': 'error',
+          'no-multiple-empty-lines': 'error',
+          'no-trailing-spaces': 'error',
+          'no-unexpected-multiline': 'error',
+          'no-unreachable': 'error',
+          'no-whitespace-before-property': 'error',
+          'object-shorthand': ['error', 'always'],
+          'padded-blocks': ['error', 'never'],
+          semi: ['error', 'never'],
+          'space-before-blocks': ['error', 'always'],
+          'space-before-function-paren': [
+            'error',
+            {
+              anonymous: 'always',
+              named: 'never',
+            },
+          ],
+          'space-in-parens': ['error', 'never'],
+          'space-infix-ops': ['error', { int32Hint: false }],
+          'space-unary-ops': [
+            'error',
+            {
+              words: true,
+              nonwords: false,
+            },
+          ],
+          'rest-spread-spacing': ['error', 'never'],
+        },
+      },
+      {
+        files: ['src/**'],
+        ignores: ['**/__tests__/**'],
+        plugins: {
+          '@jcoreio/implicit-dependencies': require('@jcoreio/eslint-plugin-implicit-dependencies'),
+        },
+        rules: {
+          '@jcoreio/implicit-dependencies/no-implicit': [
+            'error',
+            {
+              dev: false,
+              peer: true,
+              optional: true,
+            },
+          ],
+        },
+      },
+      require('eslint-config-prettier'),
+    ])
+  },
+]

package/scripts/migrate/migrateEslintConfigs.cjs

@@ -1,26 +1,12 @@
 const { glob } = require('../../util/glob.cjs')
 const Path = require('path')
-const JSON5 = require('json5')
 const fs = require('../../util/projectFs.cjs')
 
 async function migrateEslintConfigs({ fromVersion }) {
-  if (fromVersion) {
-    // only do this migration on init
-    return
-  }
-  for (const file of await glob(Path.join('**', '.eslintrc{,.json}'))) {
-    const content = JSON5.parse(await fs.readFile(file, 'utf8'))
-    if (content.extends) {
-      delete content.extends
-      await fs.writeFile(file, JSON5.stringify(content, null, 2), 'utf8')
-    }
-  }
   for (const file of [
+    ...(await glob(Path.join('**', '.eslintrc{,.json}'))),
     '.eslintrc.js',
-    '.eslintrc.json',
-    '.eslintrc.yaml',
-    '.eslintrc.yml',
-    '.eslintrc',
+    '.eslintrc.cjs',
   ]) {
     const exists = await fs.pathExists(file)
     if (exists) {

package/scripts/migrate/migrateRemoveDevDeps.cjs

@@ -1,6 +1,7 @@
 module.exports = [
   '@babel/cli',
   '@babel/core',
+  '@babel/eslint-parser',
   '@babel/plugin-dynamic-import-node',
   '@babel/plugin-external-helpers',
   '@babel/plugin-proposal-class-properties',
@@ -41,6 +42,7 @@ module.exports = [
   '@commitlint/cli',
   '@commitlint/config-conventional',
   '@jcoreio/commitlint-config',
+  '@jcoreio/eslint-plugin-implicit-dependencies',
   '@jedwards1211/commitlint-config',
   '@jedwards1211/eslint-config-flow',
   '@jedwards1211/eslint-config-react',
@@ -52,6 +54,7 @@ module.exports = [
   '@semantic-release/release-notes-generator',
   '@typescript-eslint/eslint-plugin',
   '@typescript-eslint/parser',
+  '@typescript-eslint/typescript-estree',
   'babel-cli',
   'babel-core',
   'babel-eslint',
@@ -97,6 +100,10 @@ module.exports = [
   'cz-conventional-changelog',
   'coveralls',
   'eslint-watch',
+  'eslint-plugin-flowtype',
+  'eslint-plugin-ft-flow',
+  'eslint-plugin-no-only-tests',
+  'eslint-plugin-react',
   'flow-copy-source',
   'flow-watch',
   'husky',

package/scripts/runEslint.cjs

@@ -1,33 +1,7 @@
-const fs = require('../util/projectFs.cjs')
 const execa = require('../util/execa.cjs')
-const getPluginsArraySync = require('../util/getPluginsArraySync.cjs')
-
-async function eslintArgs() {
-  return [
-    ...((await fs.pathExists('.eslintignore')) ||
-    !(await fs.pathExists('.gitignore'))
-      ? []
-      : (await fs.readFile('.gitignore', 'utf8'))
-          .split(/\r\n?|\n/gm)
-          .flatMap((pattern) =>
-            !/^#/.test(pattern.trim())
-              ? ['--ignore-pattern', pattern.trim()]
-              : []
-          )),
-    '--ignore-pattern',
-    'flow-typed/',
-    '--ext',
-    getPluginsArraySync('lintExtensions').join(','),
-  ]
-}
 
 async function runEslint(args = []) {
-  await execa('eslint', [...args, ...(await eslintArgs())], {
-    env: {
-      ...process.env,
-      ESLINT_USE_FLAT_CONFIG: 'false',
-    },
-  })
+  await execa('eslint', [...args])
 }
 exports.runEslint = runEslint
 

package/util/migrateLegacyEslintConfigs.cjs

@@ -0,0 +1,218 @@
+const { name } = require('../package.json')
+const { format } = require('prettier')
+const prettierConfig = require('../prettier.config.cjs')
+const { statement, expression, default: template } = require('@babel/template')
+const { generate } = require('@babel/generator')
+const path = require('path')
+const t = require('@babel/types')
+
+const objectExpression = (props) =>
+  t.objectExpression(
+    Object.entries(props).flatMap(([key, value]) =>
+      value ? [t.objectProperty(t.identifier(key), value)] : []
+    )
+  )
+
+const idOrString = (value) =>
+  /^[_a-z$][_a-z0-9$]*$/.test(value)
+    ? t.identifier(value)
+    : t.stringLiteral(value)
+
+const member = (object, key) => {
+  const prop = idOrString(key)
+  return t.memberExpression(object, prop, prop.type !== 'Identifier')
+}
+
+function isSimpleObjectExpression(obj) {
+  return (
+    obj &&
+    obj.type === 'ObjectExpression' &&
+    obj.properties.every(
+      (p) =>
+        p.type === 'ObjectProperty' &&
+        !p.computed &&
+        (p.key.type === 'Identifier' || p.key.type === 'StringLiteral')
+    )
+  )
+}
+
+function decodeSimpleObjectExpression(obj) {
+  if (!isSimpleObjectExpression(obj)) {
+    throw new Error(
+      'obj is not an ObjectExpression containing only non-computed identifier- or string-keyed properties'
+    )
+  }
+  return Object.fromEntries(
+    obj.properties.map((p) => [
+      p.key.type === 'Identifier' ? p.key.name : p.key.value,
+      p.value,
+    ])
+  )
+}
+
+async function migrateLegacyEslintConfigs(configs) {
+  const body = [
+    statement.ast`const { defineConfig } = require('eslint/config')`,
+  ]
+  const warnings = {}
+  let importedGlobals = false
+
+  function importGlobals() {
+    if (importedGlobals) return
+    body.push(statement.ast`const globals = require('globals')`)
+    importedGlobals = true
+  }
+
+  const CONFIG = expression.ast(`[...require('${name}/eslintConfig.cjs')]`)
+  for (const [file, content] of Object.entries(configs)) {
+    function warn(warning) {
+      ;(warnings[file] || (warnings[file] = [])).push(warning)
+    }
+    if (/\.[cm]?js$/.test(file)) {
+      const { parse } = require('@babel/parser')
+      let parsed
+      try {
+        parsed = parse(content, { sourceType: 'unambiguous' })
+      } catch (error) {
+        warn(`parse error: ${error.message}`)
+        continue
+      }
+
+      const exportStatement = parsed.program.body.find(
+        (s) =>
+          s.type === 'ExpressionStatement' &&
+          s.expression.type === 'AssignmentExpression' &&
+          generate(s.expression.left).code === 'module.exports' &&
+          s.expression.right.type === 'ObjectExpression'
+      )
+      if (!exportStatement) {
+        warn('module.exports = statement not found')
+        continue
+      }
+      const config = exportStatement.expression.right
+
+      if (!isSimpleObjectExpression(config)) {
+        warn(
+          'config is not an ObjectExpression or has spread or computed properties'
+        )
+        continue
+      }
+      const {
+        extends: _extends,
+        env: _env,
+        rules,
+        ...rest
+      } = decodeSimpleObjectExpression(config)
+
+      for (const key of Object.keys(rest)) {
+        warn(
+          `migrating ${generate(member(t.identifier('config'), key)).code} is not currently supported`
+        )
+      }
+
+      if (_extends) {
+        const ext = generate(_extends).code
+        if (
+          ext !== `[require.resolve('@jcoreio/toolchain/eslintConfig.cjs')]` &&
+          ext !== `[require.resolve('@jcoreio/toolchain/eslint.config.cjs')]`
+        ) {
+          warn(
+            `config.extends has entries other than base @jcoreio/toolchain eslint config`
+          )
+        }
+      }
+      let env
+      if (_env) {
+        if (isSimpleObjectExpression(_env)) {
+          env = decodeSimpleObjectExpression(_env)
+          for (const key in env) {
+            if (env[key].type !== 'BooleanLiteral') {
+              warn(
+                `config.${generate(member(t.identifier('env'), key)).code} is not a boolean`
+              )
+              delete env[key]
+            }
+          }
+          if (!Object.keys(env).length) env = undefined
+        } else {
+          warn(
+            `config.env is not an ObjectExpression or has spread or computed properties`
+          )
+        }
+      }
+
+      if (!env && !rules) continue
+
+      if (env) importGlobals()
+
+      CONFIG.elements.push(
+        objectExpression({
+          files:
+            path.dirname(file) !== '.' &&
+            t.arrayExpression([t.stringLiteral(path.dirname(file) + '/**')]),
+          languageOptions:
+            env &&
+            objectExpression({
+              globals: t.objectExpression(
+                Object.keys(env).map((key) =>
+                  t.spreadElement(member(t.identifier('globals'), key))
+                )
+              ),
+            }),
+          rules,
+        })
+      )
+    } else {
+      const JSON5 = require('json5')
+
+      const props = JSON5.parse(content)
+      const { env, rules, ...rest } = props
+
+      for (const key of Object.keys(rest)) {
+        warn(
+          `migrating ${generate(member(t.identifier('config'), key)).code} is not currently supported`
+        )
+      }
+
+      if (!env && !rules) continue
+
+      if (env) importGlobals()
+
+      CONFIG.elements.push(
+        objectExpression({
+          files:
+            path.dirname(file) !== '.' &&
+            t.arrayExpression([t.stringLiteral(path.dirname(file) + '/**')]),
+          rules: rules && expression.ast(JSON.stringify(rules)),
+          languageOptions:
+            env &&
+            objectExpression({
+              globals: t.objectExpression(
+                Object.keys(env).map((key) =>
+                  t.spreadElement(member(t.identifier('globals'), key))
+                )
+              ),
+            }),
+        })
+      )
+    }
+  }
+
+  body.push(template`module.exports = defineConfig(CONFIG)`({ CONFIG }))
+
+  return {
+    migrated: await format(
+      generate(t.program(body)).code.replace(
+        /^module\.exports/m,
+        '\nmodule.exports'
+      ),
+      {
+        ...prettierConfig,
+        parser: 'babel',
+      }
+    ),
+    warnings,
+  }
+}
+
+module.exports = migrateLegacyEslintConfigs

package/bin/eslint

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
-
-exec $(node "$basedir/resolveBin.cjs" eslint) "$@"

package/bin/lint-fix.cjs

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-require('../scripts/runEslint.cjs')
-  .eslintFix()
-  .then(
-    () => process.exit(0),
-    (error) => process.exit(error.code != null ? error.code : 1)
-  )

package/bin/lint-staged

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
-
-exec $(node "$basedir/resolveBin.cjs" lint-staged) "$@"

package/bin/prettier

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
-
-exec $(node "$basedir/resolveBin.cjs" prettier) "$@"

package/bin/resolveBin.cjs

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-process.stdout.write(
-  require('resolve-bin').sync(
-    process.argv[2],
-    process.argv[3] ? { executable: process.argv[3] } : {}
-  )
-)

package/bin/semantic-release

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
-
-exec $(node "$basedir/resolveBin.cjs" semantic-release) "$@"

package/eslint.extends.cjs

@@ -1,79 +0,0 @@
-module.exports = {
-  extends: ['eslint:recommended'],
-  plugins: ['@jcoreio/eslint-plugin-implicit-dependencies'],
-  rules: {
-    '@jcoreio/implicit-dependencies/no-implicit': [
-      'error',
-      {
-        dev: true,
-        peer: true,
-        optional: true,
-      },
-    ],
-    'arrow-spacing': 'error',
-    'comma-spacing': 'error',
-    'computed-property-spacing': ['error', 'never'],
-    'eol-last': 'error',
-    'jsx-quotes': 'error',
-    'keyword-spacing': 'error',
-    'key-spacing': [
-      'error',
-      {
-        mode: 'strict',
-      },
-    ],
-    'linebreak-style': 'error',
-    'no-console': 'error',
-    'no-unused-vars': [
-      'error',
-      {
-        args: 'none',
-        varsIgnorePattern: 'React',
-      },
-    ],
-    'no-extra-semi': 'error',
-    'no-multi-spaces': 'error',
-    'no-multiple-empty-lines': 'error',
-    'no-trailing-spaces': 'error',
-    'no-unexpected-multiline': 'error',
-    'no-unreachable': 'error',
-    'no-whitespace-before-property': 'error',
-    'object-shorthand': ['error', 'always'],
-    'padded-blocks': ['error', 'never'],
-    semi: ['error', 'never'],
-    'space-before-blocks': ['error', 'always'],
-    'space-before-function-paren': [
-      'error',
-      {
-        anonymous: 'always',
-        named: 'never',
-      },
-    ],
-    'space-in-parens': ['error', 'never'],
-    'space-infix-ops': ['error', { int32Hint: false }],
-    'space-unary-ops': [
-      'error',
-      {
-        words: true,
-        nonwords: false,
-      },
-    ],
-    'rest-spread-spacing': ['error', 'never'],
-  },
-  overrides: [
-    {
-      files: ['src/**'],
-      excludedFiles: ['**/__tests__/**'],
-      rules: {
-        '@jcoreio/implicit-dependencies/no-implicit': [
-          'error',
-          {
-            dev: false,
-            peer: true,
-            optional: true,
-          },
-        ],
-      },
-    },
-  ],
-}

package/plugins/getEslintExtends.cjs

@@ -1 +0,0 @@
-module.exports = [() => [require.resolve('../eslint.extends.cjs')]]