@vanillaes/esmtk 0.27.0 → 1.0.1

package/README.md

@@ -2,6 +2,8 @@
 
 <div align="center">ESMTK, essential tools for ECMAScript module development</div>
 
+<br />
+
 <div align="center">
   <a href="https://github.com/vanillaes/esmtk/releases"><img src="https://badgen.net/github/tag/vanillaes/esmtk?cache-control=no-cache" alt="GitHub Release"></a>
   <a href="https://www.npmjs.com/package/@vanillaes/esmtk"><img src="https://badgen.net/npm/v/@vanillaes/esmtk?icon=npm" alt="NPM Version"></a>
@@ -57,7 +59,7 @@ Run tests (using Tape-ES)
 
 - `[glob]` - the glob used to locate test files (default: `**/*.spec.js`)
 - `--ignore` - the ignore matcher pattern (default `**/node_modules/**`)
-- `--root` - the root path to run the tests from (default `process.cwd()`)
+- `--cwd` - the current working directory (default `process.cwd()`)
 - `--watch` - watch for changes to the tests
 
 ### Usage
@@ -72,8 +74,8 @@ npx @vanillaes/esmtk test **/*.test.js
 # run the tests (ignore tests)
 npx @vanillaes/esmtk test **/*.test.js --ignore **/node_modules/**,src/rm.spec.js
 
-# run the tests (change the root)
-npx @vanillaes/esmtk test **/*.test.js --root src/
+# run the tests (change the current working directory)
+npx @vanillaes/esmtk test **/*.test.js --cwd src/
 
 # run the tests (watch for changes)
 npx @vanillaes/esmtk test --watch
@@ -222,9 +224,9 @@ Clean up build artifacts
 
 ### Arguments
 
-`esmtk clean [...options] [root]`
+`esmtk clean [...options] [cwd]`
 
-- `[root]` - the root directory to perform the cleanup (default: `process.cwd()`)
+- `[cwd]` - the current working directory (default: `process.cwd()`)
 - `--bundle` - Clean bundled build artifacts (default: `**/*.esm.js`)
 - `--minify` - Clean minified build artifacts (default: `**/*.min.js`)
 - `--typings` - Clean typing artifacts (default: `**/*.d.ts`)
@@ -254,7 +256,7 @@ Preview the package contents included during `npm publish`
 
 `esmtk preview [...options]`
 
-- `--root` - the root path to preview
+- `--cwd` - the current working directory
 
 ### Usage
 
@@ -262,8 +264,8 @@ Preview the package contents included during `npm publish`
 # preview the package contents
 esmtk preview
 
-# preview the package contents (from another root directory)
-esmtk preview --root some/other/dir
+# preview the package contents (from another directory)
+esmtk preview --cwd some/other/dir
 ```
 
 

package/bin/commands/clean.js

@@ -3,40 +3,40 @@ import { fileExists, match } from '../../src/util.js'
 
 /**
  * Clean build artifcats using sensible defaults
- * @param {string} root the root directory
+ * @param {string} cwd the currnt working directory
  * @param {object} options 'clean' options
  */
