@vanillaes/esmtk 0.17.1 → 0.19.0

package/.vscode/launch.json

@@ -13,6 +13,18 @@
             "args": ["--version"],
             "console": "integratedTerminal",
         },
+        {
+            "name": "Init",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["init"],
+            "console": "integratedTerminal",
+        },
         {
             "name": "Lint",
             "type": "node",
@@ -408,6 +420,18 @@
             "cwd": "${workspaceFolder}",
             "args": ["clean", "--bundle", "--minify", "--typings"],
             "console": "integratedTerminal",
-        }
+        },
+        {
+            "name": "Clean --custom",
+            "type": "node",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/bin/esmtk.js",
+            "cwd": "${workspaceFolder}",
+            "args": ["clean", "--custom", "**/*.min.js"],
+            "console": "integratedTerminal",
+        },
     ]
 }

package/README.md

@@ -4,7 +4,8 @@ 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/@vanillaes/esmtk"><img src="https://badgen.net/npm/v/@vanillaes/esmtk" alt="NPM Releases"></a>
+  <a href="https://www.npmjs.com/package/@vanillaes/esmtk"><img src="https://badgen.net/npm/v/@vanillaes/esmtk?icon=npm" alt="NPM Version"></a>
+  <a href="https://www.npmjs.com/package/@vanillaes/esmtk"><img src="https://badgen.net/npm/dm/@vanillaes/esmtk?icon=npm" alt="NPM Downloads"></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>
@@ -148,9 +149,10 @@ Clean up build artifacts
 `esmtk clean [root]`
 
 - `[root]` - the root directory to perform the cleanup (default: `process.cwd()`)
-- `--bundle` - Clean bundled build artifacts (default: `*.esm.js`)
-- `--minify` - Clean minified build artifacts (default: `*.min.js`)
-- `--typings` - Clean typing artifacts (default: `*.d.ts`)
+- `--bundle` - Clean bundled build artifacts (default: `**/*.esm.js`)
+- `--minify` - Clean minified build artifacts (default: `**/*.min.js`)
+- `--typings` - Clean typing artifacts (default: `**/*.d.ts`)
+- `--custom` - Clean based on a user-defined pattern
 
 ### Usage
 
@@ -160,6 +162,9 @@ esmtk clean --bundle --minify --typings
 
 # override default extension
 esmtk clean --bundle *.mjs
