@vanillaes/esmtk 0.8.0 → 0.10.0

package/.vscode/launch.json

@@ -1,6 +1,18 @@
 {
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Version",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["--version"],
+            "console": "integratedTerminal",
+        },
         {
             "name": "Lint",
             "type": "node",
@@ -22,7 +34,19 @@
             ],
             "program": "${workspaceFolder}/bin/esmtk.js",
             "cwd": "${workspaceFolder}",
-            "args": ["types", "./test/index.js"],
+            "args": ["types", "./src/index.js"],
+            "console": "integratedTerminal",
+        },
+        {
+            "name": "Typings",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["typings", "./src/index.js"],
             "console": "integratedTerminal",
         },
         {

package/README.md

@@ -34,6 +34,7 @@ Type check the JSDoc typings (using Typescript)
 `esmtk types index.js`
 
 - `[entry]` - the entry-point for the source
+- `--strict` - enable 'strict mode' type checks
 
 ### Usage
 
@@ -41,6 +42,22 @@ Type check the JSDoc typings (using Typescript)
 esmtk types index.js
 ```
 
+## Typings
+
+Generate Type Declarations (.d.ts) from JSDoc (using Typescript)
+
+### Arguments
+
+`esmtk typings index.js`
+
+- `[entry]` - the entry-point for the source
+
+### Usage
+
+```sh
+esmtk typings index.js
+```
+
 ## Bundle
 
 Bundle the source code to an ECMAScript module (using ESBuild)

package/bin/commands/bundle.js

@@ -1,4 +1,4 @@
-import { installed, which } from '../../src/util.js'
+import { installed, which } from '../../src/index.js'
 import { spawn } from 'child_process'
 
 /**

package/bin/commands/commonjs.js

@@ -1,4 +1,4 @@
-import { installed, which } from '../../src/util.js'
+import { installed, which } from '../../src/index.js'
 import { spawn } from 'child_process'
 
 /**

package/bin/commands/index.js

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

package/bin/commands/minify.js

@@ -1,4 +1,4 @@
-import { installed, which } from '../../src/util.js'
+import { installed, which } from '../../src/index.js'
 import { spawn } from 'child_process'
 
 /**

package/bin/commands/types.js

@@ -1,11 +1,11 @@
-import { installed, which } from '../../src/util.js'
+import { installed, which } from '../../src/index.js'
 import { spawn } from 'child_process'
 
 /**
  * Type Check the JSDOC typings
  * @param {string} entry the entry point
  */
-export async function types (entry) {
+export async function types (entry, options) {
   const npmExists = await which('npm')
   if (!npmExists) {
     console.error('npm not found')
@@ -20,10 +20,19 @@ export async function types (entry) {
     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)
-  })
+  if (options?.strict) {
+    spawn('tsc', [entry, '-t', 'esnext', '--allowJS', '--checkJS', '--skipLibCheck', '--noEmit', '--strict'], {
+      cwd: process.cwd(),
+      stdio: ['pipe', process.stdout, process.stderr]
+    }).on('error', err => {
+      console.error(err)
+    })
+  } else {
+    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/commands/typings.js

@@ -0,0 +1,29 @@
+import { installed, which } from '../../src/index.js'
+import { spawn } from 'child_process'
+
+/**
+ * Generate Typescript typings from JSDoc
+ * @param {string} entry the entry point
+ */
+export async function typings (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', '--declaration', '--emitDeclarationOnly', '--noEmitOnError'], {
+    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, types } from './commands/index.js'
+import { bundle, cp, commonjs, lint, minify, rm, types, typings } from './commands/index.js'
 import { Command } from 'commander'
 import { createRequire } from 'module'
 const program = new Command()
@@ -18,8 +18,15 @@ 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)
+  })
+
+program.command('typings <entry>')
+  .description('Generate typings from JSDoc using Typescript')
   .action((entry) => {
-    types(entry)
+    typings(entry)
   })
 
 program.command('bundle <input> <output>')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "esm",
@@ -13,17 +13,27 @@
   "author": "Evan Plaice <evanplaice@gmail.com> (https://evanplaice.com/)",
   "license": "MIT",
   "type": "module",
-  "exports": {
-    ".": "./src/index.js",
-    "./cp": "./src/cp.js",
-    "./rm": "./src/rm.js"
-  },
   "bin": {
     "esmtk": "bin/esmtk.js"
   },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./cp": {
+      "types": "./src/cp.d.ts",
+      "default": "./src/cp.js"
+    },
+    "./rm": {
+      "types": "./src/rm.d.ts",
+      "default": "./src/rm.js"
+    }
+  },
   "scripts": {
     "lint": "./bin/esmtk.js lint",
     "types": "./bin/esmtk.js types src/index.js",
+    "typings": "./bin/esmtk.js typings src/index.js",
     "preversion": "npm run lint && npm run types",
     "postversion": "git push --follow-tags"
   },
@@ -31,9 +41,6 @@
     "commander": "^14.0.3",
     "standard": "^17.1.2"
   },
-  "engines": {
-    "node": ">=17"
-  },
   "devDependencies": {
     "@types/node": "^25.3.5"
   }

package/src/cp.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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)
+ */
+export function copyAsync(source: 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)
+ */
+export function copyRecursiveAsync(source: string, target: string, force?: boolean): Promise<void>;

package/src/cp.js

@@ -1,5 +1,6 @@
+import { fileExists } from './index.js'
 import { basename, dirname } from 'node:path'
-import { access, constants, cp, stat } from 'node:fs/promises'
+import { cp, stat } from 'node:fs/promises'
 
 /**
  * Copy a single file asynchronously
@@ -86,12 +87,3 @@ export async function copyRecursiveAsync (source, target, force = false) {
     console.error(`cp": error ${err.message}`)
   }
 }
