@vanillaes/esmtk 0.7.0 → 0.7.2

package/README.md

@@ -1,17 +1,17 @@
-<h1 align="center">ES Module Toolkit</h1>
+<h1 align="center">ECMAScript Module Toolkit</h1>
 
-ESMTK, essential tools and libs for ES module development
+ESMTK, essential tools for ECMAScript module development
 
 <div align="center">
   <a href="https://github.com/vanillaes/esmtk/releases"><img src="https://badgen.net/github/tag/vanillaes/esmtk" alt="GitHub Release"></a>
-  <a href="https://www.npmjs.com/package/esmtk"><img src="https://badgen.net/npm/v/esmtk" alt="NPM Releases"></a>
+  <a href="https://www.npmjs.com/package/@vanillaes/esmtk"><img src="https://badgen.net/npm/v/@vanillaes/esmtk" alt="NPM Releases"></a>
   <a href="https://github.com/vanillaes/esmtk/actions"><img src="https://github.com/vanillaes/esmtk/workflows/Latest/badge.svg" alt="Latest Status"></a>
   <a href="https://github.com/vanillaes/esmtk/actions"><img src="https://github.com/vanillaes/esmtk/workflows/Release/badge.svg" alt="Release Status"></a>
 </div>
 
 ## Lint
 
-Lint uses StandardJS to lint the source
+Lint the source code (using StandardJS)
 
 ### Arguments
 
@@ -27,7 +27,7 @@ esmtk lint
 
 ## Bundle
 
-Bundle uses ESBuild to compile an ES module (and its deps) into a bundle
+Bundle the source code to an ECMAScript module (using ESBuild)
 
 ### Arguments
 
@@ -44,7 +44,7 @@ esmtk bundle src/sample.js bundle.js
 
 ## Minify
 
-Minify uses ESBuild to compile an ES module (and its deps) into a minified bundle
+Bundle and Minify the source code to an ECMAScript module (using ESBuild)
 
 ### Arguments
 
@@ -61,7 +61,7 @@ esmtk minify src/sample.js bundle.min.js
 
 ## CommonJS
 
-CommonJS uses ESBuild to compile an ES module (and its deps) into a CommonJS bundle
+Bundle the source code to a CommonJS module (using ESBuild)
 
 ### Arguments
 

package/bin/commands/bundle.js

@@ -1,10 +1,27 @@
+import { installed, which } from '../../src/util.js'
 import { spawn } from 'child_process'
-import { join } from 'path'
-
-const BIN_PATH = join(process.cwd(), 'node_modules', '.bin', 'esbuild')
 
+/**
+ * Bundle ESM (ECMAScript Module) code (with tree-shaking)
+ * @param {string} input the input path
+ * @param {string} output the output path
+ */
 export async function bundle (input, output) {
-  spawn(BIN_PATH, ['--format=esm', '--bundle', input, `--outfile=${output}`], {
+  const npmExists = await which('npm')
+  if (!npmExists) {
+    console.error('npm not found')
+    console.error('is node installed?')
+    return
+  }
+
+  const esbuildExists = await installed('esbuild')
+  if (!esbuildExists) {
+    console.error('esbuild not found')
+    console.error('esbuild can be installed with `npm i -g esbuild`')
+    return
+  }
+
+  spawn('esbuild', ['--format=esm', '--bundle', input, `--outfile=${output}`], {
     cwd: process.cwd(),
     stdio: ['pipe', process.stdout, process.stderr]
   }).on('error', err => {

package/bin/commands/commonjs.js

@@ -1,10 +1,27 @@
+import { installed, which } from '../../src/util.js'
 import { spawn } from 'child_process'
-import { join } from 'path'
-
-const BIN_PATH = join(process.cwd(), 'node_modules', '.bin', 'esbuild')
 
+/**
+ * Bundle CJS (CommonJS) code
+ * @param {string} input the input path
+ * @param {string} output the output path
+ */
 export async function commonjs (input, output) {
-  spawn(BIN_PATH, ['--format=cjs', '--bundle', input, `--outfile=${output}`], {
+  const npmExists = await which('npm')
+  if (!npmExists) {
+    console.error('npm not found')
+    console.error('is node installed?')
+    return
+  }
+
+  const esbuildExists = await installed('esbuild')
+  if (!esbuildExists) {
+    console.error('esbuild not found')
+    console.error('esbuild can be installed with `npm i -g esbuild`')
+    return
+  }
+
+  spawn('esbuild', ['--format=cjs', '--bundle', input, `--outfile=${output}`], {
     cwd: process.cwd(),
     stdio: ['pipe', process.stdout, process.stderr]
   }).on('error', err => {

package/bin/commands/lint.js

@@ -8,7 +8,7 @@ export async function lint (flags) {
     cwd: process.cwd(),
     stdio: ['pipe', 'pipe', 'pipe']
   }).on('error', err => {
-    console.error(`test${err}`)
+    console.error(`${err}`)
   })
 
   child.stdout.on('data', (data) => {

package/bin/commands/minify.js

@@ -1,10 +1,27 @@
+import { installed, which } from '../../src/util.js'
 import { spawn } from 'child_process'
-import { join } from 'path'
-
-const BIN_PATH = join(process.cwd(), 'node_modules', '.bin', 'esbuild')
 
+/**
+ * Bundle and minify ESM (ECMAScript Module) code (with tree-shaking)
+ * @param {string} input the input path
+ * @param {string} output the output path
+ */
 export async function minify (input, output) {
-  spawn(BIN_PATH, ['--format=esm', '--minify', '--bundle', input, `--outfile=${output}`], {
+  const npmExists = await which('npm')
+  if (!npmExists) {
+    console.error('npm not found')
+    console.error('is node installed?')
+    return
+  }
+
+  const esbuildExists = await installed('esbuild')
+  if (!esbuildExists) {
+    console.error('esbuild not found')
+    console.error('esbuild can be installed with `npm i -g esbuild`')
+    return
+  }
+
+  spawn('esbuild', ['--format=esm', '--minify', '--bundle', input, `--outfile=${output}`], {
     cwd: process.cwd(),
     stdio: ['pipe', process.stdout, process.stderr]
   }).on('error', err => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "ES Module Toolkit",
   "keywords": [
     "esm",
@@ -28,7 +28,6 @@
   },
   "dependencies": {
     "commander": "^14.0.3",
-    "esbuild": "^0.27.3",
     "standard": "^17.1.2"
   },
   "engines": {

package/src/util.js

@@ -0,0 +1,32 @@
+import { exec } from 'child_process'
+import { promisify } from 'node:util'
+
+const execAsync = promisify(exec)
+
+/**
+ * Check to see if a NPM package is installed globally
+ * @param {string} pkg the name of the package
+ * @returns {boolean} true if the package is installed, false otherwise
+ */
+export async function installed (pkg) {
+  try {
+    await execAsync(`npm list -g --depth=0 ${pkg}`)
+    return true
+  } catch (e) {
+    return false
+  }
+}
+
+/**
+ * Check to see if an application is installed globally
+ * @param {string} program the name of the application
+ * @returns {boolean} true if the application is installed, false otherwise
+ */
+export async function which (program) {
+  try {
+    await execAsync(`which ${program}`)
+    return true
+  } catch (e) {
+    return false
+  }
+}