@vanillaes/esmtk 0.25.1 → 0.26.0

package/README.md

@@ -15,7 +15,7 @@ ESMTK, essential tools for ECMAScript module development
 - [init](#init) - Create a package.json file for ECMAScript module development
 - [test](#test) - Run tests (using Tape-ES)
 - [lint](#lint) - Lint the source code (using Lint-ES)
-- [types](#types) - Type check the JSDoc typings (using Typescript)
+- [type](#type) - Type check the JSDoc typings (using Typescript)
 - [bundle](#bundle) - Bundle the source code to an ECMAScript module (using ESBuild)
 - [minify](#minify) - Bundle and Minify the source code to an ECMAScript module (using ESBuild)
 - [commonjs](#commonjs) - Bundle the source code to a CommonJS module (using ESBuild)
@@ -101,13 +101,13 @@ esmtk --fix lint
 ```
 
 
-## Types
+## Type
 
 Type check the JSDoc typings (using Typescript)
 
 ### Arguments
 
-`esmtk types [...options] [entry]`
+`esmtk type [...options] [entry]`
 
 - `[entry]` - the entry-point for the source
 - `--strict` - enable 'strict mode' type checks
@@ -116,10 +116,10 @@ Type check the JSDoc typings (using Typescript)
 
 ```sh
 # type check the sources
-esmtk types index.js
+esmtk type index.js
 
 # type check the sources (with 'strict mode' enabled)
-esmtk types --strict index.js
+esmtk type --strict index.js
 ```
 
 **Node: Due to Typescript limitations, inline JSDoc typings will be ignored if typings (ie `*.d.ts` files) exist.**

package/bin/commands/index.js

@@ -8,5 +8,5 @@ export { minify } from './minify.js'
 export { preview } from './preview.js'
 export { rm } from './rm.js'
 export { test } from './test.js'
-export { types } from './types.js'
+export { type } from './type.js'
 export { typings } from './typings.js'

package/bin/commands/init.js

@@ -74,7 +74,7 @@ export async function init (options) {
     pkg.scripts = {}
     pkg.scripts.test = 'esmtk test'
     pkg.scripts.lint = 'esmtk lint'
-    pkg.scripts.types = `esmtk types ${entry}`
+    pkg.scripts.type = `esmtk type ${entry}`
     pkg.scripts.typings = `esmtk typings ${entry}`
     pkg.scripts.clean = 'esmtk clean --typings'
     pkg.scripts.preview = 'esmtk preview'

package/bin/commands/{types.js → type.js}

@@ -6,7 +6,7 @@ import { spawn } from 'child_process'
  * @param {string} entry the entry point
  * @param {object} options 'types' options
  */
-export async function types (entry, options) {
+export async function type (entry, options) {
   const npmExists = await which('npm')
   if (!npmExists) {
     console.error('npm not found')

package/bin/esmtk.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { bundle, clean, cp, commonjs, init, lint, minify, preview, rm, test, types, typings } from './commands/index.js'
+import { bundle, clean, cp, commonjs, init, lint, minify, preview, rm, test, type, typings } from './commands/index.js'
 import { Command } from 'commander'
 import { createRequire } from 'module'
 const require = createRequire(import.meta.url)
@@ -33,10 +33,10 @@ program.command('lint')
     lint(flags)
   })
 
-program.command('types <entry>')
+program.command('type <entry>')
   .description('Type check the JSDoc typings using Typescript')
   .action((entry, options) => {
-    types(entry, options)
+    type(entry, options)
   })
 
 program.command('typings <entry>')

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
     "esm",
     "esmodules",
+    "typescript",
     "cli",
     "developer-tools",
     "jsdoc",
@@ -39,13 +40,13 @@
   "scripts": {
     "test": "./bin/esmtk.js test",
     "lint": "./bin/esmtk.js lint",
-    "types": "./bin/esmtk.js types src/index.js && ./bin/esmtk.js types bin/commands/index.js",
+    "type": "./bin/esmtk.js type src/index.js && ./bin/esmtk.js type bin/commands/index.js",
     "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",
     "clean": "./bin/esmtk.js clean --typings",
     "preview": "./bin/esmtk.js preview",
-    "preversion": "npm run test && npm run lint && npm run types",
+    "preversion": "npm run test && npm run lint && npm run type",
     "postversion": "git push --follow-tags"
   },
   "engines": {