-
-async function fileExists (file) {
-  try {
-    await access(file, constants.F_OK)
-    return true
-  } catch (error) {
-    return false
-  }
-}

package/src/index.d.ts

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

package/src/index.js

@@ -1,2 +1,3 @@
 export { copyAsync, copyRecursiveAsync } from './cp.js'
 export { removeAsync, removeRecursiveAsync } from './rm.js'
+export { fileExists, installed, which } from './util.js'

package/src/rm.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Remove a file asynchronously
+ * @param {string} path The file to delete
+ * @param {boolean} force Ignore exceptions if the file doesn't exist (default false)
+ */
+export function removeAsync(path: string, force?: boolean): Promise<void>;
+/**
+ * Recursively remove a file|directory asynchronously
+ * @param {string} path The file|directory to remove
+ * @param {boolean} force Ignore exceptions if the file|directory doesn't exist (default false)
+ */
+export function removeRecursiveAsync(path: string, force?: boolean): Promise<void>;

package/src/rm.js

@@ -1,4 +1,5 @@
-import { access, constants, rm, stat } from 'node:fs/promises'
+import { fileExists } from './index.js'
+import { rm, stat } from 'node:fs/promises'
 
 /**
  * Remove a file asynchronously
@@ -47,12 +48,3 @@ export async function removeRecursiveAsync (path, force = false) {
     console.error(`rm": error ${err.message}`)
   }
 }
-
-async function fileExists (file) {
-  try {
-    await access(file, constants.F_OK)
-    return true
-  } catch (error) {
-    return false
-  }
-}

package/src/util.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Check if a file/folder exists
+ * @param {string} path the path to the file/folder
+ * @returns {Promise<boolean>} trie if the file/folder exists, false otherwise
+ */
+export function fileExists(path: string): Promise<boolean>;
+/**
+ * Check to see if a NPM package is installed globally
+ * @param {string} pkg the name of the package
+ * @returns {Promise<boolean>} true if the package is installed, false otherwise
+ */
+export function installed(pkg: string): Promise<boolean>;
+/**
+ * Check to see if an application is installed globally
+ * @param {string} program the name of the application
+ * @returns {Promise<boolean>} true if the application is installed, false otherwise
+ */
+export function which(program: string): Promise<boolean>;

package/src/util.js

@@ -1,12 +1,27 @@
 import { exec } from 'child_process'
+import { access, constants } from 'node:fs/promises'
 import { promisify } from 'node:util'
 
 const execAsync = promisify(exec)
 
+/**
+ * Check if a file/folder exists
+ * @param {string} path the path to the file/folder
+ * @returns {Promise<boolean>} trie if the file/folder exists, false otherwise
+ */
+export async function fileExists (path) {
+  try {
+    await access(path, constants.F_OK)
+    return true
+  } catch (error) {
+    return false
+  }
+}
+
 /**
  * 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
+ * @returns {Promise<boolean>} true if the package is installed, false otherwise
  */
 export async function installed (pkg) {
   try {
@@ -20,7 +35,7 @@ export async function installed (pkg) {
 /**
  * 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
+ * @returns {Promise<boolean>} true if the application is installed, false otherwise
  */
 export async function which (program) {
   try {