@jcoreio/toolchain 1.0.0-beta.1

package/scripts/bootstrap/bootstrapProjectPackageJson.cjs

@@ -0,0 +1,76 @@
+const { name, peerDependencies: basePeerDeps } = require('../../package.json')
+const { projectDir, toolchainPackages } = require('../../util/findUps.cjs')
+const getPluginsAsyncFunction = require('../../util/getPluginsAsyncFunction.cjs')
+const fs = require('../../util/projectFs.cjs')
+const sortDeps = require('../../util/sortDeps.cjs')
+
+async function bootstrapProjectPackageJson() {
+  const { merge, unset } = require('lodash')
+
+  const packageJson = await fs.readJson('package.json')
+  const devDependencies =
+    packageJson.devDependencies || (packageJson.devDependencies = {})
+
+  const peerDependencies = { ...basePeerDeps }
+  for (const pkg of toolchainPackages) {
+    Object.assign(
+      peerDependencies,
+      require(require.resolve(`${pkg}/package.json`, { paths: [projectDir] }))
+        .peerDependencies
+    )
+  }
+
+  for (const path of [
+    'exports',
+    'eslintConfig',
+    'files',
+    'husky',
+    'main',
+    'module',
+    'renovate',
+    'prettier',
+    'commitlint',
+    'lint-staged',
+    'nyc',
+    'husky',
+    'config.mocha',
+  ]) {
+    unset(packageJson, path)
+  }
+  for (const dep of require('./bootstrapRemoveDevDeps.cjs')) {
+    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` },
+    },
+  })
+
+  if (peerDependencies) {
+    for (const dep in peerDependencies) {
+      const version = peerDependencies[dep]
+      if (version.startsWith('workspace') || version === '*') continue
+      packageJson.devDependencies[dep] = version
+    }
+  }
+
+  await getPluginsAsyncFunction('bootstrapProjectPackageJson')(packageJson)
+
+  sortDeps(packageJson)
+
+  await fs.writeJson('package.json', packageJson, { spaces: 2 })
+  // eslint-disable-next-line no-console
+  console.error('updated package.json')
+}
+
+module.exports = bootstrapProjectPackageJson

package/scripts/bootstrap/bootstrapRemoveDevDeps.cjs

@@ -0,0 +1,110 @@
+module.exports = [
+  '@babel/cli',
+  '@babel/core',
+  '@babel/plugin-dynamic-import-node',
+  '@babel/plugin-external-helpers',
+  '@babel/plugin-proposal-class-properties',
+  '@babel/plugin-proposal-export-default-from',
+  '@babel/plugin-proposal-export-namespace-from',
+  '@babel/plugin-proposal-object-rest-spread',
+  '@babel/plugin-syntax-async-functions',
+  '@babel/plugin-syntax-dynamic-import',
+  '@babel/plugin-syntax-flow',
+  '@babel/plugin-tester',
+  '@babel/plugin-transform-async-generator-functions',
+  '@babel/plugin-transform-async-to-module-method',
+  '@babel/plugin-transform-charcodes',
+  '@babel/plugin-transform-class-properties',
+  '@babel/plugin-transform-decorators-legacy',
+  '@babel/plugin-transform-es2015-modules-commonjs',
+  '@babel/plugin-transform-es2015-modules-simple-commonjs',
+  '@babel/plugin-transform-export-extensions',
+  '@babel/plugin-transform-flow-comments',
+  '@babel/plugin-transform-object-rest-spread',
+  '@babel/plugin-transform-regenerator',
+  '@babel/plugin-transform-runtime',
+  '@babel/polyfill',
+  '@babel/preset-async-to-bluebird',
+  '@babel/preset-babili',
+  '@babel/preset-env',
+  '@babel/preset-es2015-no-commonjs',
+  '@babel/preset-es2015-node',
+  '@babel/preset-es2015-node4',
+  '@babel/preset-es2015-without-strict',
+  '@babel/preset-es2015',
+  '@babel/preset-flow',
+  '@babel/preset-react',
+  '@babel/preset-stage-1',
+  '@babel/preset-stage-2',
+  '@babel/preset-typescript',
+  '@babel/register',
+  '@commitlint/cli',
+  '@commitlint/config-conventional',
+  '@jcoreio/commitlint-config',
+  '@jedwards1211/commitlint-config',
+  '@jedwards1211/eslint-config-flow',
+  '@jedwards1211/eslint-config-react',
+  '@jedwards1211/eslint-config-typescript',
+  '@jedwards1211/eslint-config',
+  '@typescript-eslint/eslint-plugin',
+  '@typescript-eslint/parser',
+  'babel-cli',
+  'babel-core',
+  'babel-eslint',
+  'babel-plugin-dynamic-import-node',
+  'babel-plugin-external-helpers',
+  'babel-plugin-flow-react-proptypes',
+  'babel-plugin-istanbul',
+  'babel-plugin-syntax-async-functions',
+  'babel-plugin-syntax-dynamic-import',
+  'babel-plugin-syntax-flow',
+  'babel-plugin-tester',
+  'babel-plugin-transform-async-generator-functions',
+  'babel-plugin-transform-async-to-module-method',
+  'babel-plugin-transform-charcodes',
+  'babel-plugin-transform-class-properties',
+  'babel-plugin-transform-decorators-legacy',
+  'babel-plugin-transform-es2015-modules-commonjs',
+  'babel-plugin-transform-es2015-modules-simple-commonjs',
+  'babel-plugin-transform-export-extensions',
+  'babel-plugin-transform-flow-comments',
+  'babel-plugin-transform-object-rest-spread',
+  'babel-plugin-transform-regenerator',
+  'babel-plugin-transform-runtime',
+  'babel-polyfill',
+  'babel-preset-async-to-bluebird',
+  'babel-preset-babili',
+  'babel-preset-env',
+  'babel-preset-es2015-no-commonjs',
+  'babel-preset-es2015-node',
+  'babel-preset-es2015-node4',
+  'babel-preset-es2015-without-strict',
+  'babel-preset-es2015',
+  'babel-preset-flow',
+  'babel-preset-react',
+  'babel-preset-stage-1',
+  'babel-preset-stage-2',
+  'babel-register',
+  'babel-runtime',
+  'babel-types',
+  'babylon',
+  'codecov',
+  'coveralls',
+  'eslint-plugin-flowtype',
+  'eslint-plugin-prettier',
+  'eslint-plugin-react',
+  'eslint-watch',
+  'eslint',
+  'flow-copy-source',
+  'flow-watch',
+  'husky',
+  'isparta',
+  'istanbul',
+  'lint-staged',
+  'mocha',
+  'nyc',
+  'prettier-eslint',
+  'prettier',
+  'semantic-release',
+  'travis-deploy-once',
+]

package/scripts/bootstrap/bootstrapRemoveFiles.cjs

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

package/scripts/bootstrap/installGitHooks.cjs

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+
+const execa = require('../../util/execa.cjs')
+const Path = require('path')
+const dedent = require('dedent-js')
+const { findGitDir } = require('../../util/findUps.cjs')
+
+async function installGitHooks() {
+  const gitDir = findGitDir()
+  if (!gitDir) {
+    // eslint-disable-next-line no-console
+    console.warn(dedent`
+      .git directory not found!
+      git hooks could not be installed.
+      after you run \`git init\`, try \`pnpm exec install-git-hooks\`.
+    `)
+  } else {
+    await execa('git', [
+      'config',
+      'core.hooksPath',
+      Path.relative(
+        Path.dirname(gitDir),
+        Path.resolve(__dirname, '..', '..', 'githooks')
+      ),
+    ])
+    // eslint-disable-next-line no-console
+    console.log('successfully installed git hooks!')
+  }
+}
+
+module.exports = installGitHooks

