@jcoreio/toolchain 1.0.0-beta.8 → 1.0.0

package/githooks/runHook.cjs

@@ -2,7 +2,7 @@ const Path = require('path')
 const { findGitDir } = require('../util/findUps.cjs')
 const execa = require('../util/execa.cjs')
 
-module.exports = async function runHook(hook) {
+module.exports = async function runHook(hookName) {
   try {
     const gitDir = findGitDir()
     if (!gitDir) {
@@ -16,9 +16,13 @@ module.exports = async function runHook(hook) {
     } catch (error) {
       hooks = require('../githooks.cjs')
     }
+    const hook = hooks[hookName]
+    if (!hook) return
 
-    if (hooks[hook]) {
-      await execa(hooks[hook], {
+    if (typeof hook === 'function') {
+      await hook()
+    } else if (hook) {
+      await execa(hook, {
         cwd: projDir,
         shell: true,
       })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "description": "base JS build toolchain",
   "repository": {
     "type": "git",
@@ -14,10 +14,6 @@
   },
   "homepage": "https://github.com/jcoreio/toolchains/tree/beta/packages/base",
   "dependencies": {
-    "@semantic-release/commit-analyzer": "^9.0.2",
-    "@semantic-release/github": "^8.0.4",
-    "@semantic-release/npm": "^10.0.4",
-    "@semantic-release/release-notes-generator": "^10.0.3",
     "chalk": "^4.0.0",
     "dedent-js": "^1.0.1",
     "eslint": "^8.43.0",
@@ -31,12 +27,15 @@
     "open": "^8.4.0",
     "prettier": "^2.5.1",
     "resolve-bin": "^1.0.0",
-    "semantic-release": "^21.0.5",
     "semver": "^7.5.3",
     "toposort": "^2.0.2",
     "zod": "^3.21.4"
   },
   "toolchainManaged": {
+    "engines": {
+      "node": ">=16"
+    },
+    "packageManager": "pnpm@8.3.1",
     "devDependencies": {
       "eslint": "*"
     }
@@ -45,7 +44,6 @@
     "eslint": "./bin/eslint",
     "lint-staged": "./bin/lint-staged",
     "prettier": "./bin/prettier",
-    "semantic-release": "./bin/semantic-release",
     "tc": "./scripts/toolchain.cjs",
     "toolchain": "./scripts/toolchain.cjs"
   },

package/plugins/getConfigFiles.cjs

@@ -30,12 +30,6 @@ module.exports = [
       }
         }
       `,
-      'release.config.js': dedent`
-        /* eslint-env node, es2018 */
-        module.exports = {
-          extends: [require.resolve('${name}/release.config.cjs')],
-        }
-      `,
     }
     for (const file of [
       'githooks.cjs',

package/scripts/bootstrap/bootstrapConfigFiles.cjs

@@ -1,19 +1,28 @@
 const fs = require('../../util/projectFs.cjs')
-const getPluginsObject = require('../../util/getPluginsObject.cjs')
+const path = require('path')
+const getPluginsObjectAsync = require('../../util/getPluginsObjectAsync.cjs')
 const { name } = require('../../package.json')
 
 async function bootstrapConfigFiles() {
-  const files = await getPluginsObject('getConfigFiles')
+  const files = await getPluginsObjectAsync('getConfigFiles')
   for (const file in files) {
     const value = files[file]
-    const content = typeof value === 'string' ? value : value.content
-    const overwrite = typeof value === 'string' ? false : value.overwrite
+    let content, overwrite
+    if (typeof value === 'function') {
+      const prev = await fs.readFile(file, 'utf8').catch(() => undefined)
+      content = await value(prev)
+      overwrite = content !== prev
+    } else {
+      content = typeof value === 'string' ? value : value.content
+      overwrite = typeof value === 'string' ? false : value.overwrite
+    }
     if (
       overwrite === true ||
       !(await fs.pathExists(file)) ||
       (content.includes(name) &&
         !(await fs.readFile(file, 'utf8')).includes(name))
     ) {
+      await fs.mkdirs(path.dirname(file))
       await fs.writeFile(file, content, 'utf8')
       // eslint-disable-next-line no-console
       console.error(`wrote ${file}`)

package/scripts/bootstrap/bootstrapProjectPackageJson.cjs

@@ -1,9 +1,10 @@
-const { name } = require('../../package.json')
-const { projectDir, toolchainPackages } = require('../../util/findUps.cjs')
+const { toolchainManaged } = require('../../util/findUps.cjs')
 const getPluginsAsyncFunction = require('../../util/getPluginsAsyncFunction.cjs')
 const fs = require('../../util/projectFs.cjs')
 const sortDeps = require('../../util/sortDeps.cjs')
 const semver = require('semver')
+const isEmpty = require('lodash/isEmpty')
+const pick = require('lodash/pick')
 
 async function bootstrapProjectPackageJson() {
   const { merge, unset } = require('lodash')
@@ -12,41 +13,54 @@ async function bootstrapProjectPackageJson() {
   const devDependencies =
     packageJson.devDependencies || (packageJson.devDependencies = {})
 
-  const toolchainManaged = {}
-  for (const pkg of toolchainPackages) {
-    const toolchainPkgJson = require(require.resolve(`${pkg}/package.json`, {
-      paths: [projectDir],
-    }))
-    const toolchainPkgDeps = toolchainPkgJson.dependencies || {}
-    const toolchainPkgDevDeps = toolchainPkgJson.devDependencies || {}
-    if (toolchainPkgJson.toolchainManaged) {
-      for (const section in toolchainPkgJson.toolchainManaged) {
-        const sectionDeps = toolchainPkgJson.toolchainManaged[section]
-        if (!toolchainManaged[section]) toolchainManaged[section] = {}
-        for (const dep in sectionDeps) {
-          let version = sectionDeps[dep]
-          if (version === '*')
-            version = toolchainPkgDevDeps[dep] || toolchainPkgDeps[dep]
-          if (version !== '*') toolchainManaged[section][dep] = version
-        }
-      }
-    }
-  }
+  await getPluginsAsyncFunction('bootstrapProjectPackageJson')(packageJson)
 
   for (const path of [
-    'exports',
+    'commitlint',
+    'config.commitizen',
+    'config.eslint',
+    'config.lint',
+    'config.mocha',
+    'config.prettier',
     'eslintConfig',
+    'exports',
     'files',
     'husky',
+    'husky',
+    'lint-staged',
     'main',
     'module',
-    'renovate',
-    'prettier',
-    'commitlint',
-    'lint-staged',
     'nyc',
-    'husky',
-    'config.mocha',
+    '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:wath',
+    'scripts.tsc',
   ]) {
     unset(packageJson, path)
   }
@@ -54,22 +68,26 @@ async function bootstrapProjectPackageJson() {
     delete devDependencies[dep]
   }
 
-  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',
-    },
-    config: {
-      commitizen: { path: `${name}/commitizen.cjs` },
+  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',
+      },
     },
-  })
+    pick(toolchainManaged, 'engines', 'packageManager'),
+    pick(packageJson, 'engines')
+  )
+  if (isEmpty(packageJson.config)) delete packageJson.config
 
   for (const section in toolchainManaged) {
+    if (!section.endsWith('ependencies')) continue
     const managedSection = toolchainManaged[section]
     const pkgSectionName = section.replace(/^optionalD/, 'd')
     let pkgSection = packageJson[pkgSectionName]
@@ -82,18 +100,13 @@ async function bootstrapProjectPackageJson() {
       const versionRange = managedSection[dep]
       if (
         !pkgSection[dep] ||
-        semver.gt(
-          versionRange.replace(/^\D+/, ''),
-          pkgSection[dep].replace(/^\D+/, '')
-        )
+        !semver.satisfies(semver.minVersion(pkgSection[dep]), versionRange)
       ) {
         pkgSection[dep] = versionRange
       }
     }
   }
 
-  await getPluginsAsyncFunction('bootstrapProjectPackageJson')(packageJson)
-
   sortDeps(packageJson)
 
   await fs.writeJson('package.json', packageJson, { spaces: 2 })

package/scripts/bootstrap/bootstrapRemoveFiles.cjs

@@ -13,6 +13,7 @@ module.exports = [
   'commitlint.config.js',
   '.eslintignore',
   '.gitignore',
+  'husky.config.js',
   '.lintstagedrc',
   'lint-staged.config.js',
   '.npmignore',

package/scripts/bootstrap.cjs

@@ -5,7 +5,7 @@ const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
 
 async function bootstrap(args = []) {
   const execa = require('../util/execa.cjs')
-  const installGitHooks = require('./bootstrap/installGitHooks.cjs')
+  const installGitHooks = require('./install-git-hooks.cjs')
   const bootstrapProjectPackageJson = require('./bootstrap/bootstrapProjectPackageJson.cjs')
   const bootstrapEslintConfigs = require('./bootstrap/bootstrapEslintConfigs.cjs')
   const bootstrapConfigFiles = require('./bootstrap/bootstrapConfigFiles.cjs')
@@ -15,7 +15,7 @@ async function bootstrap(args = []) {
   const hasYarnOrNpmLockfile = require('../util/hasYarnOrNpmLockfile.cjs')
 
   await execa('git', ['init'])
-  await installGitHooks()
+  await installGitHooks.run()
   await bootstrapProjectPackageJson()
   if (await hasYarnOrNpmLockfile()) {
     await execa('pnpm', ['import'])

package/scripts/check.cjs

@@ -8,8 +8,9 @@ const fs = require('../util/projectFs.cjs')
 exports.run = async function check(args = []) {
   await require('../scripts/runPrettier.cjs').prettierCheck(args)
   await require('../scripts/runEslint.cjs').eslintCheck(args)
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
   if (devDependencies['flow-bin'] && (await fs.pathExists('.flowconfig'))) {
-    await execa('flow')
+    await execa('flow', isTest ? ['check'] : [])
   }
   if (devDependencies['typescript'] && (await fs.pathExists('tsconfig.json'))) {
     await execa('tsc', ['--noEmit'])

package/scripts/init.cjs

@@ -10,17 +10,22 @@ async function init(args = []) {
   const toolchains = []
   const isBabel =
     devDependencies['@babel/core'] != null ||
-    devDependencies['babel-core'] != null
+    devDependencies['babel-core'] != null ||
+    devDependencies['@jcoreio/toolchain-esnext'] != null
   const isTS = await hasTSFiles()
   const isFlow = isBabel && devDependencies['flow-bin'] != null
   const isReact = dependencies.react != null || devDependencies.react != null
   const isMocha = devDependencies['mocha'] != null
+  const isCircle = true // might be false someday
+  const isSemanticRelease = devDependencies['semantic-release'] != null
 
   if (isMocha) toolchains.push('@jcoreio/toolchain-mocha')
   if (isBabel) toolchains.push('@jcoreio/toolchain-esnext')
   if (isFlow) toolchains.push('@jcoreio/toolchain-flow')
   if (isTS) toolchains.push('@jcoreio/toolchain-typescript')
   if (isReact) toolchains.push('@jcoreio/toolchain-react')
+  if (isCircle) toolchains.push('@jcoreio/toolchain-circle')
+  if (isSemanticRelease) toolchains.push('@jcoreio/toolchain-semantic-release')
 
   const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
 

package/scripts/{bootstrap/installGitHooks.cjs → install-git-hooks.cjs}

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
-const execa = require('../../util/execa.cjs')
+const execa = require('../util/execa.cjs')
 const Path = require('path')
 const dedent = require('dedent-js')
-const { findGitDir } = require('../../util/findUps.cjs')
+const { findGitDir } = require('../util/findUps.cjs')
 const fs = require('fs-extra')
 
-const githooksDir = Path.resolve(__dirname, '..', '..', 'githooks')
+const githooksDir = Path.resolve(__dirname, '..', 'githooks')
 
 async function installGitHooks() {
   const gitDir = findGitDir()
@@ -15,7 +15,7 @@ async function installGitHooks() {
     console.warn(dedent`
       .git directory not found!
       git hooks could not be installed.
-      after you run \`git init\`, try \`pnpm exec install-git-hooks\`.
+      after you run \`git init\`, try \`pnpm tc install-git-hooks\`.
     `)
   } else {
     // chmod in case pnpm doesn't preserve mode of hooks scripts
@@ -34,4 +34,6 @@ async function installGitHooks() {
   }
 }
 
-module.exports = installGitHooks
+exports.description = 'install git hooks'
+
+exports.run = installGitHooks

package/scripts/prepublish.cjs

@@ -1,10 +1,10 @@
 const check = require('./check.cjs')
-const coverage = require('./coverage.cjs')
 const build = require('./build.cjs')
 
 exports.run = async function (args = []) {
   await check.run()
-  await coverage.run()
+  const { scripts } = require('./toolchain.cjs')
+  if (scripts.coverage) await scripts.coverage.run()
   await build.run()
 }
 

package/scripts/toolchain.cjs

@@ -2,13 +2,13 @@
 
 const { name, version } = require('../package.json')
 const chalk = require('chalk')
+const getPluginsObjectSync = require('../util/getPluginsObjectSync.cjs')
 
 const scripts = {
   bootstrap: require('./bootstrap.cjs'),
   build: require('./build.cjs'),
   check: require('./check.cjs'),
   clean: require('./clean.cjs'),
-  coverage: require('./coverage.cjs'),
   format: require('./format.cjs'),
   init: require('./init.cjs'),
   preinstall: require('./preinstall.cjs'),
@@ -16,7 +16,6 @@ const scripts = {
   'lint:fix': require('./lint-fix.cjs'),
   'open:coverage': require('./open-coverage.cjs'),
   prepublish: require('./prepublish.cjs'),
-  test: require('./test.cjs'),
   version: {
     description: `print version of ${name}`,
     run: () => {
@@ -24,6 +23,8 @@ const scripts = {
       console.log(`${name}@${version}`)
     },
   },
+  'install-git-hooks': require('./install-git-hooks.cjs'),
+  ...getPluginsObjectSync('scripts'),
 }
 
 exports.scripts = scripts

package/util/execa.cjs

@@ -14,7 +14,7 @@ function extractCommand(command) {
   return match ? match[0] : command
 }
 
-module.exports = async function defaultExeca(command, args, options, ...rest) {
+function getExecaArgs(command, args, options, ...rest) {
   if (args instanceof Object && !Array.isArray(args)) {
     options = args
     args = []
@@ -46,27 +46,53 @@ module.exports = async function defaultExeca(command, args, options, ...rest) {
     },
   }
 
-  const child = execa(command, args, opts, ...rest)
-  child.then(
+  return [command, args, opts, ...rest]
+}
+
+function convertExecaError(command, error) {
+  const { code, signal } = error
+  if (code) {
+    error.message = chalk`{red ✖} {bold ${extractCommand(
+      command
+    )}} exited with code ${code}`
+  }
+  if (signal) {
+    error.message = chalk`{red ✖} {bold ${extractCommand(
+      command
+    )}} was killed with signal ${signal}`
+  }
+  return error
+}
+
+function logSuccess(command) {
+  // eslint-disable-next-line no-console
+  console.error(
+    chalk`{green ✔} {bold ${extractCommand(command)}} exited with code 0`
+  )
+}
+
+function defaultExeca(command, args, options, ...rest) {
+  return execa(...getExecaArgs(command, args, options, ...rest)).then(
     (result) => {
-      // eslint-disable-next-line no-console
-      console.error(
-        chalk`{green ✔} {bold ${extractCommand(command)}} exited with code 0`
-      )
+      logSuccess(command)
+      return result
     },
     (error) => {
-      const { code, signal } = error
-      if (code) {
-        error.message = chalk`{red ✖} {bold ${extractCommand(
-          command
-        )}} exited with code ${code}`
-      }
-      if (signal) {
-        error.message = chalk`{red ✖} {bold ${extractCommand(
-          command
-        )}} was killed with signal ${signal}`
-      }
+      throw convertExecaError(command, error)
     }
   )
-  return child
 }
+
+function defaultExecaSync(command, args, options, ...rest) {
+  try {
+    const result = execa.sync(...getExecaArgs(command, args, options, ...rest))
+    logSuccess(command)
+    return result
+  } catch (error) {
+    throw convertExecaError(command, error)
+  }
+}
+
+defaultExeca.sync = defaultExecaSync
+
+module.exports = defaultExeca

package/util/findUps.cjs

@@ -1,6 +1,7 @@
 const findUp = require('find-up')
 const Path = require('path')
 const fs = require('fs-extra')
+const merge = require('lodash/merge')
 const once = require('./once.cjs')
 const { name } = require('../package.json')
 const configSchema = require('./configSchema.cjs')
@@ -25,12 +26,19 @@ if (!packageJsonFile) {
 }
 exports.packageJsonFile = packageJsonFile
 const packageJson = (exports.packageJson = fs.readJsonSync(packageJsonFile))
-exports.projectDir = Path.dirname(packageJsonFile)
+const projectDir = (exports.projectDir = Path.dirname(packageJsonFile))
 
-exports.toolchainPackages = [
+const toolchainPackages = (exports.toolchainPackages = [
   ...Object.keys(packageJson.dependencies || {}),
   ...Object.keys(packageJson.devDependencies || {}),
-].filter((dep) => dep.startsWith(name))
+].filter((dep) => dep.startsWith(name)))
+
+const toolchainPackageJsons = (exports.toolchainPackageJsons = {})
+for (const pkg of toolchainPackages) {
+  toolchainPackageJsons[pkg] = require(require.resolve(`${pkg}/package.json`, {
+    paths: [projectDir],
+  }))
+}
 
 let toolchainConfigFile
 try {
@@ -59,3 +67,29 @@ try {
 }
 
 exports.toolchainConfig = toolchainConfig
+
+const toolchainManaged = (exports.toolchainManaged = {})
+for (const toolchainPkgJson of Object.values(toolchainPackageJsons)) {
+  const toolchainPkgDeps = toolchainPkgJson.dependencies || {}
+  const toolchainPkgDevDeps = toolchainPkgJson.devDependencies || {}
+  if (toolchainPkgJson.toolchainManaged) {
+    for (const section in toolchainPkgJson.toolchainManaged) {
+      if (!toolchainManaged[section]) toolchainManaged[section] = {}
+      const sectionCfg = toolchainPkgJson.toolchainManaged[section]
+      if (section.endsWith('ependencies')) {
+        for (const dep in sectionCfg) {
+          let version = sectionCfg[dep]
+          if (version === '*')
+            version = toolchainPkgDevDeps[dep] || toolchainPkgDeps[dep]
+          if (version !== '*') toolchainManaged[section][dep] = version
+        }
+        continue
+      }
+      if (sectionCfg && typeof sectionCfg === 'object') {
+        toolchainManaged[section] = merge(toolchainManaged[section], sectionCfg)
+        continue
+      }
+      toolchainManaged[section] = sectionCfg
+    }
+  }
+}

package/util/getPluginsObjectAsync.cjs

@@ -0,0 +1,15 @@
+const getPlugins = require('./getPlugins.cjs')
+
+async function getPluginsObjectAsync(name, ...args) {
+  const plugins = getPlugins(name)
+  const result = {}
+  for (const plugin of plugins) {
+    Object.assign(
+      result,
+      typeof plugin === 'function' ? await plugin(...args) : plugin
+    )
+  }
+  return result
+}
+
+module.exports = getPluginsObjectAsync

package/util/getPluginsObjectSync.cjs

@@ -0,0 +1,15 @@
+const getPlugins = require('./getPlugins.cjs')
+
+function getPluginsObjectSync(name, ...args) {
+  const plugins = getPlugins(name)
+  const result = {}
+  for (const plugin of plugins) {
+    Object.assign(
+      result,
+      typeof plugin === 'function' ? plugin(...args) : plugin
+    )
+  }
+  return result
+}
+
+module.exports = getPluginsObjectSync

package/release.config.cjs

@@ -1,16 +0,0 @@
-const { projectDir } = require('./util/findUps.cjs')
-const path = require('path')
-
-module.exports = {
-  plugins: [
-    require.resolve('@semantic-release/commit-analyzer'),
-    require.resolve('@semantic-release/release-notes-generator'),
-    [
-      require.resolve('@semantic-release/npm'),
-      {
-        pkgRoot: path.join(projectDir, 'dist'),
-      },
-    ],
-    require.resolve('@semantic-release/github'),
-  ],
-}

package/scripts/coverage.cjs

@@ -1,12 +0,0 @@
-const getPlugins = require('../util/getPlugins.cjs')
-const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
-
-exports.run = async function (args = []) {
-  if (!getPlugins('coverage').length) {
-    throw new Error(
-      'missing test toolchain, install @jcoreio/toolchain-mocha (there may be alternatives in the future)'
-    )
-  }
-  await getPluginsAsyncFunction('coverage')(args)
-}
-exports.description = 'run tests with code coverage'

package/scripts/test.cjs

@@ -1,12 +0,0 @@
-const getPlugins = require('../util/getPlugins.cjs')
-const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
-
-exports.run = async function (args = []) {
-  if (!getPlugins('test').length) {
-    throw new Error(
-      'missing test toolchain, install @jcoreio/toolchain-mocha (there may be alternatives in the future)'
-    )
-  }
-  await getPluginsAsyncFunction('test')(args)
-}
-exports.description = 'run tests'

package/util/getPluginsObject.cjs

@@ -1,12 +0,0 @@
-const getPlugins = require('./getPlugins.cjs')
-
-async function getPluginsObject(name, ...args) {
-  const plugins = getPlugins(name)
-  const result = {}
-  for (const plugin of plugins) {
-    Object.assign(result, await plugin(...args))
-  }
-  return result
-}
-
-module.exports = getPluginsObject