@kaynooo/cli-kit 0.17.0 → 0.19.0

package/README.md

@@ -56,7 +56,7 @@ On a terminal, help has bold `Usage:`, `Commands:` and `Options:` headers, comma
 - `--help` lists the commands under `Commands:`, then a heading per `group` a command names (`{ summary, group: 'Admin', run }`), then the level's `Options:` and the `Examples:` the CLI or a group's `examples` give (`['ft ci', ['ft ci HEAD~1', 'the commit before']]`, a note shown dimmed after `#`); a command's own examples go to `parse(args, usage, options, { examples })`, shown under its options.
 - `replaces` on the CLI or in `parse`'s settings (`'sed -n N,Mp, grep -n chains'`) adds an `Instead of:` line under the usage. With `KIT_HELP=json` in the environment, `--help` prints `{synopsis, summary, replaces?, examples}` instead, the usage's first line split at its first `: `, which is how `cli list` reads every bin.
 - `runHint(command, effect?)` words the hint of a refusal that a command resolves, ``run `ft take 12 --take-stale` to take it over``, so every CLI writes it alike: `fail(message, 1, runHint('ft take 12 --take-stale', 'take it over'))`. `printHint(hint)` prints the `hint:` line under a refusal a command prints itself (one issue of several refused).
-- `limitOptions(fallback)` is the `--limit <n>` and `--full` flags of a listing, `limitOf(values, fallback)` the row count they ask for (Infinity with `--full`; with `json: true` in the values, Infinity unless `--limit` is given, so JSON is never cut on its own), and `capped(rows, limit)` the first rows plus the footer `N more, rerun with --full` when some are left out.
+- `limitOptions(fallback)` is the `--limit <n>` (`-n`) and `--full` flags of a listing, `limitOf(values, fallback)` the row count they ask for (Infinity with `--full`; with `json: true` in the values, Infinity unless `--limit` is given, so JSON is never cut on its own), and `capped(rows, limit)` the first rows plus the footer `N more, rerun with --full` when some are left out.
 - `jsonOption(holds?)` is the `--json` flag, worded `print JSON` or `print JSON: <holds>` alike in every CLI, and `printJson(value)` prints the value indented on stdout, bare, with no envelope. Under `--json` runMain and runCli print a thrown error as `{"error", "hint"?, "cause"?}` on stderr instead of the `error:` line, its exit code unchanged; `printJsonError(message, hint?, cause?)` prints one for a command reporting a failure itself.
 - `stripAnsi(text)` removes colour and cursor codes, and `distance(a, b)` is the edit distance between two names.
 - `table(rows, { cellWidth, header })` also flattens each cell's line breaks and cuts it to `cellWidth`, and with `header` prints the first row bold on a terminal; and `formatDuration(ms)` formats milliseconds like `formatSeconds` but with one decimal under a minute (`0.3s`).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kaynooo/cli-kit",
   "type": "module",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "description": "What every @kaynooo CLI shares: argument parsing with --help, a command dispatcher with typo hints and shell completion, and output formatting.",
   "author": "Kaynooo <contact@kaynooo.fr>",
   "license": "MIT",

package/src/cli.ts

@@ -395,8 +395,16 @@ async function candidates(scope: Scope, defaultCommand: string | undefined, word
     command = commands[aliases?.[word] ?? word]
   }
 
-  if (listing)
-    return Promise.all(Object.entries(shown(commands)).map(async ([name, { summary }]) => `${name}\t${await resolveSummary(summary)}`))
+  if (listing) {
+    const own = await Promise.all(Object.entries(shown(commands)).map(async ([name, { summary }]) => `${name}\t${await resolveSummary(summary)}`))
+    const fallback = defaultCommand === undefined ? undefined : commands[defaultCommand]
+    // What the default command takes as its first positional is typed here too, `athome <project>`; a name a command already has is left out.
+    const values = fallback !== undefined && 'run' in fallback ? await leafCandidates(fallback.run, [word]) : []
+
+    const valueOf = (line: string) => line.slice(0, line.includes('\t') ? line.indexOf('\t') : undefined)
+
+    return [...own, ...values.filter(line => line !== FILES && !(valueOf(line) in commands))]
+  }
 
   if (command === undefined) {
     const fallback = defaultCommand === undefined ? undefined : commands[defaultCommand]

package/src/limit.ts

@@ -3,7 +3,7 @@ import { badUsage, wholeNumber } from './args'
 // The `--limit` and `--full` flags every listing words alike, `fallback` being the rows shown without either.
 export function limitOptions(fallback: number) {
   return {
-    limit: { type: 'string', description: `show at most this many rows, the rest counted (${fallback})` },
+    limit: { type: 'string', short: 'n', description: `show at most this many rows, the rest counted (${fallback})` },
     full: { type: 'boolean', description: 'show every row' },
   } as const
 }

package/src/shell.ts

@@ -162,6 +162,13 @@ export function splitCommand(command: string): Piece[] {
       continue
     }
 
+    // A backquoted body is read whole, as its own separators split nothing of the command around it.
+    if (char === '`') {
+      i = closingBackquote(command, i)
+
+      continue
+    }
+
     if (char === '#' && startsComment(command, i)) {
       const newline = command.indexOf('\n', i)
       const end = newline === -1 ? command.length : newline