@jcoreio/toolchain 4.6.1 → 4.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "description": "base JS build toolchain",
   "repository": {
     "type": "git",

package/plugins/getConfigFiles.cjs

@@ -15,7 +15,7 @@ async function getRootEslintConfig() {
 }
 
 module.exports = [
-  async function getConfigFiles() {
+  async function getConfigFiles({ fromVersion }) {
     const { env, rules } = (await getRootEslintConfig()) || {}
     const files = {
       ...(isMonorepoSubpackage
@@ -25,12 +25,9 @@ module.exports = [
               optional=false
             `,
           }),
-      '.eslintrc.cjs': (prev) =>
-        prev
-          ? prev.replace(
-              new RegExp(`${name}/eslint\\.config\\.cjs`, 'g'),
-              `${name}/eslintConfig.cjs`
-            )
+      '.eslintrc.cjs': async (existing) =>
+        existing && fromVersion
+          ? existing
           : dedent`
         /* eslint-env node, es2018 */
         module.exports = {
@@ -72,7 +69,10 @@ module.exports = [
       'lint-staged.config.cjs',
       'prettier.config.cjs',
     ]) {
-      files[file] = dedent`
+      files[file] = async (existing) =>
+        existing && fromVersion
+          ? existing
+          : dedent`
         /* eslint-env node, es2018 */
         const base = require('${name}/${file}')
         module.exports = {
@@ -89,24 +89,30 @@ module.exports = [
       : await getPluginsArraySync('vscodeLaunch')
 
     if (tasks.length) {
-      files['.vscode/tasks.json'] = JSON.stringify(
-        {
-          version: '2.0.0',
-          tasks,
-        },
-        null,
-        2
-      )
+      files['.vscode/tasks.json'] = async (existing) =>
+        existing && fromVersion
+          ? existing
+          : JSON.stringify(
+              {
+                version: '2.0.0',
+                tasks,
+              },
+              null,
+              2
+            )
     }
     if (launch.length) {
-      files['.vscode/launch.json'] = JSON.stringify(
-        {
-          version: '0.2.0',
-          configurations: launch,
-        },
-        null,
-        2
-      )
+      files['.vscode/launch.json'] = async (existing) =>
+        existing && fromVersion
+          ? existing
+          : JSON.stringify(
+              {
+                version: '0.2.0',
+                configurations: launch,
+              },
+              null,
+              2
+            )
     }
 
     return files

package/scripts/migrate/migrateConfigFiles.cjs

@@ -3,8 +3,8 @@ const path = require('path')
 const getPluginsObjectAsync = require('../../util/getPluginsObjectAsync.cjs')
 const { name } = require('../../package.json')
 
-async function migrateConfigFiles() {
-  const files = await getPluginsObjectAsync('getConfigFiles')
+async function migrateConfigFiles({ fromVersion }) {
+  const files = await getPluginsObjectAsync('getConfigFiles', { fromVersion })
   for (const file in files) {
     const value = files[file]
     let content, overwrite

package/scripts/migrate/migrateEslintConfigs.cjs

@@ -3,7 +3,11 @@ const Path = require('path')
 const JSON5 = require('json5')
 const fs = require('../../util/projectFs.cjs')
 
-async function migrateEslintConfigs() {
+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) {

package/scripts/migrate/migrateGitignore.cjs

@@ -1,7 +1,7 @@
 const execa = require('../../util/execa.cjs')
 const fs = require('../../util/projectFs.cjs')
 
-async function migrateGitignore() {
+async function migrateGitignore({ fromVersion }) {
   const paths = {
     '/dist': 'dist',
     '.nyc_output': '.nyc_output',

package/scripts/migrate/migrateProjectPackageJson.cjs

@@ -12,60 +12,69 @@ const confirm = require('../../util/confirm.cjs')
 const unset = require('../../util/unset.cjs')
 const merge = require('../../util/merge.cjs')
 
-async function migrateProjectPackageJson() {
+async function migrateProjectPackageJson({ fromVersion }) {
   const packageJson = await fs.readJson('package.json')
   const devDependencies =
     packageJson.devDependencies || (packageJson.devDependencies = {})
 
-  await getPluginsAsyncFunction('migrateProjectPackageJson')(packageJson)
+  await getPluginsAsyncFunction('migrateProjectPackageJson')(packageJson, {
+    fromVersion,
+  })
 
-  for (const path of [
-    'commitlint',
-    'config.commitizen',
-    'config.eslint',
-    'config.lint',
-    'config.mocha',
-    'config.prettier',
-    'eslintConfig',
-    'files',
-    'husky',
-    'husky',
-    'lint-staged',
-    'nyc',
-    'prettier',
-    'renovate',
-    'scripts.build:cjs',
-    'scripts.build:js',
-    'scripts.build:mjs',
-    'scripts.build:types',
-    'scripts.build',
-    'scripts.clean',
-    'scripts.codecov',
-    'scripts.coverage',
-    'scripts.commitmsg',
-    'scripts.flow:coverage',
-    'scripts.flow:watch',
-    'scripts.flow',
-    'scripts.lint:fix',
-    'scripts.lint:watch',
-    'scripts.lint',
-    'scripts.open:coverage',
-    'scripts.precommit',
-    'scripts.prepublishOnly',
-    'scripts.prepush',
-    'scripts.prettier:check',
-    'scripts.prettier',
-    'scripts.semantic-release',
-    'scripts.test:debug',
-    'scripts.test:watch',
-    'scripts.test',
-    'scripts.travis-deploy-once',
-    'scripts.tsc:watch',
-    'scripts.tsc',
-  ]) {
-    unset(packageJson, path)
+  if (!fromVersion) {
+    for (const path of [
+      'commitlint',
+      'config.commitizen',
+      'config.eslint',
+      'config.lint',
+      'config.mocha',
+      'config.prettier',
+      'eslintConfig',
+      'files',
+      'husky',
+      'husky',
+      'lint-staged',
+      'nyc',
+      'prettier',
+      'renovate',
+      'scripts.build:cjs',
+      'scripts.build:js',
+      'scripts.build:mjs',
+      'scripts.build:types',
+      'scripts.build',
+      'scripts.clean',
+      'scripts.codecov',
+      'scripts.coverage',
+      'scripts.commitmsg',
+      'scripts.flow:coverage',
+      'scripts.flow:watch',
+      'scripts.flow',
+      'scripts.lint:fix',
+      'scripts.lint:watch',
+      'scripts.lint',
+      'scripts.open:coverage',
+      'scripts.precommit',
+      'scripts.prepublishOnly',
+      'scripts.prepush',
+      'scripts.prettier:check',
+      'scripts.prettier',
+      'scripts.semantic-release',
+      'scripts.test:debug',
+      'scripts.test:watch',
+      'scripts.test',
+      'scripts.travis-deploy-once',
+      'scripts.tsc:watch',
+      'scripts.tsc',
+    ]) {
+      unset(packageJson, path)
+    }
   }
-  if (!packageJson.main && !packageJson.exports && !packageJson.module) {
+  if (
+    !fromVersion &&
+    !packageJson.main &&
+    !packageJson.exports &&
+    !packageJson.module
+  ) {
     const hasIndexTypes =
       (await fs.pathExists(Path.join('src', 'index.ts'))) ||
       (await fs.pathExists(Path.join('src', 'index.tsx'))) ||
@@ -79,59 +88,68 @@ async function migrateProjectPackageJson() {
     if (hasIndexTypes) {
       packageJson.types = 'dist/index.d.ts'
     }
-  }
-  for (const dep of require('./migrateRemoveDevDeps.cjs')) {
-    delete devDependencies[dep]
-  }
 
-  if (!packageJson.exports && packageJson.main) {
-    const relativize = (p) => (p.startsWith('.') ? p : `./${p}`)
+    for (const dep of require('./migrateRemoveDevDeps.cjs')) {
+      delete devDependencies[dep]
+    }
 
-    const dotStar = await confirm({
-      type: 'confirm',
-      initial: true,
-      ifNotInteractive: false,
-      message: 'Add ./* exports map to package.json?',
-    })
-    const outputEsm = await confirmOutputEsm()
-    packageJson.exports = {
-      './package.json': './package.json',
-      '.': {
-        ...(packageJson.types ? { types: relativize(packageJson.types) } : {}),
-        ...(outputEsm !== false && packageJson.module
-          ? { import: relativize(packageJson.module) }
+    if (
+      semver.lt(fromVersion || '0.0.0', '3.0.0') &&
+      !packageJson.exports &&
+      packageJson.main
+    ) {
+      const relativize = (p) => (p.startsWith('.') ? p : `./${p}`)
+
+      const dotStar = await confirm({
+        type: 'confirm',
+        initial: true,
+        ifNotInteractive: false,
+        message: 'Add ./* exports map to package.json?',
+      })
+      const outputEsm = await confirmOutputEsm()
+      packageJson.exports = {
+        './package.json': './package.json',
+        '.': {
+          ...(packageJson.types
+            ? { types: relativize(packageJson.types) }
+            : {}),
+          ...(outputEsm !== false && packageJson.module
+            ? { import: relativize(packageJson.module) }
+            : {}),
+          default: relativize(packageJson.main),
+        },
+        ...(dotStar
+          ? {
+              './*': {
+                types: './*.d.ts',
+                ...(outputEsm !== false ? { import: './*.mjs' } : {}),
+                default: './*.js',
+              },
+            }
           : {}),
-        default: relativize(packageJson.main),
-      },
-      ...(dotStar
-        ? {
-            './*': {
-              types: './*.d.ts',
-              ...(outputEsm !== false ? { import: './*.mjs' } : {}),
-              default: './*.js',
-            },
-          }
-        : {}),
+      }
     }
   }
 
   merge(
     packageJson,
-    {
-      version: '0.0.0-development',
-      sideEffects: false,
-      scripts: {
-        tc: 'toolchain',
-        toolchain: 'toolchain',
-        test: 'toolchain test',
-        prepublishOnly:
-          'echo This package is meant to be published by semantic-release from the dist build directory. && exit 1',
-      },
-    },
+    fromVersion
+      ? {}
+      : {
+          version: '0.0.0-development',
+          sideEffects: false,
+          scripts: {
+            tc: 'toolchain',
+            toolchain: 'toolchain',
+            test: 'toolchain test',
+            prepublishOnly:
+              'echo This package is meant to be published by semantic-release from the dist build directory. && exit 1',
+          },
+        },
     pick(toolchainManaged, 'engines', 'packageManager'),
     pick(packageJson, 'engines')
   )
-  if (isEmpty(packageJson.config)) delete packageJson.config
+  if (!fromVersion && isEmpty(packageJson.config)) delete packageJson.config
 
   const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
 

package/scripts/migrate.cjs

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+const { packageJson } = require('../util/findUps.cjs')
+const { name } = require('../package.json')
 const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
 
 async function migrate(args = []) {
@@ -16,20 +18,26 @@ async function migrate(args = []) {
   const migrateMoveTypeDefs = require('./migrate/migrateMoveTypeDefs.cjs')
   const migrateGitignore = require('./migrate/migrateGitignore.cjs')
   const hasYarnOrNpmLockfile = require('../util/hasYarnOrNpmLockfile.cjs')
+  const writeMigratedVersion = require('../util/writeMigratedVersion.cjs')
 
-  if (!isMonorepoSubpackage && !findGitDir()) {
+  const fromVersion = packageJson[name]
+    ? packageJson[name].migratedVersion
+    : undefined
+  if (!fromVersion && !isMonorepoSubpackage && !findGitDir()) {
     await execa('git', ['init'])
     await installGitHooks.run()
   }
-  await migrateProjectPackageJson()
+  await migrateProjectPackageJson({ fromVersion })
   if (await hasYarnOrNpmLockfile()) {
     await execa('pnpm', ['import'])
   }
-  await migrateConfigFiles()
-  await migrateEslintConfigs()
-  await migrateMoveTypeDefs()
-  await migrateGitignore()
-  await getPluginsAsyncFunction('migrate')(args)
+  await migrateConfigFiles({ fromVersion })
+  await migrateEslintConfigs({ fromVersion })
+  if (!fromVersion) await migrateMoveTypeDefs()
+  await migrateGitignore({ fromVersion })
+  await getPluginsAsyncFunction('migrate')(args, { fromVersion })
+
+  await writeMigratedVersion()
 
   if (!args.includes('--config-only')) {
     await execa('pnpm', [

package/scripts/upgrade.cjs

@@ -6,6 +6,7 @@ const {
   monorepoSubpackageJsons,
 } = require('../util/findUps.cjs')
 const execa = require('../util/execa.cjs')
+const writeMigratedVersion = require('../util/writeMigratedVersion.cjs')
 const { name } = require('../package.json')
 
 async function upgrade([version] = []) {
@@ -16,6 +17,9 @@ async function upgrade([version] = []) {
         .filter((pkg) => pkg.startsWith(`${name}-`))
     ),
   ]
+  if (!packageJson[name] || !packageJson[name].migratedVersion) {
+    await writeMigratedVersion()
+  }
   const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
 
   if (!isTest && !version) {

package/util/writeMigratedVersion.cjs

@@ -0,0 +1,19 @@
+const fs = require('../util/projectFs.cjs')
+const { name, version: currentVersion } = require('../package.json')
+
+module.exports = async function writeMigratedVersion() {
+  const packageJson = await fs.readJson('package.json')
+  if (packageJson[name] && packageJson[name].migratedVersion === currentVersion)
+    return
+  await fs.writeJson(
+    'package.json',
+    {
+      ...packageJson,
+      [name]: {
+        ...packageJson[name],
+        migratedVersion: currentVersion,
+      },
+    },
+    { spaces: 2 }
+  )
+}

package/scripts/migrate/migrateRemoveFiles.cjs

@@ -1,43 +0,0 @@
-module.exports = [
-  '.babelrc.js',
-  '.babelrc.json',
-  '.babelrc.mjs',
-  '.babelrc',
-  'babel.config.cjs',
-  'babel.config.js',
-  'babel.config.json',
-  'babel.config.mjs',
-  '.commitlintrc.js',
-  '.commitlintrc.json',
-  '.commitlintrc.yml',
-  'commitlint.config.js',
-  'husky.config.js',
-  '.lintstagedrc',
-  'lint-staged.config.js',
-  '.nycrc.json',
-  '.nycrc.yaml',
-  '.nycrc.yml',
-  '.nycrc',
-  'nyc.config.js',
-  '.prettierrc.cjs',
-  '.prettierrc.js',
-  '.prettierrc.json',
-  '.prettierrc.json5',
-  '.prettierrc.toml',
-  '.prettierrc.yaml',
-  '.prettierrc.yml',
-  '.prettierrc',
-  'prettier.config.js',
-  'package-lock.json',
-  '.github/renovate.json',
-  '.github/renovate.json5',
-  '.gitlab/renovate.json',
-  '.gitlab/renovate.json5',
-  '.renovaterc.json',
-  '.renovaterc',
-  'renovate.json',
-  'renovate.json5',
-  'solano.yml',
-  '.travis.yml',
-  'yarn.lock',
-]