From 6d88687403bf39402c0b87501e9bb96211bc2c8d Mon Sep 17 00:00:00 2001
From: Gar <gar+gh@danger.computer>
Date: Tue, 28 Feb 2023 08:47:12 -0800
Subject: [PATCH 1/4] fix(cmd-list): alias only to real commands
---
lib/utils/cmd-list.js | 4 ++--
tap-snapshots/test/lib/docs.js.test.cjs | 8 ++++----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/lib/utils/cmd-list.js b/lib/utils/cmd-list.js
index 03fe8ed07c930..68074fe9a4286 100644
--- a/lib/utils/cmd-list.js
+++ b/lib/utils/cmd-list.js
@@ -36,7 +36,7 @@ const aliases = {
v: 'view',
run: 'run-script',
'clean-install': 'ci',
- 'clean-install-test': 'cit',
+ 'clean-install-test': 'install-ci-test',
x: 'exec',
why: 'explain',
la: 'll',
@@ -62,7 +62,7 @@ const aliases = {
upgrade: 'update',
udpate: 'update',
rum: 'run-script',
- sit: 'cit',
+ sit: 'install-ci-test',
urn: 'run-script',
ogr: 'org',
'add-user': 'adduser',
diff --git a/tap-snapshots/test/lib/docs.js.test.cjs b/tap-snapshots/test/lib/docs.js.test.cjs
index a07aab8dd9757..fe9830b1fba8c 100644
--- a/tap-snapshots/test/lib/docs.js.test.cjs
+++ b/tap-snapshots/test/lib/docs.js.test.cjs
@@ -384,7 +384,7 @@ Object {
"c": "config",
"cit": "install-ci-test",
"clean-install": "ci",
- "clean-install-test": "cit",
+ "clean-install-test": "install-ci-test",
"create": "init",
"ddp": "dedupe",
"dist-tags": "dist-tag",
@@ -421,7 +421,7 @@ Object {
"s": "search",
"se": "search",
"show": "view",
- "sit": "cit",
+ "sit": "install-ci-test",
"t": "test",
"tst": "test",
"udpate": "update",
@@ -3239,14 +3239,14 @@ Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces] [--include-workspace-root] [--install-links]
-alias: cit
+aliases: cit, clean-install-test, sit
Run "npm help install-ci-test" for more info
\`\`\`bash
npm install-ci-test
-alias: cit
+aliases: cit, clean-install-test, sit
\`\`\`
#### \`save\`
From fc1673eac1ac4380726bcab8604c96c89e881327 Mon Sep 17 00:00:00 2001
From: Gar <gar+gh@danger.computer>
Date: Tue, 28 Feb 2023 08:48:33 -0800
Subject: [PATCH 2/4] fix(access): only complete once
---
lib/commands/access.js | 30 ++++++++++++++++--------------
test/lib/commands/access.js | 1 +
2 files changed, 17 insertions(+), 14 deletions(-)
diff --git a/lib/commands/access.js b/lib/commands/access.js
index 23e51f071b112..c8ac83529e58d 100644
--- a/lib/commands/access.js
+++ b/lib/commands/access.js
@@ -53,20 +53,22 @@ class Access extends BaseCommand {
return commands
}
- switch (argv[2]) {
- case 'grant':
- return ['read-only', 'read-write']
- case 'revoke':
- return []
- case 'list':
- case 'ls':
- return ['packages', 'collaborators']
- case 'get':
- return ['status']
- case 'set':
- return setCommands
- default:
- throw new Error(argv[2] + ' not recognized')
+ if (argv.length === 3) {
+ switch (argv[2]) {
+ case 'grant':
+ return ['read-only', 'read-write']
+ case 'revoke':
+ return []
+ case 'list':
+ case 'ls':
+ return ['packages', 'collaborators']
+ case 'get':
+ return ['status']
+ case 'set':
+ return setCommands
+ default:
+ throw new Error(argv[2] + ' not recognized')
+ }
}
}
diff --git a/test/lib/commands/access.js b/test/lib/commands/access.js
index b0057545ba026..f0117098a5b55 100644
--- a/test/lib/commands/access.js
+++ b/test/lib/commands/access.js
@@ -30,6 +30,7 @@ t.test('completion', async t => {
])
testComp(['npm', 'access', 'grant'], ['read-only', 'read-write'])
testComp(['npm', 'access', 'revoke'], [])
+ testComp(['npm', 'access', 'grant', ''], [])
await t.rejects(
access.completion({ conf: { argv: { remain: ['npm', 'access', 'foobar'] } } }),
From 95d28272afe0278fb4e83207df2f18afad353eac Mon Sep 17 00:00:00 2001
From: Gar <gar+gh@danger.computer>
Date: Tue, 28 Feb 2023 08:48:51 -0800
Subject: [PATCH 3/4] fix(audit): add signatures to completion
---
lib/commands/audit.js | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/lib/commands/audit.js b/lib/commands/audit.js
index 05830fff69c2e..dab871669eba5 100644
--- a/lib/commands/audit.js
+++ b/lib/commands/audit.js
@@ -389,11 +389,12 @@ class Audit extends ArboristWorkspaceCmd {
const argv = opts.conf.argv.remain
if (argv.length === 2) {
- return ['fix']
+ return ['fix', 'signatures']
}
switch (argv[2]) {
case 'fix':
+ case 'signatures':
return []
default:
throw Object.assign(new Error(argv[2] + ' not recognized'), {
From 4501ad1f51d9d6c070b9cda7367ee4054d940079 Mon Sep 17 00:00:00 2001
From: Gar <gar+gh@danger.computer>
Date: Tue, 28 Feb 2023 08:49:20 -0800
Subject: [PATCH 4/4] feat: add preliminary fish shell completion
---
lib/commands/completion.js | 7 ++---
lib/commands/run-script.js | 3 ++
lib/utils/completion.fish | 40 ++++++++++++++++++++++++
scripts/fish-completion.js | 54 +++++++++++++++++++++++++++++++++
test/lib/commands/run-script.js | 11 +++++--
5 files changed, 109 insertions(+), 6 deletions(-)
create mode 100644 lib/utils/completion.fish
create mode 100644 scripts/fish-completion.js
diff --git a/lib/commands/completion.js b/lib/commands/completion.js
index f5604e099f9a2..49a66627cca2c 100644
--- a/lib/commands/completion.js
+++ b/lib/commands/completion.js
@@ -79,12 +79,10 @@ class Completion extends BaseCommand {
})
}
- const { COMP_CWORD, COMP_LINE, COMP_POINT } = process.env
+ const { COMP_CWORD, COMP_LINE, COMP_POINT, COMP_FISH } = process.env
// if the COMP_* isn't in the env, then just dump the script.
- if (COMP_CWORD === undefined ||
- COMP_LINE === undefined ||
- COMP_POINT === undefined) {
+ if (COMP_CWORD === undefined || COMP_LINE === undefined || COMP_POINT === undefined) {
return dumpScript(resolve(this.npm.npmRoot, 'lib', 'utils', 'completion.sh'))
}
@@ -111,6 +109,7 @@ class Completion extends BaseCommand {
partialWords.push(partialWord)
const opts = {
+ isFish: COMP_FISH === 'true',
words,
w,
word,
diff --git a/lib/commands/run-script.js b/lib/commands/run-script.js
index 51746c5e5285d..40e18e1ea0644 100644
--- a/lib/commands/run-script.js
+++ b/lib/commands/run-script.js
@@ -51,6 +51,9 @@ class RunScript extends BaseCommand {
// find the script name
const json = resolve(this.npm.localPrefix, 'package.json')
const { scripts = {} } = await rpj(json).catch(er => ({}))
+ if (opts.isFish) {
+ return Object.keys(scripts).map(s => `${s}\t${scripts[s].slice(0, 30)}`)
+ }
return Object.keys(scripts)
}
}
diff --git a/lib/utils/completion.fish b/lib/utils/completion.fish
new file mode 100644
index 0000000000000..5e274ad77e5fd
--- /dev/null
+++ b/lib/utils/completion.fish
@@ -0,0 +1,40 @@
+# npm completions for Fish shell
+# This script is a work in progress and does not fall under the normal semver contract as the rest of npm.
+
+# __fish_npm_needs_command taken from:
+# https://stackoverflow.com/questions/16657803/creating-autocomplete-script-with-sub-commands
+function __fish_npm_needs_command
+ set -l cmd (commandline -opc)
+
+ if test (count $cmd) -eq 1
+ return 0
+ end
+
+ return 1
+end
+
+# Taken from https://github.com/fish-shell/fish-shell/blob/HEAD/share/completions/npm.fish
+function __fish_complete_npm -d "Complete the commandline using npm's 'completion' tool"
+ # tell npm we are fish shell
+ set -lx COMP_FISH true
+ if command -sq npm
+ # npm completion is bash-centric, so we need to translate fish's "commandline" stuff to bash's $COMP_* stuff
+ # COMP_LINE is an array with the words in the commandline
+ set -lx COMP_LINE (commandline -opc)
+ # COMP_CWORD is the index of the current word in COMP_LINE
+ # bash starts arrays with 0, so subtract 1
+ set -lx COMP_CWORD (math (count $COMP_LINE) - 1)
+ # COMP_POINT is the index of point/cursor when the commandline is viewed as a string
+ set -lx COMP_POINT (commandline -C)
+ # If the cursor is after the last word, the empty token will disappear in the expansion
+ # Readd it
+ if test (commandline -ct) = ""
+ set COMP_CWORD (math $COMP_CWORD + 1)
+ set COMP_LINE $COMP_LINE ""
+ end
+ command npm completion -- $COMP_LINE 2>/dev/null
+ end
+end
+
+# flush out what ships with fish
+complete -e npm
diff --git a/scripts/fish-completion.js b/scripts/fish-completion.js
new file mode 100644
index 0000000000000..6357c1032fe56
--- /dev/null
+++ b/scripts/fish-completion.js
@@ -0,0 +1,54 @@
+/* eslint-disable no-console */
+const fs = require('fs/promises')
+const { resolve } = require('path')
+
+const { commands, aliases } = require('../lib/utils/cmd-list.js')
+const { definitions } = require('../lib/utils/config/index.js')
+
+async function main () {
+ const file = resolve(__dirname, '..', 'lib', 'utils', 'completion.fish')
+ console.log(await fs.readFile(file, 'utf-8'))
+ const cmds = {}
+ for (const cmd of commands) {
+ cmds[cmd] = { aliases: [cmd] }
+ const cmdClass = require(`../lib/commands/${cmd}.js`)
+ cmds[cmd].description = cmdClass.description
+ cmds[cmd].params = cmdClass.params
+ }
+ for (const alias in aliases) {
+ cmds[aliases[alias]].aliases.push(alias)
+ }
+ for (const cmd in cmds) {
+ console.log(`# ${cmd}`)
+ const { aliases: cmdAliases, description, params = [] } = cmds[cmd]
+ // If npm completion could return all commands in a fish friendly manner
+ // like we do w/ run-script these wouldn't be needed.
+ /* eslint-disable-next-line max-len */
+ console.log(`complete -x -c npm -n __fish_npm_needs_command -a '${cmdAliases.join(' ')}' -d '${description}'`)
+ const shorts = params.map(p => {
+ // Our multi-character short params (e.g. -ws) are not very standard and
+ // don't work with things that assume short params are only ever single
+ // characters.
+ if (definitions[p].short?.length === 1) {
+ return `-s ${definitions[p].short}`
+ }
+ }).filter(p => p).join(' ')
+ // The config descriptions are not appropriate for -d here. We may want to
+ // consider having a more terse description for these.
+ // We can also have a mechanism to auto-generate the long form of options
+ // that have predefined values.
+ // params completion
+ /* eslint-disable-next-line max-len */
+ console.log(`complete -x -c npm -n '__fish_seen_subcommand_from ${cmdAliases.join(' ')}' ${params.map(p => `-l ${p}`).join(' ')} ${shorts}`)
+ // builtin npm completion
+ /* eslint-disable-next-line max-len */
+ console.log(`complete -x -c npm -n '__fish_seen_subcommand_from ${cmdAliases.join(' ')}' -a '(__fish_complete_npm)'`)
+ }
+}
+
+main().then(() => {
+ return process.exit()
+}).catch(err => {
+ console.error(err)
+ process.exit(1)
+})
diff --git a/test/lib/commands/run-script.js b/test/lib/commands/run-script.js
index a265db3cc040d..6e2bf22adddcf 100644
--- a/test/lib/commands/run-script.js
+++ b/test/lib/commands/run-script.js
@@ -34,12 +34,12 @@ const mockRs = async (t, { windows = false, runScript, ...opts } = {}) => {
}
t.test('completion', async t => {
- const completion = async (t, remain, pkg) => {
+ const completion = async (t, remain, pkg, isFish = false) => {
const { npm } = await mockRs(t,
pkg ? { prefixDir: { 'package.json': JSON.stringify(pkg) } } : {}
)
const cmd = await npm.cmd('run-script')
- return cmd.completion({ conf: { argv: { remain } } })
+ return cmd.completion({ conf: { argv: { remain } }, isFish })
}
t.test('already have a script name', async t => {
@@ -60,6 +60,13 @@ t.test('completion', async t => {
})
t.strictSame(res, ['hello', 'world'])
})
+
+ t.test('fish shell', async t => {
+ const res = await completion(t, ['npm', 'run'], {
+ scripts: { hello: 'echo hello', world: 'echo world' },
+ }, true)
+ t.strictSame(res, ['hello\techo hello', 'world\techo world'])
+ })
})
t.test('fail if no package.json', async t => {