@jcoreio/toolchain-esnext 3.6.2 → 3.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jcoreio/toolchain-esnext",
-  "version": "3.6.2",
+  "version": "3.7.0",
   "description": "ESNext JS build toolchain",
   "repository": {
     "type": "git",
@@ -26,15 +26,16 @@
     "babel-parse-wild-code": "^2.1.3",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-istanbul": "^6.1.1",
+    "babel-register-esm": "^1.2.5",
     "dedent-js": "^1.0.1",
     "eslint": "^8.43.0",
     "fs-extra": "^10.0.0",
     "resolve": "^1.22.2",
     "resolve-bin": "^1.0.0",
-    "@jcoreio/toolchain": "3.6.2"
+    "@jcoreio/toolchain": "3.7.0"
   },
   "peerDependencies": {
-    "@jcoreio/toolchain": "3.6.2"
+    "@jcoreio/toolchain": "3.7.0"
   },
   "toolchainManaged": {
     "dependencies": {

package/plugins/babelPlugins.cjs

@@ -1,10 +1,28 @@
 module.exports = [
   (api) => {
-    const { JCOREIO_TOOLCHAIN_MJS } = process.env
-    api.cache.using(() => JCOREIO_TOOLCHAIN_MJS)
+    const {
+      JCOREIO_TOOLCHAIN_CJS,
+      JCOREIO_TOOLCHAIN_ESM,
+      JCOREIO_TOOLCHAIN_TEST,
+    } = process.env
+    api.cache.using(() => JCOREIO_TOOLCHAIN_CJS)
+    api.cache.using(() => JCOREIO_TOOLCHAIN_ESM)
+    api.cache.using(() => JCOREIO_TOOLCHAIN_TEST)
     return [
       require.resolve('@babel/plugin-transform-runtime'),
-      !JCOREIO_TOOLCHAIN_MJS &&
+      // for CJS tests, we leave off import extensions, since @babel/register resolves them.
+      // for ESM tests, we resolve to .js for babel-register-esm.
+      // for CJS build, we resolve to .js.
+      // for ESM build, we resolve to .mjs.
+      ((JCOREIO_TOOLCHAIN_CJS && !JCOREIO_TOOLCHAIN_TEST) ||
+        JCOREIO_TOOLCHAIN_ESM) && [
+        require.resolve('../util/babelPluginResolveImports.cjs'),
+        {
+          outputExtension:
+            JCOREIO_TOOLCHAIN_ESM && !JCOREIO_TOOLCHAIN_TEST ? '.mjs' : '.js',
+        },
+      ],
+      !JCOREIO_TOOLCHAIN_ESM &&
         require.resolve('babel-plugin-add-module-exports'),
     ].filter(Boolean)
   },

package/plugins/babelPresets.cjs

@@ -2,20 +2,20 @@ const { toolchainConfig } = require('@jcoreio/toolchain/util/findUps.cjs')
 
 module.exports = [
   (api) => {
-    const { JCOREIO_TOOLCHAIN_MJS } = process.env
-    api.cache.using(() => JCOREIO_TOOLCHAIN_MJS)
+    const { JCOREIO_TOOLCHAIN_ESM } = process.env
+    api.cache.using(() => JCOREIO_TOOLCHAIN_ESM)
     return [
       [
         require.resolve('@babel/preset-env'),
         {
-          ...(JCOREIO_TOOLCHAIN_MJS
+          ...(JCOREIO_TOOLCHAIN_ESM
             ? toolchainConfig.esmBabelEnv || {
                 targets: {
                   node: 16,
                 },
               }
             : toolchainConfig.cjsBabelEnv || { forceAllTransforms: true }),
-          modules: JCOREIO_TOOLCHAIN_MJS ? false : 'auto',
+          modules: JCOREIO_TOOLCHAIN_ESM ? false : 'auto',
         },
       ],
     ]

package/plugins/compile.cjs

@@ -8,22 +8,25 @@ const {
   projectDir,
 } = require('@jcoreio/toolchain/util/findUps.cjs')
 const getPluginsArraySync = require('@jcoreio/toolchain/util/getPluginsArraySync.cjs')
-const resolveImportsCodemod = require('../util/resolveImportsCodemod.cjs')
 
 module.exports = [
   [
     async function compile(args = []) {
       const extensions = getPluginsArraySync('babelExtensions')
 
-      await execa('babel', [
-        'src',
-        ...(extensions.length ? ['--extensions', extensions.join(',')] : []),
-        ...(extensions.includes('.ts') ? ['--ignore', '**/*.d.ts'] : []),
-        '--out-dir',
-        'dist',
-        '--out-file-extension',
-        '.js',
-      ])
+      await execa(
+        'babel',
+        [
+          'src',
+          ...(extensions.length ? ['--extensions', extensions.join(',')] : []),
+          ...(extensions.includes('.ts') ? ['--ignore', '**/*.d.ts'] : []),
+          '--out-dir',
+          'dist',
+          '--out-file-extension',
+          '.js',
+        ],
+        { env: { ...process.env, JCOREIO_TOOLCHAIN_CJS: '1' } }
+      )
       if (extensions.length) {
         for (const ext of ['.js', '.mjs']) {
           if (!extensions.includes(ext)) {
@@ -43,7 +46,6 @@ module.exports = [
         }
       }
       const jsFiles = await glob(path.join('dist', '**', '*.js'))
-      await resolveImportsCodemod(jsFiles)
       if (toolchainConfig.outputEsm !== false) {
         if (toolchainConfig.esWrapper) {
           await Promise.all(
@@ -73,10 +75,8 @@ module.exports = [
               '--out-file-extension',
               '.mjs',
             ],
-            { env: { ...process.env, JCOREIO_TOOLCHAIN_MJS: '1' } }
+            { env: { ...process.env, JCOREIO_TOOLCHAIN_ESM: '1' } }
           )
-          const mjsFiles = await glob(path.join('dist', '**', '*.mjs'))
-          await resolveImportsCodemod(mjsFiles)
         }
       }
     },

package/plugins/getConfigFiles.cjs

@@ -3,24 +3,32 @@ const confirmOutputEsm = require('@jcoreio/toolchain/scripts/migrate/confirmOutp
 const dedent = require('dedent-js')
 
 module.exports = [
-  async function getConfigFiles() {
-    return {
-      'toolchain.config.cjs': async (existing) => {
-        if (existing) return existing
-        const outputEsm = await confirmOutputEsm()
-        return dedent`
+  [
+    async function getConfigFiles() {
+      return {
+        'toolchain.config.cjs': async (existing) => {
+          if (existing) return existing
+          const outputEsm = await confirmOutputEsm()
+          return dedent`
           /* eslint-env node, es2018 */
           module.exports = {
             cjsBabelEnv: { forceAllTransforms: true },
+            ${outputEsm ? '' : '// '}esmBabelEnv: { targets: { node: 16 } },
             ${
-              outputEsm
-                ? `esmBabelEnv: { targets: { node: 16 } }`
-                : `outputEsm: false`
-            },
+              outputEsm ? '// ' : ''
+            }outputEsm: false, // disables ESM output (default: true)
+            // esWrapper: true, // outputs ES module wrappers for CJS modules (default: false)
+            // scripts: {
+            //   pretest: 'docker compose up -d',
+            //   jsExample: {
+            //     description: 'example of running a JS script',
+            //     run: async (args = []) => console.log('TEST', ...args),
+            //   },
+            // }
           }
         `
-      },
-      '.babelrc.cjs': dedent`
+        },
+        '.babelrc.cjs': dedent`
         /* eslint-env node, es2018 */
         module.exports = function (api) {
           const base = require('${name}/.babelrc.cjs')(api)
@@ -29,6 +37,8 @@ module.exports = [
           }
         }
       `,
-    }
-  },
+      }
+    },
+    { after: '@jcoreio/toolchain' },
+  ],
 ]

package/util/babelPluginResolveImports.cjs

@@ -0,0 +1,42 @@
+const resolveImportSource = require('./resolveImportSource.cjs')
+
+module.exports = function babelPluginResolveImports({ types: t }) {
+  function handleSource(path, state) {
+    if (!path || !path.node) return
+    const source = path.node.value
+    const outputExtension = state.opts && state.opts.outputExtension
+    const resolved = resolveImportSource({
+      file: state.filename,
+      source,
+      outputExtension,
+    })
+    if (resolved !== source) {
+      path.replaceWith(t.stringLiteral(resolved))
+    }
+  }
+
+  return {
+    visitor: {
+      ImportDeclaration(path, state) {
+        handleSource(path.get('source'), state)
+      },
+      ExportNamedDeclaration(path, state) {
+        handleSource(path.get('source'), state)
+      },
+      ExportAllDeclaration(path, state) {
+        handleSource(path.get('source'), state)
+      },
+      CallExpression(path, state) {
+        if (
+          (path.get('callee').isImport() ||
+            (path.get('callee').isIdentifier() &&
+              path.node.callee.name === 'require')) &&
+          path.node.arguments.length === 1 &&
+          path.get('arguments')[0].isStringLiteral()
+        ) {
+          handleSource(path.get('arguments')[0], state)
+        }
+      },
+    },
+  }
+}

package/util/esmLoader.cjs

@@ -0,0 +1,4 @@
+const { register } = require('node:module')
+const { pathToFileURL } = require('node:url')
+
+register('babel-register-esm', pathToFileURL(__filename))

package/util/resolveImportSource.cjs

@@ -1,36 +1,53 @@
-const { promisify } = require('util')
-const _resolve = require('resolve')
-const resolve = promisify(_resolve)
+const resolve = require('resolve/sync')
 const path = require('path')
 const fs = require('fs-extra')
 const builtinModules = new Set(require('module').builtinModules)
 
-module.exports = async function resolveImportSource({ file, source }) {
+module.exports = function resolveImportSource({
+  file,
+  source,
+  outputExtension,
+}) {
+  if (
+    /\.[cm]?[tj]sx?$/i.test(source) ||
+    source.startsWith('node:') ||
+    builtinModules.has(source)
+  ) {
+    return source
+  }
+
   const basedir = path.dirname(file)
   if (source.startsWith('.')) {
-    const resolved = await resolve(source, {
+    const resolved = resolve(source, {
       basedir,
       extensions: [
         path.extname(file.replace(/\.flow$/, '')),
         '.mjs',
         '.cjs',
         '.js',
+        '.jsx',
+        '.ts',
+        '.tsx',
+        '.cts',
+        '.ctsx',
+        '.mts',
+        '.mtsx',
       ],
     })
-    const result = path.relative(basedir, resolved)
+    let result = path.relative(basedir, resolved)
+    if (outputExtension) result = result.replace(/\.[^.]+$/, outputExtension)
     return result.startsWith('.') ? result : `./${result}`
   }
-  if (source.startsWith('node:') || builtinModules.has(source)) return source
   const match = /^((?:@[^/]+\/)?[^/]+)(?:\/(.+))?$/.exec(source)
   if (!match) return source
   const [, pkg, subpath] = match
   if (!subpath) return source
   try {
-    const packageJsonFile = await resolve(`${pkg}/package.json`)
-    const packageJson = await fs.readJson(packageJsonFile)
+    const packageJsonFile = resolve(`${pkg}/package.json`, { basedir })
+    const packageJson = fs.readJsonSync(packageJsonFile)
     const exportMap = packageJson ? packageJson.exports : undefined
     if (exportMap && exportMap[`./${subpath}`]) return source
-    const resolved = await resolve(source, {
+    const resolved = resolve(source, {
       basedir,
       extensions: [path.extname(file), '.mjs', '.cjs', '.js'],
     })