package/scripts/bootstrap.cjs

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+
+const fs = require('../util/projectFs.cjs')
+const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
+
+async function bootstrap(args = []) {
+  const execa = require('../util/execa.cjs')
+  const installGitHooks = require('./bootstrap/installGitHooks.cjs')
+  const bootstrapProjectPackageJson = require('./bootstrap/bootstrapProjectPackageJson.cjs')
+  const bootstrapEslintConfigs = require('./bootstrap/bootstrapEslintConfigs.cjs')
+  const bootstrapConfigFiles = require('./bootstrap/bootstrapConfigFiles.cjs')
+  const bootstrapMoveTypeDefs = require('./bootstrap/bootstrapMoveTypeDefs.cjs')
+  const bootstrapGitignore = require('./bootstrap/bootstrapGitignore.cjs')
+  const bootstrapRemoveFiles = require('./bootstrap/bootstrapRemoveFiles.cjs')
+
+  await execa('git', ['init'])
+  await installGitHooks()
+  await bootstrapProjectPackageJson()
+  await Promise.all(
+    bootstrapRemoveFiles.map(async (file) => {
+      const exists = await fs.pathExists(file)
+      if (exists) {
+        await fs.remove(file)
+        // eslint-disable-next-line no-console
+        console.error('removed', file)
+      }
+    })
+  )
+  await bootstrapConfigFiles()
+  await bootstrapEslintConfigs()
+  await bootstrapMoveTypeDefs()
+  await bootstrapGitignore()
+  await getPluginsAsyncFunction('bootstrap')(args)
+}
+
+exports.description = 'set up project'
+exports.run = bootstrap
+
+if (require.main === module) {
+  bootstrap().then(
+    () => process.exit(0),
+    (error) => {
+      // eslint-disable-next-line no-console
+      console.error(error.stack)
+      process.exit(error.exitCode != null ? error.exitCode : 1)
+    }
+  )
+}

