Migrate to ESM

bin/gluegun.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import { dirname } from 'path'
+import { fileURLToPath } from 'url'
+import { run } from '../build/cli/cli.js'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
+// speed up `gluegun --version` et al
+if (['v', 'version', '-v', '--v', '-version', '--version'].includes(process.argv[2])) {
+  const fs = await import('fs')
+  const contents = fs.readFileSync(__dirname + '/../package.json')
+  const pkg = JSON.parse(contents)
+  console.log(pkg.version)
+  process.exit(0)
+}
+
+run(process.argv)

package.json

@@ -3,8 +3,9 @@
   "version": "0.0.4",
   "description": "A delightful toolkit for building Node-powered CLIs.",
   "repository": "webstoneHQ/gluegun",
+  "type": "module",
   "bin": {
-    "gluegun": "bin/gluegun"
+    "gluegun": "bin/gluegun.js"
   },
   "main": "build/index.js",
   "types": "build/types/index.d.ts",
@@ -99,6 +100,8 @@
     "@typescript-eslint/eslint-plugin": "5.38.0",
     "@typescript-eslint/parser": "5.38.0",
     "cpy-cli": "4.2.0",
+    "esbuild": "^0.15.10",
+    "esbuild-node-externals": "^1.5.0",
     "eslint": "8.24.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
@@ -119,6 +122,7 @@
     "sinon": "14.0.0",
     "strip-ansi": "7.0.1",
     "temp-write": "5.0.0",
+    "tiny-glob": "^0.2.9",
     "ts-jest": "^29.0.2",
     "ts-node": "10.9.1",
     "typescript": "4.8.3",

scripts/esbuild.js

@@ -0,0 +1,38 @@
+import esbuild from 'esbuild'
+import { nodeExternalsPlugin } from 'esbuild-node-externals'
+import glob from 'tiny-glob'
+
+/**
+ * @type {Object.<string, esbuild.BuildOptions>}
+ */
+
+const config = {
+  shared: {
+    format: 'esm',
+    target: 'esnext',
+    plugins: [nodeExternalsPlugin()],
+    entryPoints: await glob('src/**/*.ts'),
+    logLevel: 'info',
+    bundle: true,
+    minify: true,
+    outdir: 'build',
+    platform: 'node',
+  },
+  build: {},
+  dev: {
+    watch: true,
+  },
+}
+
+const mode = process.argv[2]
+if (!mode) {
+  console.error('Usage: node ./scripts/esbuild.js build|dev')
+  process.exit(1)
+}
+
+esbuild
+  .build({
+    ...config.shared,
+    ...(config[mode] || {}),
+  })
+  .catch(() => process.exit(1))

sniff.js

@@ -19,7 +19,7 @@ if (ver[0] >= 8) {
 
 ok = hasAsyncAwait && isNewEnough
 
-module.exports = {
+export default {
   nodeMinimum,
   nodeVersion,
   isNewEnough,

src/cli/cli.ts

@@ -1,5 +1,10 @@
 import { build, GluegunToolbox } from '../index'
 
+import { dirname } from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
 /**
  * Create the cli and kick it off
  */

src/index.ts

@@ -1,7 +1,13 @@
 import * as path from 'path'
 
 // first, do a sniff test to ensure our dependencies are met
-const sniff = require('../sniff')
+import sniff from '../sniff.js'
+import AppModulePath from 'app-module-path'
+
+import { dirname } from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
 
 // check the node version
 if (!sniff.isNewEnough) {
@@ -40,5 +46,5 @@ export { GluegunMeta } from './core-extensions/meta-extension'
 
 // this adds the node_modules path to the "search path"
 // it's hacky, but it works well!
-require('app-module-path').addPath(path.join(__dirname, '..', 'node_modules'))
-require('app-module-path').addPath(process.cwd())
+AppModulePath.addPath(path.join(__dirname, '..', 'node_modules'))
+AppModulePath.addPath(process.cwd())

src/toolbox/print-tools.ts

@@ -1,5 +1,5 @@
-import * as CLITable from 'cli-table3'
-import * as importedColors from 'colors/safe'
+import CLITable from 'cli-table3'
+import importedColors from 'colors'
 import { commandInfo } from './meta-tools'
 import { Toolbox } from '../domain/toolbox'
 import { times } from './utils'

src/toolbox/print-types.ts

@@ -2,7 +2,7 @@ import { GluegunToolbox } from '../index'
 import * as CLITable from 'cli-table3'
 import * as importedColors from 'colors'
 import { Toolbox } from '../domain/toolbox'
-import ora = require('ora')
+import ora from 'ora'
 
 export type GluegunPrintColors = typeof importedColors & {
   highlight: (t: string) => string

src/toolbox/template-tools.ts

@@ -14,7 +14,7 @@ function buildGenerate(toolbox: GluegunToolbox): (opts: Options) => Promise<stri
    * @return The generated string.
    */
   async function generate(opts: Options = {}): Promise<string> {
-    const ejs = require('ejs')
+    const ejs = await import('ejs')
     // required
     const template = opts.template
 

tsconfig.json

@@ -3,7 +3,7 @@
     "allowSyntheticDefaultImports": true,
     "experimentalDecorators": true,
     "lib": ["es2016", "es2016.array.include", "scripthost"],
-    "module": "commonjs",
+    "module": "ESNext",
     "moduleResolution": "node",
     "noImplicitAny": false,
     "noImplicitThis": true,
@@ -14,7 +14,7 @@
     "declaration": true,
     "declarationDir": "build/types",
     "strict": false,
-    "target": "ES6",
+    "target": "ESNext",
     "pretty": true,
     "skipLibCheck": true
   },