@vanillaes/esmtk 0.24.4 → 0.24.6

package/README.md

@@ -72,7 +72,7 @@ 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 (ignore tests)
+# run the tests (change the root)
 npx @vanillaes/esmtk test **/*.test.js --root src/
 
 # run the tests (watch for changes)

package/bin/commands/bundle.js

@@ -5,7 +5,7 @@ import { spawn } from 'child_process'
  * Bundle ESM (ECMAScript Module) code (with tree-shaking)
  * @param {string} input the input path
  * @param {string} output the output path
- * @param {any} options bundle options
+ * @param {object} options 'bundle' options
  */
 export async function bundle (input, output, options) {
   const npmExists = await which('npm')

package/bin/commands/clean.js

@@ -4,7 +4,7 @@ import { fileExists, match } from '../../src/util.js'
 /**
  * Clean build artifcats using sensible defaults
  * @param {string} root the root directory
- * @param {any} options clean options
+ * @param {object} options 'clean' options
  */
 export async function clean (root, options) {
   const exists = await fileExists(root)
@@ -30,6 +30,12 @@ export async function clean (root, options) {
   }
 }
 
+/**
+ * Run one category of build artifacts
+ * @param {string} root the root 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/**')
   await removeMultipleAsync(files, options?.force)

package/bin/commands/commonjs.js

@@ -5,7 +5,7 @@ import { spawn } from 'child_process'
  * Bundle CJS (CommonJS) code
  * @param {string} input the input path
  * @param {string} output the output path
- * @param {any} options commonjs options
+ * @param {object} options 'commonjs' options
  */
 export async function commonjs (input, output, options) {
   const npmExists = await which('npm')

package/bin/commands/cp.js

@@ -4,7 +4,7 @@ import { expand } from '../../src/index.js'
 /**
  * POSIX cp Implemented in Node
  * @param {string[]} paths Variadic of source/destination paths
- * @param {any} options 'cp' options
+ * @param {object} options 'cp' options
  */
 export async function cp (paths, options) {
   if (paths.length < 2) {
@@ -30,9 +30,9 @@ export async function cp (paths, options) {
   }
 
   if (paths.length > 2) {
-    let sources = paths.slice(0, -1)
-    sources = await await Promise.all(sources.map(source => expand(source)))
-    sources = sources.flat()
+    const sourcePatterns = paths.slice(0, -1)
+    const sourceFiles = await await Promise.all(sourcePatterns.map(source => expand(source)))
+    const sources = sourceFiles.flat()
     const target = paths.slice(-1)[0]
 
     await copyMultipleAsync(sources, target, options?.force)

package/bin/commands/init.js

@@ -10,7 +10,7 @@ const execAsync = promisify(exec)
 
 /**
  * Create a package.json file for ECMAScript Development
- * @param {any} options init options
+ * @param {object} options 'init' options
  */
 export async function init (options) {
   const npmExists = await which('npm')
@@ -46,10 +46,9 @@ export async function init (options) {
   pkg.name = await ask(program, 'package name', DIRNAME)
   pkg.version = await ask(program, 'version', '0.0.0')
   pkg.description = await ask(program, 'description')
-  let keywords = await ask(program, 'keywords')
+  const keywords = await ask(program, 'keywords')
   if (keywords) {
-    keywords = keywords.split(' ')
-    pkg.keywords = keywords
+    pkg.keywords = keywords.split(' ')
   }
   pkg.repository = await ask(program, 'git repository', REPOSITORY)
   const user = await ask(program, 'author', USERNAME)
@@ -97,12 +96,23 @@ export async function init (options) {
   program.close()
 }
 
+/**
+ * Ask a question on the command-line
+ * @param {object} program reference to the CLI
+ * @param {string} prompt the question to ask the User
+ * @param {string} [defaultValue] the default value for the question
+ * @returns {Promise<string>} the answer to the question | the default value
+ */
 async function ask (program, prompt, defaultValue) {
   const suffix = defaultValue ? `(${defaultValue}) ` : ''
   const answer = await program.question(`${prompt}: ${suffix}`)
   return answer || defaultValue
 }
 
+/**
+ * Fetch the user.name from .gitconfig
+ * @returns {Promise<string>} the user.name
+ */
 async function fetchGitUser () {
   const { stdout, stderr } = await execAsync('git config --get user.name')
   if (stderr) {
@@ -113,6 +123,10 @@ async function fetchGitUser () {
   return `${stdout}`.trim()
 }
 
+/**
+ * Fetch the user.email from .gitconfig
+ * @returns {Promise<string>} the user.email
+ */
 async function fetchGitEmail () {
   const { stdout, stderr } = await execAsync('git config --get user.email')
   if (stderr) {
@@ -123,6 +137,10 @@ async function fetchGitEmail () {
   return `${stdout}`.trim()
 }
 
+/**
+ * Get the repository name from .git/config
+ * @returns {Promise<string>} the repository name
+ */
 async function getGitRepository () {
   const config = join(process.cwd(), '.git', 'config')
   const exists = await fileExists(config)

package/bin/commands/lint.js

@@ -5,7 +5,7 @@ const BIN_PATH = join(process.cwd(), 'node_modules', '.bin', 'standard')
 
 /**
  * Lint the source code (using StandardJS)
- * @param {any} options
+ * @param {object} options 'lint' options
  */
 export async function lint (options) {
   const args = []

package/bin/commands/minify.js

@@ -5,7 +5,7 @@ import { spawn } from 'child_process'
  * Bundle and minify ESM (ECMAScript Module) code (with tree-shaking)
  * @param {string} input the input path
  * @param {string} output the output path
- * @param {any} options minify options
+ * @param {object} options 'minify' options
  */
 export async function minify (input, output, options) {
   const npmExists = await which('npm')

package/bin/commands/preview.js

@@ -8,7 +8,7 @@ const require = createRequire(import.meta.url)
 
 /**
  * Preview the package contents included during 'npm publish'
- * @param {any} options preview options
+ * @param {object} options 'preview' options
  */
 export async function preview (options) {
   let ignore = await readNPMIgnore(options.root)
@@ -35,8 +35,8 @@ export async function preview (options) {
 
 /**
  * Read .npmignore
- * @param {*} root the root path
- * @returns a comma-deliminated list of ignore globs
+ * @param {string} root the root path
+ * @returns {Promise<string>} a comma-deliminated list of ignore globs
  */
 async function readNPMIgnore (root) {
   const path = join(root, '.npmignore')
@@ -50,8 +50,8 @@ async function readNPMIgnore (root) {
 
 /**
  * File list comparator
- * @param {*} a file path a
- * @param {*} b file path b
+ * @param {string} a file path a
+ * @param {string} b file path b
  * @returns {number} 1 | -1
  */
 function fileCompare (a, b) {
@@ -68,8 +68,8 @@ function fileCompare (a, b) {
 
 /**
  * Format a file path to include file size
- * @param {*} path the file path
- * @returns file size followed by file path
+ * @param {string} path the file path
+ * @returns {string} file size followed by file path
  */
 function formatFile (path) {
   const size = statSync(path).size

package/bin/commands/rm.js

@@ -4,7 +4,7 @@ import { expand } from '../../src/util.js'
 /**
  * POSIX rm Implemented in Node
  * @param {string[]} paths Variadic of file paths
- * @param {any} options rm options
+ * @param {object} options 'rm' options
  */
 export async function rm (paths, options) {
   if (paths.length === 1) {
@@ -26,9 +26,9 @@ export async function rm (paths, options) {
   }
 
   if (paths.length > 1) {
-    let files = await await Promise.all(paths.map(path => expand(path)))
-    files = files.flat()
+    const files = await await Promise.all(paths.map(path => expand(path)))
+    const flatFiles = files.flat()
 
-    await removeMultipleAsync(files, options?.force)
+    await removeMultipleAsync(flatFiles, options?.force)
   }
 }

package/bin/commands/test.js

@@ -3,7 +3,7 @@ import { spawn } from 'child_process'
 /**
  * Test runnner using Tape-ES
  * @param {string} glob the glob to match test files
- * @param {any} options bundle options
+ * @param {object} options 'test' options
  */
 export async function test (glob, options) {
   const args = []

package/bin/commands/types.js

@@ -4,6 +4,7 @@ import { spawn } from 'child_process'
 /**
  * Type Check the JSDOC typings
  * @param {string} entry the entry point
+ * @param {object} options 'types' options
  */
 export async function types (entry, options) {
   const npmExists = await which('npm')
@@ -26,6 +27,8 @@ export async function types (entry, options) {
   args.push('esnext')
   args.push('--allowJS')
   args.push('--checkJS')
+  args.push('--module')
+  args.push('esnext')
   args.push('--noEmit')
   args.push('--skipLibCheck')
   if (options?.strict) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.24.4",
+  "version": "0.24.6",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -59,5 +59,10 @@
   "devDependencies": {
     "@types/json5": "^0.0.30",
     "@types/node": "^25.5.0"
+  },
+  "lint": {
+    "ignore": [
+      "**/__tests__/**"
+    ]
   }
 }

package/src/cp.d.ts

@@ -1,6 +1,5 @@
 /**
  * Copy a single file asynchronously
- *
  * @param {string} source The source file
  * @param {string} target The target file
  * @param {boolean} force If the file already exists, overwrite it (default false)
@@ -8,7 +7,6 @@
 export function copyAsync(source: string, target: string, force?: boolean): Promise<void>;
 /**
  * Copy a multiple files/globs asynchronously
- *
  * @param {string[]} sources The source files/globs
  * @param {string} target The target file
  * @param {boolean} force If the file already exists, overwrite it (default false)
@@ -16,7 +14,6 @@ export function copyAsync(source: string, target: string, force?: boolean): Prom
 export function copyMultipleAsync(sources: string[], target: string, force?: boolean): Promise<void>;
 /**
  * Recursively copy a directory asynchronously
- *
  * @param {string} source The source directory
  * @param {string} target The target directory
  * @param {boolean} force If the file already exists, overwrite it (default false)

package/src/cp.js

@@ -4,7 +4,6 @@ import { cp, stat } from 'node:fs/promises'
 
 /**
  * Copy a single file asynchronously
- *
  * @param {string} source The source file
  * @param {string} target The target file
  * @param {boolean} force If the file already exists, overwrite it (default false)
@@ -54,7 +53,6 @@ export async function copyAsync (source, target, force = false) {
 
 /**
  * Copy a multiple files/globs asynchronously
- *
  * @param {string[]} sources The source files/globs
  * @param {string} target The target file
  * @param {boolean} force If the file already exists, overwrite it (default false)
@@ -83,7 +81,6 @@ export async function copyMultipleAsync (sources, target, force = false) {
 
 /**
  * Recursively copy a directory asynchronously
- *
  * @param {string} source The source directory
  * @param {string} target The target directory
  * @param {boolean} force If the file already exists, overwrite it (default false)

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export { copyAsync, copyRecursiveAsync } from "./cp.js";
+export { copyAsync, copyMultipleAsync, copyRecursiveAsync } from "./cp.js";
 export { removeAsync, removeMultipleAsync, removeRecursiveAsync } from "./rm.js";
 export { expand, fileExists, installed, match, which } from "./util.js";

package/src/rm.d.ts

@@ -6,7 +6,6 @@
 export function removeAsync(path: string, force?: boolean): Promise<void>;
 /**
  * Remove a multiple files/globs asynchronously
- *
  * @param {string[]} files The files/globs to delete
  * @param {boolean} force If the file already exists, overwrite it (default false)
  */

package/src/rm.js

@@ -31,7 +31,6 @@ export async function removeAsync (path, force = false) {
 
 /**
  * Remove a multiple files/globs asynchronously
- *
  * @param {string[]} files The files/globs to delete
  * @param {boolean} force If the file already exists, overwrite it (default false)
  */

package/src/util.d.ts

@@ -1,10 +1,9 @@
 /**
  * Expand file/glob into a list of paths
- *
- * @param {*} source the source file/glob
+ * @param {string} source the source file/glob
  * @returns {Promise<string[]>} an array of paths
  */
-export function expand(source: any): Promise<string[]>;
+export function expand(source: string): Promise<string[]>;
 /**
  * Check if a file/folder exists
  * @param {string} path the path to the file/folder

package/src/util.js

@@ -6,8 +6,7 @@ const execAsync = promisify(exec)
 
 /**
  * Expand file/glob into a list of paths
- *
- * @param {*} source the source file/glob
+ * @param {string} source the source file/glob
  * @returns {Promise<string[]>} an array of paths
  */
 export async function expand (source) {