package/scripts/build.cjs

@@ -0,0 +1,66 @@
+const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
+const Path = require('path')
+const { projectDir } = require('../util/findUps.cjs')
+const fs = require('../util/projectFs.cjs')
+const clean = require('./clean.cjs')
+const glob = require('../util/glob.cjs')
+
+exports.run = async function build(args = []) {
+  await clean.run()
+  await fs.mkdirs('dist')
+
+  const ignoreEnoent = (err) => {
+    if (err.code !== 'ENOENT') throw err
+  }
+  const filter = (src, dest) => {
+    // eslint-disable-next-line no-console
+    console.error(
+      Path.relative(projectDir, src),
+      '->',
+      Path.relative(projectDir, dest)
+    )
+    return true
+  }
+  await Promise.all(
+    ['pnpm-lock.yaml', 'README.md', 'LICENSE.md'].map((file) =>
+      fs.copy(file, `dist/${file}`, { filter })
+    )
+  ).catch(ignoreEnoent)
+
+  const flowFiles = await glob(Path.join('src', '**', '*.{js,mjs,cjs}.flow'))
+  await Promise.all(
+    flowFiles.map(async (src) => {
+      for (const ext of src.endsWith('.js.flow')
+        ? ['.js.flow', '.cjs.flow', '.mjs.flow']
+        : /\.(js|mjs|cjs)\.flow$/.exec(ext)[0]) {
+        const dest = Path.join(
+          'dist',
+          Path.relative('src', src.replace(/\.(js|mjs|cjs)\.flow$/, ext))
+        )
+        // eslint-disable-next-line no-console
+        console.error(src, '->', dest)
+        await fs.copy(src, dest)
+      }
+    })
+  )
+
+  const dtsFiles = await glob(Path.join('src', '**', '*.d.ts'))
+  await Promise.all(
+    dtsFiles.map(async (src) => {
+      const dest = Path.join('dist', Path.relative('src', src))
+      // eslint-disable-next-line no-console
+      console.error(src, '->', dest)
+      await fs.copy(src, dest)
+    })
+  )
+
+  await getPluginsAsyncFunction('compile')(args)
+  await getPluginsAsyncFunction('build')(args)
+
+  const packageJson = await fs.readJson('package.json')
+  await getPluginsAsyncFunction('buildDistPackageJson')(packageJson)
+  // eslint-disable-next-line no-console
+  console.error('package.json -> dist/package.json')
+  await fs.writeJson('dist/package.json', packageJson, { spaces: 2 })
+}
+exports.description = 'build dist directory'

