@vanillaes/esmtk 0.19.1 → 0.20.0

package/.vscode/launch.json

@@ -25,6 +25,18 @@
             "args": ["init"],
             "console": "integratedTerminal",
         },
+        {
+            "name": "Test",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["test"],
+            "console": "integratedTerminal",
+        },
         {
             "name": "Lint",
             "type": "node",

package/README.md

@@ -10,6 +10,62 @@ ESMTK, essential tools for ECMAScript module development
   <a href="https://github.com/vanillaes/esmtk/actions"><img src="https://github.com/vanillaes/esmtk/workflows/Release/badge.svg" alt="Release Status"></a>
 </div>
 
+## Commands
+
+- [init](#init) - Create a package.json file for ECMAScript module development
+- [test](#test) - Run tests (using Tape-ES)
+- [lint](#lint) - Lint the source code (using StandardJS)
+- [types](#lint) - Type check the JSDoc typings (using Typescript)
+- [bundle](#bundle) - Bundle the source code to an ECMAScript module (using ESBuild)
+- [minify](#minify) - Bundle and Minify the source code to an ECMAScript module (using ESBuild)
+- [commonjs](#commonjs) - Bundle the source code to a CommonJS module (using ESBuild)
+- [typeings](#typings) - Generate Type Declarations (.d.ts) from JSDoc (using Typescript)
+- [clean](#clean) - Clean up build artifacts
+- [cp](#cp) - A cross-platform clone of the `cp` command in Linux
+- [rm](#rm) - A cross-platform clone of the `rm` command in Linux
+
+
+## Init
+
+Create a package.json file for ECMAScript module development
+
+### Arguments
+
+`esmtk init`
+
+### Usage
+
+```sh
+# init package.json
+npx @vanillaes/esmtk init
+```
+
+
+## Test
+
+Run tests (using Tape-ES)
+
+### Arguments
+
+`esmtk test [glob]`
+
+- `[glob]` - the glob used to locate test files (default: `**/*.spec.js`)
+- `--watch` - watch for changes to the tests
+
+### Usage
+
+```sh
+# run the tests
+npx @vanillaes/esmtk test
+
+# run the tests (using a different naming scheme)
+npx @vanillaes/esmtk test **/*.test.js
+
+# run the tests (watch for changes)
+npx @vanillaes/esmtk test --watch
+```
+
+
 ## Lint
 
 Lint the source code (using StandardJS)
@@ -30,6 +86,7 @@ esmtk lint
 esmtk --fix lint
 ```
 
+
 ## Types
 
 Type check the JSDoc typings (using Typescript)
@@ -53,6 +110,7 @@ esmtk types --strict index.js
 
 **Node: Due to Typescript limitations, inline JSDoc typings will be ignored if typings (ie `*.d.ts` files) exist.**
 
+
 ## Bundle
 
 Bundle the source code to an ECMAScript module (using ESBuild)
@@ -75,6 +133,7 @@ esmtk bundle src/sample.js bundle.js
 esmtk bundle --platform=node src/sample.js bundle.js
 ```
 
+
 ## Minify
 
 Bundle and Minify the source code to an ECMAScript module (using ESBuild)
@@ -101,6 +160,7 @@ esmtk minify --platform=node src/sample.js bundle.min.js
 esmtk minify --sourcemap src/sample.js bundle.min.js
 ```
 
+
 ## CommonJS
 
 Bundle the source code to a CommonJS module (using ESBuild)
@@ -123,6 +183,7 @@ esmtk commonjs src/sample.js bundle.cjs
 esmtk commonjs --platform=node src/sample.js bundle.cjs
 ```
 
+
 ## Typings
 
 Generate Type Declarations (.d.ts) from JSDoc (using Typescript)
@@ -140,6 +201,7 @@ Generate Type Declarations (.d.ts) from JSDoc (using Typescript)
 esmtk typings index.js
 ```
 
+
 ## Clean
 
 Clean up build artifacts
@@ -169,9 +231,10 @@ esmtk clean --custom *.scss.css
 
 **Node: The `clean` command automatically ignores the contents of `node_modules/`**
 
-## Copy
 
-Copy is a cross-platform clone of the `cp` command in Linux
+## CP
+
+A cross-platform clone of the `cp` command in Linux
 
 ### Arguments
 
@@ -200,9 +263,10 @@ esmtk cp *.txt *.js *.ts dest/
 esmtk cp -r src/ dest/
 ```
 
-## Remove
 
-Remove is a cross-platform clone of the `rm` command in Linux
+## RM
+
+A cross-platform clone of the `rm` command in Linux
 
 ### Arguments
 

package/bin/commands/index.js

@@ -6,5 +6,6 @@ export { init } from './init.js'
 export { lint } from './lint.js'
 export { minify } from './minify.js'
 export { rm } from './rm.js'
+export { test } from './test.js'
 export { types } from './types.js'
 export { typings } from './typings.js'

package/bin/commands/test.js

@@ -0,0 +1,22 @@
+import { spawn } from 'child_process'
+
+/**
+ * Test runnner using Tape-ES
+ * @param {string} glob the glob to match test files
+ * @param {any} options bundle options
+ */
+export async function test (glob, options) {
+  const args = []
+  args.push('./node_modules/.bin/tape-es')
+  args.push(glob)
+  if (options?.watch) {
+    args.push('--watch')
+  }
+
+  spawn('node', args, {
+    cwd: process.cwd(),
+    stdio: ['pipe', process.stdout, process.stderr]
+  }).on('error', err => {
+    console.error(err)
+  })
+}

package/bin/esmtk.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { bundle, clean, cp, commonjs, init, lint, minify, rm, types, typings } from './commands/index.js'
+import { bundle, clean, cp, commonjs, init, lint, minify, rm, test, types, typings } from './commands/index.js'
 import { Command } from 'commander'
 import { createRequire } from 'module'
 const program = new Command()
@@ -14,6 +14,14 @@ program.command('init')
     init()
   })
 
+program.command('test')
+  .description('Run tests using Tape-ES')
+  .argument('[glob]', 'The glob pattern used to find test files', '**/*.spec.js')
+  .option('--watch', 'Watch the files for changes')
+  .action((glob, options) => {
+    test(glob, options)
+  })
+
 program.command('lint')
   .description('Lint the source using StandardJS')
   .option('--fix', 'Automatically fix problems')
@@ -24,7 +32,6 @@ program.command('lint')
 
 program.command('types <entry>')
   .description('Type check the JSDoc typings using Typescript')
-  .option('--strict', 'Enable strict type checks')
   .action((entry, options) => {
     types(entry, options)
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -50,6 +50,7 @@
     "node": ">=22"
   },
   "dependencies": {
+    "@vanillaes/tape-es": "^2.0.2",
     "commander": "^14.0.3",
     "standard": "^17.1.2"
   },