+
+# define your own pattern
+esmtk clean --custom *.scss.css
 ```
 
 **Node: The `clean` command automatically ignores the contents of `node_modules/`**

package/bin/commands/clean.js

@@ -24,6 +24,10 @@ export async function clean (root, options) {
   if (options?.typings) {
     await cleanOne(root, options.typings, options)
   }
+
+  if (options?.custom) {
+    await cleanOne(root, options.custom, options)
+  }
 }
 
 async function cleanOne (root, glob, options) {

package/bin/commands/cp.js

@@ -3,7 +3,6 @@ import { expand } from '../../src/index.js'
 
 /**
  * POSIX cp Implemented in Node
- *
  * @param {string[]} paths Variadic of source/destination paths
  * @param {any} options 'cp' options
  */

package/bin/commands/index.js

@@ -2,6 +2,7 @@ export { bundle } from './bundle.js'
 export { clean } from './clean.js'
 export { commonjs } from './commonjs.js'
 export { cp } from './cp.js'
+export { init } from './init.js'
 export { lint } from './lint.js'
 export { minify } from './minify.js'
 export { rm } from './rm.js'

package/bin/commands/init.js

@@ -0,0 +1,133 @@
+import { fileExists, which } from '../../src/index.js'
+import { exec } from 'node:child_process'
+import { readFile, writeFile } from 'node:fs/promises'
+import { basename, join, sep } from 'node:path'
+import { stdin, stdout } from 'node:process'
+import { createInterface } from 'node:readline/promises'
+import { promisify } from 'node:util'
+
+const execAsync = promisify(exec)
+
+/**
+ * Create a package.json file for ECMAScript Development
+ */
+export async function init () {
+  const npmExists = await which('npm')
+  if (!npmExists) {
+    console.error('npm not found')
+    console.error('is node installed?')
+    process.exit(1)
+  }
+
+  const gitExists = await which('git')
+  if (!gitExists) {
+    console.error('git not found')
+    console.error('is git installed?')
+    process.exit(1)
+  }
+
+  // defaults
+  const DIR = process.cwd()
+  const DIRNAME = basename(process.cwd())
+  const REPOSITORY = await getGitRepository()
+  const USERNAME = gitExists ? await fetchGitUser() : ''
+  const EMAIL = gitExists ? await fetchGitEmail() : ''
+
+  const program = createInterface({ input: stdin, output: stdout })
+
+  console.log('This utility will walk you through creating a package.json file.')
+  console.log('It only covers the most common items, and tries to guess sensible defaults.')
+  console.log()
+  console.log('Press ^C at any time to quit.')
+  console.log()
+
+  const pkg = {}
+  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')
+  if (keywords) {
+    keywords = keywords.split(' ')
+    pkg.keywords = keywords
+  }
+  pkg.repository = await ask(program, 'git repository', REPOSITORY)
+  const user = await ask(program, 'author', USERNAME)
+  if (user !== '') {
+    pkg.author = user
+    const email = await ask(program, 'email', EMAIL)
+    if (email !== '') {
+      pkg.author += ` <${EMAIL}>`
+    }
+    const website = await ask(program, 'website')
+    if (website) {
+      pkg.author += ` (${website})`
+    }
+  }
+  pkg.license = await ask(program, 'license', 'ISC')
+  pkg.type = 'module'
+  const entry = await ask(program, 'entry point', 'index.js')
+  if (entry) {
+    pkg.exports = {}
+    pkg.exports['.'] = 'entry'
+  }
+  const scripts = await ask(program, 'include ESMTK scripts?', 'yes')
+  if (scripts.toLowerCase() === 'yes') {
+    pkg.scripts = {}
+    pkg.scripts.test = 'esmtk test'
+    pkg.scripts.lint = 'esmtk lint'
+    pkg.scripts.types = `esmtk types ${entry}`
+  } else {
+    pkg.scripts = {}
+    pkg.scripts.test = await ask(program, 'test command')
+  }
+  const pkgString = JSON.stringify(pkg, null, 2)
+  console.log(`About to write to ${DIR}${sep}package.json:`)
+  console.log(pkgString)
+
+  const ok = await ask(program, 'is this OK', 'yes')
+  if (ok.toLowerCase() === 'yes') {
+    await writeFile('package.test.json', pkgString)
+  } else {
+    console.log('Aborted.')
+  }
+  program.close()
+}
+
+async function ask (program, prompt, defaultValue) {
+  const suffix = defaultValue ? `(${defaultValue}) ` : ''
+  const answer = await program.question(`${prompt}: ${suffix}`)
+  return answer || defaultValue
+}
+
+async function fetchGitUser () {
+  const { stdout, stderr } = await execAsync('git config --get user.name')
+  if (stderr) {
+    console.error(`exec error: ${stderr}`)
+    process.exit(1)
+  }
+  console.log(`${stdout}`.trim())
+  return `${stdout}`.trim()
+}
+
+async function fetchGitEmail () {
+  const { stdout, stderr } = await execAsync('git config --get user.email')
+  if (stderr) {
+    console.error(`exec error: ${stderr}`)
+    process.exit(1)
+  }
+  console.log(`${stdout}`.trim())
+  return `${stdout}`.trim()
+}
+
+async function getGitRepository () {
+  const config = join(process.cwd(), '.git', 'config')
+  const exists = await fileExists(config)
+  if (!exists) {
+    return
+  }
+  const contents = await readFile(config, 'utf-8')
+  const match = contents.match(/^\turl\s=\shttps:\/\/.*$/gm)
+  if (match) {
+    return match[0].replace('\turl = ', '')
+  }
+}

package/bin/esmtk.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { bundle, clean, cp, commonjs, lint, minify, rm, types, typings } from './commands/index.js'
+import { bundle, clean, cp, commonjs, init, lint, minify, rm, types, typings } from './commands/index.js'
 import { Command } from 'commander'
 import { createRequire } from 'module'
 const program = new Command()
@@ -8,6 +8,12 @@ const pkg = require('../package.json')
 
 program.version(pkg.version, '-v, --version')
 
+program.command('init')
+  .description('Create a package.json file for ECMAScript module development')
+  .action(() => {
+    init()
+  })
+
 program.command('lint')
   .description('Lint the source using StandardJS')
   .option('--fix', 'Automatically fix problems')
@@ -54,9 +60,10 @@ program.command('minify <input> <output>')
 program.command('clean')
   .description('Clean build artificts')
   .argument('[root]', 'The root directory to perform operations from (default cwd)', process.cwd())
-  .option('--bundle [bundle]', 'Clean bundled build artifacts (default: *.esm.js)')
-  .option('--minify [minify]', 'Clean minified build artifacts (default: *.min.js)')
-  .option('--typings [typings]', 'Clean typing artifacts (default: *.d.ts)')
+  .option('--bundle [bundle]', 'Clean bundled build artifacts (default: **/*.esm.js)')
+  .option('--minify [minify]', 'Clean minified build artifacts (default: **/*.min.js)')
+  .option('--typings [typings]', 'Clean typing artifacts (default: **/*.d.ts)')
+  .option('--custom <custom>', 'Clean based on a user-defined pattern')
   // .option('-f, --force', 'Do not prompt before overwriting', false)
   .action((root, options) => {
     // set --bundle default
@@ -71,6 +78,7 @@ program.command('clean')
     if (options?.typings && typeof (options.typings) === 'boolean') {
       options.typings = '**/*.d.ts'
     }
+
     clean(root, options)
   })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanillaes/esmtk",
-  "version": "0.17.1",
+  "version": "0.19.0",
   "description": "ES Module Toolkit",
   "keywords": [
     "ecmascript",
@@ -42,7 +42,7 @@
     "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 --bundle --minify --typings",
+    "clean": "./bin/esmtk.js clean --typings",
     "preversion": "npm run lint && npm run types",
     "postversion": "git push --follow-tags"
   },