Use util.parseArgs() to handle argv

Author: jcoglan

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [12, 14, 16, 18, 20, 22, 24]
+        node: [16, 18, 20, 22, 24]
 
     name: node.js v${{ matrix.node }}
     runs-on: ubuntu-latest

bin/vault

@@ -42,7 +42,7 @@ let cli = new CLI({
 async function main () {
   try {
     await legacy.migrate(logger, pathname, key)
-    await cli.run(process.argv)
+    await cli.run(process.argv.slice(2))
     process.exit(0)
   } catch (error) {
     logger.error(error)

lib/cli/index.js

@@ -1,55 +1,65 @@
 'use strict'
 
-const fs        = require('fs')
-const path      = require('path')
+const fs = require('fs')
+const path = require('path')
+const { parseArgs } = require('util')
 
-const editor    = require('./editor')
-const escodb    = require('../escodb')
-const OptParser = require('./optparser')
-const Store     = require('../store')
-const util      = require('../util')
-const Vault     = require('../vault')
+const editor = require('./editor')
+const escodb = require('../escodb')
+const Store = require('../store')
+const util = require('../util')
+const Vault = require('../vault')
 
 const OPTIONS = {
-  'phrase':         Boolean,
-  'key':            Boolean,
-  'length':         Number,
-  'repeat':         Number,
-
-  'lower':          Number,
-  'upper':          Number,
-  'number':         Number,
-  'space':          Number,
-  'dash':           Number,
-  'symbol':         Number,
-  'notes':          Boolean,
-
-  'config':         Boolean,
-  'delete':         String,
-  'delete-globals': Boolean,
-  'clear':          Boolean,
-
-  'export':         String,
-  'import':         String,
-
-  'initpath':       Boolean,
-  'cmplt':          String,
-  'help':           Boolean
+  'phrase':         { type: Boolean,  short: 'p' },
+  'key':            { type: Boolean,  short: 'k' },
+  'length':         { type: Number,   short: 'l' },
+  'repeat':         { type: Number,   short: 'r' },
+
+  'lower':          { type: Number },
+  'upper':          { type: Number },
+  'number':         { type: Number },
+  'space':          { type: Number },
+  'dash':           { type: Number },
+  'symbol':         { type: Number },
+  'notes':          { type: Boolean,  short: 'n' },
+
+  'config':         { type: Boolean,  short: 'c' },
+  'delete':         { type: String,   short: 'x' },
+  'delete-globals': { type: Boolean,  short: 'G' },
+  'clear':          { type: Boolean,  short: 'X' },
+
+  'export':         { type: String,   short: 'e' },
+  'import':         { type: String,   short: 'i' },
+
+  'initpath':       { type: Boolean },
+  'cmplt':          { type: String },
+  'help':           { type: Boolean,  short: 'h' }
 }
 
-const SHORTS = {
-  'c': '--config',
-  'e': '--export',
-  'G': '--delete-globals',
-  'h': '--help',
-  'i': '--import',
-  'k': '--key',
-  'l': '--length',
-  'n': '--notes',
-  'p': '--phrase',
-  'r': '--repeat',
-  'x': '--delete',
-  'X': '--clear'
+function parseArgv (args) {
+  let options = Object.fromEntries(
+    Object.entries(OPTIONS).map(([key, { type, short }]) => {
+      let opt = short ? { short } : {}
+      opt.type = (type === Boolean) ? 'boolean' : 'string'
+      return [key, opt]
+    })
+  )
+
+  let { values, positionals } = parseArgs({
+    args,
+    options,
+    strict: true,
+    allowPositionals: true
+  })
+
+  for (let key in values) {
+    if (OPTIONS[key].type === Number) {
+      values[key] = parseInt(values[key], 10)
+    }
+  }
+
+  return { ...values, service: positionals[0] }
 }
 
 class CLI {
@@ -60,8 +70,6 @@ class CLI {
     let adapter = escodb.createFileAdapter(pathname)
     this._storeParams = { adapter, password: key }
 
-    this._parser = new OptParser(OPTIONS, SHORTS, ['service'])
-
     this._out = options.stdout
     this._err = options.stderr
     this._tty = options.tty
@@ -76,7 +84,8 @@ class CLI {
     let { adapter, password } = this._storeParams
     this._store = await Store.open(adapter, password)
 
-    let params = await this._parser.parse(argv)
+    let params = parseArgv(argv)
+
     await this.execute(params)
   }
 

lib/cli/optparser.js

@@ -3,7 +3,7 @@
 _vault_complete() {
   COMPREPLY=()
   local word="${COMP_WORDS[COMP_CWORD]}"
-  local completions="$(vault --cmplt "$word")"
+  local completions="$(vault --cmplt="$word")"
   COMPREPLY=( $(compgen -W "$completions" -- "$word") )
 }
 

lib/cli/scripts/completion.bash

@@ -7,7 +7,7 @@ fi
 _vault_complete() {
   local word completions
   word="$1"
-  completions="$(vault --cmplt "${word}")"
+  completions="$(vault --cmplt="${word}")"
   reply=( "${(ps:\n:)completions}" )
 }
 

lib/cli/scripts/completion.zsh

@@ -19,7 +19,6 @@
   "preferGlobal": true,
   "dependencies": {
     "@escodb/core": "github:escodb/core",
-    "posix-argv-parser": "~1.0.0",
     "prompt": "~1.3.0",
     "sequin": "~0.1.0",
     "ssh-agent": "~0.2.1"

package.json

@@ -16,7 +16,7 @@ describe('CLI completion', () => {
   })
 
   it('completes option names', async () => {
-    await helper.call('--cmplt', '--n')
+    await helper.call('--cmplt=--n')
     helper.assertStdout(['--notes', '--number'].join('\n'))
   })
 

test/cli/completion_test.js

@@ -52,7 +52,7 @@ class CliHelper {
   }
 
   call (...args) {
-    return this.cli.run(['', '', ...args])
+    return this.cli.run(args)
   }
 
   assertStdout (content) {