@vanillaes/esmtk 1.3.0 → 1.4.0

package/README.md

@@ -122,8 +122,14 @@ Type check the JSDoc typings (using Typescript)
 # type check the sources
 esmtk type index.js
 
+# type check the sources (with 'node' module resolution)
+esmtk type --module nodenext index.js
+
 # type check the sources (with 'strict mode' enabled)
 esmtk type --strict index.js
+
+# type check the sources (with '@types/node' typings included)
+esmtk type --types node index.js
 ```
 
 **Node: Due to Typescript limitations, inline JSDoc typings will be ignored if typings (ie `*.d.ts` files) exist.**
@@ -211,12 +217,20 @@ Generate Type Declarations (.d.ts) from JSDoc (using Typescript)
 `esmtk typings [entry]`
 
 - `[entry]` - the entry-point for the source
+- `--module [module]` - module resolution type (default `esnext`)
+- `--types [types]` - specify type package names to include (ex `node` for `@types/node`)
 
 ### Usage
 
 ```sh
 # generate .d.ts files for all linked source files
 esmtk typings index.js
+
+# generate .d.ts files for all linked source files (with 'node' module resolution)
+esmtk type --module nodenext index.js
+
+# generate .d.ts files for all linked source files (with '@types/node' typings included)
+esmtk type --types node index.js
 ```
 
 

package/bin/commands/typings.js

@@ -37,6 +37,10 @@ export async function typings (entry, options) {
   }
   args.push('--noEmitOnError')
   args.push('--skipLibCheck')
+  if (options?.types) {
+    args.push('--types')
+    args.push(options.types)
+  }
 
   spawn('tsc', args, {
     cwd: process.cwd(),

package/bin/esmtk.js

@@ -45,6 +45,7 @@ program.command('type <entry>')
 program.command('typings <entry>')
   .description('Generate typings from JSDoc using Typescript')
   .option('--module <module>', 'Module resolution type (default esnext)', 'esnext')
+  .option('--types <types>', 'specify type package names to include (ex `node` for `@types/node`)')
   .action((entry, options) => {
     typings(entry, options)
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -40,10 +40,10 @@
   "scripts": {
     "test": "./bin/esmtk.js test",
     "lint": "./bin/esmtk.js lint",
-    "type": "./bin/esmtk.js type src/index.js && ./bin/esmtk.js type bin/esmtk.js --module nodenext",
+    "type": "./bin/esmtk.js type --module nodenext src/index.js && ./bin/esmtk.js type bin/esmtk.js --module nodenext",
     "bundle": "./bin/esmtk.js bundle --platform=node src/index.js src/index.esm.js",
     "minify": "./bin/esmtk.js minify --platform=node src/index.js src/index.min.js",
-    "typings": "./bin/esmtk.js typings src/index.js",
+    "typings": "./bin/esmtk.js typings --module nodenext src/index.js",
     "clean": "./bin/esmtk.js clean --typings",
     "preview": "./bin/esmtk.js preview",
     "preversion": "npm run test && npm run lint && npm run type",