package/scripts/check.cjs

@@ -0,0 +1,19 @@
+const getPluginsAsyncFunction = require('../util/getPluginsAsyncFunction.cjs')
+const {
+  packageJson: { devDependencies = {} },
+} = require('../util/findUps.cjs')
+const execa = require('../util/execa.cjs')
+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)
+  if (devDependencies['flow-bin'] && (await fs.pathExists('.flowconfig'))) {
+    await execa('flow')
+  }
+  if (devDependencies['typescript'] && (await fs.pathExists('tsconfig.json'))) {
+    await execa('tsc', ['--noEmit'])
+  }
+  await getPluginsAsyncFunction('check')(args)
+}
+exports.description = 'check format, types (if applicable), and lint'

package/scripts/clean.cjs

@@ -0,0 +1,6 @@
+const fs = require('../util/projectFs.cjs')
+
+exports.run = async function clean() {
+  await fs.remove('dist')
+}
+exports.description = 'remove build output'

package/scripts/coverage.cjs

@@ -0,0 +1,12 @@
+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/format.cjs

@@ -0,0 +1,4 @@
+exports.run = async function (args = []) {
+  await require('./runPrettier.cjs').prettierFormat(args)
+}
+exports.description = 'format files with prettier'

package/scripts/init.cjs

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+const { packageJson } = require('../util/findUps.cjs')
+const preinstall = require('./preinstall.cjs')
+const execa = require('../util/execa.cjs')
+
+async function init(args = []) {
+  const { dependencies = {}, devDependencies = {} } = packageJson
+  const toolchains = []
+  const isBabel =
+    devDependencies['@babel/core'] != null ||
+    devDependencies['babel-core'] != null
+  const isTS = isBabel && devDependencies.typescript != null
+  const isFlow = isBabel && devDependencies['flow-bin'] != null
+  const isReact = dependencies.react != null || devDependencies.react != null
+  const isMocha = devDependencies['mocha'] != 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')
+
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
+
+  await preinstall.run()
+  await execa('pnpm', [
+    'add',
+    '-D',
+    isTest ? '../packages/base' : '@jcoreio/toolchain',
+    ...(isTest
+      ? toolchains.map((t) => t.replace(/@jcoreio\/toolchain-/, '../packages/'))
+      : toolchains),
+  ])
+  await execa('tc', ['bootstrap'])
+  await execa('pnpm', ['i', '--no-frozen-lockfile'])
+  await execa('tc', ['format'])
+  await execa('tc', ['lint:fix'])
+  await execa('tc', ['prepublish'])
+}
+
+exports.description =
+  'install toolchains, bootstrap, format, lint:fix and prepublish'
+exports.run = init
+
+if (require.main === module) {
+  init().then(
+    () => process.exit(0),
+    (error) => {
+      // eslint-disable-next-line no-console
+      console.error(error.stack)
+      process.exit(error.exitCode != null ? error.exitCode : 1)
+    }
+  )
+}

package/scripts/lint-fix.cjs

@@ -0,0 +1,4 @@
+exports.run = async function (args = []) {
+  await require('./runEslint.cjs').eslintFix(args)
+}
+exports.description = 'autofix eslint errors'

package/scripts/lint.cjs

@@ -0,0 +1,4 @@
+exports.run = async function (args = []) {
+  await require('./runEslint.cjs').eslintCheck(args)
+}
+exports.description = 'check files with eslint'

package/scripts/open-coverage.cjs

