@jcoreio/toolchain 3.6.3 → 3.8.0

package/package.json

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

package/plugins/getConfigFiles.cjs

@@ -2,6 +2,7 @@ const { name } = require('../package.json')
 const dedent = require('dedent-js')
 const fs = require('../util/projectFs.cjs')
 const JSON5 = require('json5')
+const getPluginsArraySync = require('../util/getPluginsArraySync.cjs')
 
 async function getRootEslintConfig() {
   if (await fs.pathExists('.eslintrc.json')) {
@@ -30,6 +31,21 @@ module.exports = [
       }
         }
       `,
+      'toolchain.config.cjs': async (existing) => {
+        if (existing) return existing
+        return dedent`
+          /* eslint-env node, es2018 */
+          module.exports = {
+            // scripts: {
+            //   pretest: 'docker compose up -d',
+            //   jsExample: {
+            //     description: 'example of running a JS script',
+            //     run: async (args = []) => console.log('TEST', ...args),
+            //   },
+            // }
+          }
+        `
+      },
     }
     for (const file of [
       'githooks.cjs',
@@ -45,6 +61,30 @@ module.exports = [
   
       `
     }
+    const tasks = await getPluginsArraySync('vscodeTasks')
+    const launch = await getPluginsArraySync('vscodeLaunch')
+
+    if (tasks) {
+      files['.vscode/tasks.json'] = JSON.stringify(
+        {
+          version: '2.0.0',
+          tasks,
+        },
+        null,
+        2
+      )
+    }
+    if (launch) {
+      files['.vscode/launch.json'] = JSON.stringify(
+        {
+          version: '0.2.0',
+          configurations: launch,
+        },
+        null,
+        2
+      )
+    }
+
     return files
   },
 ]

package/scripts/check.cjs

@@ -8,7 +8,7 @@ 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)
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
   if (devDependencies['flow-bin'] && (await fs.pathExists('.flowconfig'))) {
     await execa('flow', isTest ? ['check'] : [])
   }

package/scripts/init.cjs

@@ -63,7 +63,7 @@ async function init(args = []) {
     selectedToolchains.push(`${name}-esnext`)
   }
 
-  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
 
   await execa('tc', ['preinstall'])
   await execa('pnpm', [

package/scripts/migrate/migrateProjectPackageJson.cjs

@@ -133,7 +133,7 @@ async function migrateProjectPackageJson() {
   )
   if (isEmpty(packageJson.config)) delete packageJson.config
 
-  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
 
   for (const section in toolchainManaged) {
     if (!section.endsWith('ependencies')) continue

package/scripts/prepublish.cjs

@@ -4,7 +4,9 @@ exports.run = async function (args = []) {
   const { scripts } = require('./toolchain.cjs')
   await execa('tc', ['check'])
   if (scripts.coverage) await execa('tc', ['coverage'])
+  if (scripts['test:esm']) await execa('tc', ['test:esm'])
   await execa('tc', ['build'])
+  await execa('tc', ['build:smoke-test'])
 }
 
 exports.description = 'run check, coverage, and build'

package/scripts/smokeTestBuild.cjs

@@ -0,0 +1,26 @@
+const getModules = require('../util/getModules.cjs')
+const execa = require('../util/execa.cjs')
+const path = require('path')
+
+exports.run = async function smokeTestBuild() {
+  const { cjs, esm } = await getModules('dist/package.json')
+
+  function relpath(file) {
+    const result = path.relative(process.cwd(), file)
+    return result.startsWith('.') ? result : `./${result}`
+  }
+
+  for (const file of cjs) {
+    await execa('node', ['-e', `require(${JSON.stringify(relpath(file))})`])
+  }
+  for (const file of esm) {
+    await execa('node', [
+      '--input-type',
+      'module',
+      '-e',
+      `import ${JSON.stringify(relpath(file))}`,
+    ])
+  }
+}
+
+exports.description = 'smoke test that build output can be required/imported'

package/scripts/toolchain.cjs

@@ -9,6 +9,7 @@ const execa = require('../util/execa.cjs')
 const scripts = {
   migrate: require('./migrate.cjs'),
   build: require('./build.cjs'),
+  'build:smoke-test': require('./smokeTestBuild.cjs'),
   check: require('./check.cjs'),
   clean: require('./clean.cjs'),
   format: require('./format.cjs'),

package/scripts/upgrade.cjs

@@ -9,7 +9,7 @@ async function upgrade([version] = []) {
   const toolchains = Object.keys(devDependencies).filter((pkg) =>
     pkg.startsWith(`${name}-`)
   )
-  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_TEST)
+  const isTest = Boolean(process.env.JCOREIO_TOOLCHAIN_SELF_TEST)
 
   if (!isTest && !version) {
     version = (

package/util/getModules.cjs

@@ -0,0 +1,72 @@
+const fs = require('./projectFs.cjs')
+const glob = require('./glob.cjs')
+const path = require('path')
+
+module.exports = async function getModules(packageJsonFile) {
+  const cjs = new Set()
+  const esm = new Set()
+
+  const {
+    type = 'commonjs',
+    main,
+    module,
+    bin,
+    exports,
+  } = await fs.readJson(packageJsonFile)
+
+  const defaultType = type
+  function checkFile(
+    file,
+    type = file
+      ? /\.cjs$/.test(file)
+        ? 'commonjs'
+        : /\.mjs$/.test(file)
+        ? 'module'
+        : /\.js$/.test(file)
+        ? defaultType
+        : undefined
+      : undefined
+  ) {
+    if (!file) return
+    if (type === 'commonjs') cjs.add(file)
+    else if (type === 'module') esm.add(file)
+  }
+
+  checkFile(main)
+  checkFile(module)
+  if (typeof bin === 'string') checkFile(bin)
+  else if (bin instanceof Object) {
+    for (const file of Object.values(bin)) checkFile(file)
+  }
+
+  async function checkExport(exp, type) {
+    if (typeof exp === 'string') {
+      if (exp.includes('*')) {
+        const files = await glob(exp.replace('*', '**'), {
+          cwd: path.dirname(packageJsonFile),
+        })
+        for (const file of files) checkFile(file, type)
+      } else {
+        checkFile(exp, type)
+      }
+    } else if (exp instanceof Object) {
+      for (const [key, value] of Object.entries(exp)) {
+        await checkExport(
+          value,
+          type ||
+            (key === 'require'
+              ? 'commonjs'
+              : key === 'import'
+              ? 'module'
+              : undefined)
+        )
+      }
+    }
+  }
+
+  await checkExport(exports)
+
+  const resolvePath = (f) => path.resolve(path.dirname(packageJsonFile), f)
+
+  return { cjs: [...cjs].map(resolvePath), esm: [...esm].map(resolvePath) }
+}

package/util/isInteractive.cjs

@@ -1,5 +1,5 @@
 module.exports =
-  !process.env.JCOREIO_TOOLCHAIN_TEST &&
+  !process.env.JCOREIO_TOOLCHAIN_SELF_TEST &&
   process.stdout.isTTY &&
   process.env.TERM !== 'dumb' &&
   !('CI' in process.env)