-export async function clean (root, options) {
-  const exists = await fileExists(root)
+export async function clean (cwd, options) {
+  const exists = await fileExists(cwd)
   if (!exists) {
-    console.error(`clean: ${root} No such file or directory`)
+    console.error(`clean: ${cwd} No such file or directory`)
     process.exit(1)
   }
 
   if (options?.bundle) {
-    await cleanOne(root, options.bundle, options)
+    await cleanOne(cwd, options.bundle, options)
   }
 
   if (options?.minify) {
-    await cleanOne(root, options.minify, options)
+    await cleanOne(cwd, options.minify, options)
   }
 
   if (options?.typings) {
-    await cleanOne(root, options.typings, options)
+    await cleanOne(cwd, options.typings, options)
   }
 
   if (options?.custom) {
-    await cleanOne(root, options.custom, options)
+    await cleanOne(cwd, options.custom, options)
   }
 }
 
 /**
  * Run one category of build artifacts
- * @param {string} root the root directory (default process.cwd())
+ * @param {string} cwd the current working directory (default process.cwd())
  * @param {string} glob the pattern of files to match
  * @param {object} options 'clean' options
  */
-async function cleanOne (root, glob, options) {
-  const files = await match(glob, root, 'node_modules/**')
+async function cleanOne (cwd, glob, options) {
+  const files = await match(glob, cwd, 'node_modules/**')
   await removeMultipleAsync(files, options?.force)
 }

package/bin/commands/preview.js

@@ -11,10 +11,10 @@ const require = createRequire(import.meta.url)
  * @param {object} options 'preview' options
  */
 export async function preview (options) {
-  let ignore = await readNPMIgnore(options.root)
+  let ignore = await readNPMIgnore(options.cwd)
   ignore = `${ignore},node_modules/,package-lock.json`
 
-  let files = await match('**/*', options.root, ignore)
+  let files = await match('**/*', options.cwd, ignore)
   if (files.length === 0) {
     console.log('preview: no files found')
     process.exit(0)
@@ -23,7 +23,7 @@ export async function preview (options) {
     .filter(path => statSync(path).isFile())
     .sort((a, b) => fileCompare(a, b))
 
-  const pkg = require(join(options.root, 'package.json'))
+  const pkg = require(join(options.cwd, 'package.json'))
 
   console.log()
   console.log(`📦  ${pkg.name}@${pkg.version}`)
@@ -35,11 +35,11 @@ export async function preview (options) {
 
 /**
  * Read .npmignore
- * @param {string} root the root path
+ * @param {string} cwd the current working directory
  * @returns {Promise<string>} a comma-deliminated list of ignore globs
  */
-async function readNPMIgnore (root) {
-  const path = join(root, '.npmignore')
+async function readNPMIgnore (cwd) {
+  const path = join(cwd, '.npmignore')
   const contents = await readFile(path, 'utf8')
   return contents
     .split('\n')

package/bin/commands/test.js

@@ -13,9 +13,9 @@ export async function test (glob, options) {
     args.push('--ignore')
     args.push(options.ignore)
   }
-  if (options?.root) {
-    args.push('--root')
-    args.push(options.root)
+  if (options?.cwd) {
+    args.push('--cwd')
+    args.push(options.cwd)
   }
   if (options?.watch) {
     args.push('--watch')

package/bin/esmtk.js

@@ -19,7 +19,7 @@ program.command('test')
   .description('Run tests using Tape-ES')
   .argument('[glob]', 'The glob pattern used to find test files (default: `**/*.spec.js`)', '**/*.spec.js')
   .option('--ignore <ignore>', 'the ignore matcher pattern (default `**/node_modules/**`)')
-  .option('--root <root>', 'the root path to run the tests from (default `process.cwd()`)')
+  .option('--cwd <cwd>', 'the current working directory (default `process.cwd()`)')
   .option('--watch', 'Watch the files for changes')
   .action((glob, options) => {
     test(glob, options)
@@ -35,6 +35,7 @@ program.command('lint')
 
 program.command('type <entry>')
   .description('Type check the JSDoc typings using Typescript')
+  .option('--strict', 'Enable \'strict mode\'')
   .action((entry, options) => {
     type(entry, options)
   })
@@ -69,13 +70,13 @@ program.command('minify <input> <output>')
 
 program.command('clean')
   .description('Clean build artificts')
-  .argument('[root]', 'The root directory to perform operations from (default cwd)', process.cwd())
+  .argument('[cwd]', 'The current working directory (default cwd)', process.cwd())
   .option('--bundle [bundle]', 'Clean bundled build artifacts (default: **/*.esm.js)')
   .option('--minify [minify]', 'Clean minified build artifacts (default: **/*.min.js)')
   .option('--typings [typings]', 'Clean typing artifacts (default: **/*.d.ts)')
   .option('--custom <custom>', 'Clean based on a user-defined pattern')
   // .option('-f, --force', 'Do not prompt before overwriting', false)
-  .action((root, options) => {
+  .action((cwd, options) => {
     // set --bundle default
     if (options?.bundle && typeof (options.bundle) === 'boolean') {
       options.bundle = '**/*.esm.js'
@@ -89,12 +90,12 @@ program.command('clean')
       options.typings = '**/*.d.ts'
     }
 
-    clean(root, options)
+    clean(cwd, options)
   })
 
 program.command('preview')
   .description('Preview the package contents included during \'npm publish\'')
-  .option('--root <root>', 'the root path to run the tests from (default `process.cwd()`)', process.cwd())
+  .option('--cwd <cwd>', 'the current working directory (default `process.cwd()`)', process.cwd())
   .action((options) => {
     preview(options)
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.27.0",
+  "version": "1.0.1",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "@vanillaes/lint-es": "^1.0.0",
-    "@vanillaes/tape-es": "^3.0.3",
+    "@vanillaes/tape-es": "^4.0.1",
     "commander": "^14.0.3"
   },
   "devDependencies": {

package/src/util.d.ts

@@ -19,11 +19,11 @@ export function installed(pkg: string): Promise<boolean>;
 /**
  * Description
  * @param {string} pattern glob pattern(s) to match
- * @param {string} root root path where the matcher runs from
+ * @param {string} cwd the current working directory
  * @param {string} ignore glob of pattern(s) to ignore
  * @returns {Promise<string[]>} an array of paths
  */
-export function match(pattern: string, root?: string, ignore?: string): Promise<string[]>;
+export function match(pattern: string, cwd?: string, ignore?: string): Promise<string[]>;
 /**
  * Check to see if an application is installed globally
  * @param {string} program the name of the application

package/src/util.js

@@ -59,16 +59,16 @@ export async function installed (pkg) {
 /**
  * Description
  * @param {string} pattern glob pattern(s) to match
- * @param {string} root root path where the matcher runs from
+ * @param {string} cwd the current working directory
  * @param {string} ignore glob of pattern(s) to ignore
  * @returns {Promise<string[]>} an array of paths
  */
-export async function match (pattern, root = process.cwd(), ignore = null) {
+export async function match (pattern, cwd = process.cwd(), ignore = null) {
   if (ignore) {
     const ignores = ignore.includes(',') ? ignore.split(',') : [ignore]
-    return await Array.fromAsync(glob(pattern, { cwd: root, exclude: ignores }))
+    return await Array.fromAsync(glob(pattern, { cwd, exclude: ignores }))
   }
-  return await Array.fromAsync(glob(pattern, { cwd: root }))
+  return await Array.fromAsync(glob(pattern, { cwd }))
 }
 
 /**