@@ -0,0 +1,7 @@
+const execa = require('../util/execa.cjs')
+const Path = require('path')
+
+exports.run = async () => {
+  await execa('open', [Path.join('coverage', 'lcov-report', 'index.html')])
+}
+exports.description = 'open code coverage report'

package/scripts/preinstall/preinstallRemoveDevDeps.cjs

@@ -0,0 +1,65 @@
+module.exports = [
+  '@commitlint/cli',
+  '@commitlint/config-conventional',
+  '@jedwards1211/commitlint-config',
+  '@jcoreio/commitlint-config',
+  'babel-cli',
+  'babel-core',
+  'babel-eslint',
+  'babel-plugin-dynamic-import-node',
+  'babel-plugin-external-helpers',
+  'babel-plugin-flow-react-proptypes',
+  'babel-plugin-istanbul',
+  'babel-plugin-syntax-async-functions',
+  'babel-plugin-syntax-dynamic-import',
+  'babel-plugin-syntax-flow',
+  'babel-plugin-tester',
+  'babel-plugin-transform-async-generator-functions',
+  'babel-plugin-transform-async-to-module-method',
+  'babel-plugin-transform-charcodes',
+  'babel-plugin-transform-class-properties',
+  'babel-plugin-transform-decorators-legacy',
+  'babel-plugin-transform-es2015-modules-commonjs',
+  'babel-plugin-transform-es2015-modules-simple-commonjs',
+  'babel-plugin-transform-export-extensions',
+  'babel-plugin-transform-flow-comments',
+  'babel-plugin-transform-object-rest-spread',
+  'babel-plugin-transform-regenerator',
+  'babel-plugin-transform-runtime',
+  'babel-polyfill',
+  'babel-preset-async-to-bluebird',
+  'babel-preset-babili',
+  'babel-preset-env',
+  'babel-preset-es2015',
+  'babel-preset-es2015-no-commonjs',
+  'babel-preset-es2015-node',
+  'babel-preset-es2015-node4',
+  'babel-preset-es2015-without-strict',
+  'babel-preset-flow',
+  'babel-preset-react',
+  'babel-preset-stage-1',
+  'babel-preset-stage-2',
+  'babel-register',
+  'babel-runtime',
+  'babel-types',
+  'babylon',
+  'codecov',
+  'coveralls',
+  'eslint-plugin-flowtype',
+  'eslint-plugin-prettier',
+  'eslint-plugin-react',
+  'eslint-watch',
+  'eslint',
+  'flow-copy-source',
+  'flow-watch',
+  'husky',
+  'isparta',
+  'istanbul',
+  'lint-staged',
+  'mocha',
+  'nyc',
+  'prettier',
+  'prettier-eslint',
+  'semantic-release',
+  'travis-deploy-once',
+]

package/scripts/preinstall/preinstallRemoveFiles.cjs

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

package/scripts/preinstall/preinstallUpdateProjectPackageJson.cjs

@@ -0,0 +1,39 @@
+const fs = require('../../util/projectFs.cjs')
+
+async function preinstallUpdateProjectPackageJson() {
+  const { unset } = require('lodash')
+
+  const packageJson = await fs.readJson('package.json')
+  const { devDependencies } = packageJson
+
+  for (const path of [
+    'exports',
+    'files',
+    'husky',
+    'main',
+    'module',
+    'renovate',
+    'prettier',
+    'commitlint',
+    'lint-staged',
+    'nyc',
+    'husky',
+    'config.mocha',
+  ]) {
+    unset(packageJson, path)
+  }
+  if (devDependencies) {
+    for (const dep in Object.keys(devDependencies)) {
+      if (dep.startsWith('@babel/')) delete devDependencies[dep]
+    }
+    for (const dep of require('./preinstallRemoveDevDeps.cjs')) {
+      delete devDependencies[dep]
+    }
+  }
+
+  await fs.writeJson('package.json', packageJson, { spaces: 2 })
+  // eslint-disable-next-line no-console
+  console.error('updated package.json')
+}
+
+module.exports = preinstallUpdateProjectPackageJson