@vanillaes/esmtk 0.7.1 → 0.7.3

package/.vscode/launch.json

@@ -2,7 +2,7 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "CopyFileToFile",
+            "name": "Lint",
             "type": "node",
             "request": "launch",
             "skipFiles": [
@@ -10,11 +10,11 @@
             ],
             "program": "${workspaceFolder}/bin/esmtk.js",
             "cwd": "${workspaceFolder}",
-            "args": ["cp", "./test/cp/test1.txt", "./test/cp2/test1.txt"],
+            "args": ["lint"],
             "console": "integratedTerminal",
         },
         {
-            "name": "CopyFileToFolder",
+            "name": "Types",
             "type": "node",
             "request": "launch",
             "skipFiles": [
@@ -22,11 +22,11 @@
             ],
             "program": "${workspaceFolder}/bin/esmtk.js",
             "cwd": "${workspaceFolder}",
-            "args": ["cp", "./test/cp/test1.txt", "./test/cp2"],
+            "args": ["types", "./test/index.js"],
             "console": "integratedTerminal",
         },
         {
-            "name": "CopyFolderRecursively",
+            "name": "CopyFileToFile",
             "type": "node",
             "request": "launch",
             "skipFiles": [
@@ -34,11 +34,11 @@
             ],
             "program": "${workspaceFolder}/bin/esmtk.js",
             "cwd": "${workspaceFolder}",
-            "args": ["cp", "-r", "./test/cp/", "./test/cp2"],
+            "args": ["cp", "./test/cp/test1.txt", "./test/cp2/test1.txt"],
             "console": "integratedTerminal",
         },
         {
-            "name": "Lint",
+            "name": "CopyFileToFolder",
             "type": "node",
             "request": "launch",
             "skipFiles": [
@@ -46,7 +46,19 @@
             ],
             "program": "${workspaceFolder}/bin/esmtk.js",
             "cwd": "${workspaceFolder}",
-            "args": ["lint"],
+            "args": ["cp", "./test/cp/test1.txt", "./test/cp2"],
+            "console": "integratedTerminal",
+        },
+        {
+            "name": "CopyFolderRecursively",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["cp", "-r", "./test/cp/", "./test/cp2"],
             "console": "integratedTerminal",
         },
         {

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
 
@@ -25,9 +25,25 @@ Lint uses StandardJS to lint the source
 esmtk lint
 ```
 
+## Types
+
+Type check the JSDoc typings (using Typescript)
+
+### Arguments
+
+`esmtk types index.js`
+
+- `[entry]` - the entry-point for the source
+
+### Usage
+
+```sh
+esmtk types index.js
+```
+
 ## 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 +60,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 +77,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

@@ -11,14 +11,14 @@ export async function bundle (input, output) {
   if (!npmExists) {
     console.error('npm not found')
     console.error('is node installed?')
-    return
+    process.exit(1)
   }
 
   const esbuildExists = await installed('esbuild')
   if (!esbuildExists) {
     console.error('esbuild not found')
     console.error('esbuild can be installed with `npm i -g esbuild`')
-    return
+    process.exit(1)
   }
 
   spawn('esbuild', ['--format=esm', '--bundle', input, `--outfile=${output}`], {

package/bin/commands/commonjs.js

@@ -11,14 +11,14 @@ export async function commonjs (input, output) {
   if (!npmExists) {
     console.error('npm not found')
     console.error('is node installed?')
-    return
+    process.exit(1)
   }
 
   const esbuildExists = await installed('esbuild')
   if (!esbuildExists) {
     console.error('esbuild not found')
     console.error('esbuild can be installed with `npm i -g esbuild`')
-    return
+    process.exit(1)
   }
 
   spawn('esbuild', ['--format=cjs', '--bundle', input, `--outfile=${output}`], {

package/bin/commands/index.js

@@ -4,3 +4,4 @@ export { cp } from './cp.js'
 export { lint } from './lint.js'
 export { minify } from './minify.js'
 export { rm } from './rm.js'
+export { types } from './types.js'

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?')
+    process.exit(1)
+  }
+
+  const esbuildExists = await installed('esbuild')
+  if (!esbuildExists) {
+    console.error('esbuild not found')
+    console.error('esbuild can be installed with `npm i -g esbuild`')
+    process.exit(1)
+  }
+
+  spawn('esbuild', ['--format=esm', '--minify', '--bundle', input, `--outfile=${output}`], {
     cwd: process.cwd(),
     stdio: ['pipe', process.stdout, process.stderr]
   }).on('error', err => {

package/bin/commands/types.js

@@ -0,0 +1,29 @@
+import { installed, which } from '../../src/util.js'
+import { spawn } from 'child_process'
+
+/**
+ * Type Check the JSDOC typings
+ * @param {string} entry the entry point
+ */
+export async function types (entry) {
+  const npmExists = await which('npm')
+  if (!npmExists) {
+    console.error('npm not found')
+    console.error('is node installed?')
+    process.exit(1)
+  }
+
+  const esbuildExists = await installed('typescript')
+  if (!esbuildExists) {
+    console.error('typescript not found')
+    console.error('typescript can be installed with `npm i -g typescript`')
+    process.exit(1)
+  }
+
+  spawn('tsc', [entry, '-t', 'esnext', '--allowJS', '--checkJS', '--skipLibCheck', '--noEmit'], {
+    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, cp, commonjs, lint, minify, rm } from './commands/index.js'
+import { bundle, cp, commonjs, lint, minify, rm, types } from './commands/index.js'
 import { Command } from 'commander'
 import { createRequire } from 'module'
 const program = new Command()
@@ -16,6 +16,12 @@ program.command('lint')
     lint(flags)
   })
 
+program.command('types <entry>')
+  .description('Type check the JSDoc typings using Typescript')
+  .action((entry) => {
+    types(entry)
+  })
+
 program.command('bundle <input> <output>')
   .description('Bundle the source using ESBuild')
   .action((input, output) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "ES Module Toolkit",
   "keywords": [
     "esm",
@@ -23,7 +23,8 @@
   },
   "scripts": {
     "lint": "./bin/esmtk.js lint",
-    "preversion": "npm run lint",
+    "types": "./bin/esmtk.js types src/index.js",
+    "preversion": "npm run lint && npm run types",
     "postversion": "git push --follow-tags"
   },
   "dependencies": {
@@ -32,5 +33,8 @@
   },
   "engines": {
     "node": ">=17"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.5"
   }
 }

package/src/cp.js

@@ -51,7 +51,7 @@ export async function copyAsync (source, target, force = false) {
  * Recursively copy a directory asynchronously
  * @param {string} source The source directory
  * @param {string} target The target directory
- * @param {bool} force If the file already exists, overwrite it (default false)
+ * @param {boolean} force If the file already exists, overwrite it (default false)
  */
 export async function copyRecursiveAsync (source, target, force = false) {
   const sExists = await fileExists(source)

package/src/rm.js

@@ -27,7 +27,7 @@ export async function removeAsync (path, force = false) {
 /**
  * Recursively remove a file|directory asynchronously
  * @param {string} path The file|directory to remove
- * @param {bool} force Ignore exceptions if the file|directory doesn't exist (default false)
+ * @param {boolean} force Ignore exceptions if the file|directory doesn't exist (default false)
  */
 export async function removeRecursiveAsync (path, force = false) {
   const exists = await fileExists(path)