@jals1212/pi-spaces-cli 0.6.1 → 0.6.2

package/CHANGELOG.md

@@ -6,6 +6,17 @@ commands and options and a patch version fixes.
 
 ## Unreleased
 
+## 0.6.2
+
+### Fixed
+
+- `pi-space --help <TAB>` (and `-h`) offers the commands with their summary,
+  `completion` included, so the help of a command is one Tab away.
+- `--every` is completed in its own `target` group instead of among the space
+  names, since it is not a space.
+- The completion text of the first `--help` says it also takes a command:
+  `print the help, or a command's: --help <command>`.
+
 ## 0.6.1
 
 ### Added

package/dist/cli.js

@@ -239,8 +239,15 @@ const COMMANDS                              = {
 	},
 };
 
+/** --help after a command; GENERAL_OPTIONS has the --help that comes first. */
 const HELP_OPTION = { flag: "--help", alias: "-h", text: "the help of this command" };
 
+/** The options that stand alone in first place, as completion describes them. */
+const GENERAL_OPTIONS                                 = [
+	["--help", "print the help, or a command's: --help <command>"],
+	["--version", "print the version"],
+];
+
 /** The help of one command: usage, what it does, arguments, options, the call options that apply, and examples. */
 function commandHelp(name        )         {
 	const help = COMMANDS[name];
@@ -284,7 +291,7 @@ export function parseCli(args          )             {
 function parseCommand(args          )             {
 	const [first, ...rest] = args;
 	if (first === undefined) return { kind: "picker" };
-	if (isHelpFlag(first)) return rest.length === 0 ? { kind: "help" } : rest.length === 1 ? { kind: "command-help", command: rest[0] } : { kind: "usage" };
+	if (isHelpFlag(first)) return parseHelp(rest);
 	if (first === "--version" || first === "-v") return { kind: "version" };
 	if (Object.hasOwn(REPLACED, first)) return { kind: "replaced", option: first, instead: REPLACED[first                         ] };
 	if (first.startsWith("-")) return { kind: "unknown-option", option: first };
@@ -308,6 +315,13 @@ function parseCommand(args          )             {
 	return { kind: "launch", name: first, args: rest };
 }
 
+/** `--help` alone is the general help; `--help <command>` is that command's. */
+function parseHelp(rest          )             {
+	if (rest.length === 0) return { kind: "help" };
+	if (rest.length === 1) return { kind: "command-help", command: rest[0] };
+	return { kind: "usage" };
+}
+
 /** `setup <name>` or `setup --every`: exactly one argument. */
 function parseSetup(rest          )             {
 	if (rest.length !== 1) return { kind: "usage" };
@@ -627,7 +641,7 @@ const ZSH_COMPLETION = [
 	"#compdef pi-space",
 	"# zsh completion for pi-space. Load it from .zshrc with: source <(pi-space completion zsh)",
 	"_pi_space() {",
-	"  local -a lines cmds spaces profiles shells opts",
+	"  local -a lines cmds spaces targets profiles shells opts",
 	"  local line group value text ret=1",
 	'  lines=("${(@f)$(command "${words[1]}" __complete "${(@)words[2,CURRENT-1]}" 2>/dev/null)}")',
 	`  if [[ "\${lines[1]}" == ${FILES} ]]; then`,
@@ -645,6 +659,7 @@ const ZSH_COMPLETION = [
 	'    case "$group" in',
 	'      command) cmds+=("$value:$text") ;;',
 	'      space) spaces+=("$value:$text") ;;',
+	'      target) targets+=("$value:$text") ;;',
 	'      profile) profiles+=("$value:$text") ;;',
 	'      shell) shells+=("$value:$text") ;;',
 	'      option) [[ "$PREFIX" == -* ]] && opts+=("$value:$text") ;;',
@@ -652,6 +667,7 @@ const ZSH_COMPLETION = [
 	"  done",
 	"  (( $#cmds )) && _describe -t commands 'command' cmds && ret=0",
 	"  (( $#spaces )) && _describe -t spaces 'space' spaces && ret=0",
+	"  (( $#targets )) && _describe -t targets 'target' targets && ret=0",
 	"  (( $#profiles )) && _describe -t profiles 'profile' profiles && ret=0",
 	"  (( $#shells )) && _describe -t shells 'shell' shells && ret=0",
 	"  (( $#opts )) && _describe -t options 'option' opts && ret=0",
@@ -661,8 +677,8 @@ const ZSH_COMPLETION = [
 	"",
 ].join("\n");
 
-/** The groups of a `__complete` line. */
-                                                                  
+/** The groups of a `__complete` line; `target` is --every, which stands in for a space name. */
+                                                                             
 
 /** One `__complete` line; the description never holds a tab or a newline. */
 function candidate(group       , value        , text        )         {
@@ -684,10 +700,10 @@ function complete(words          , io       )       {
 	return io.exit(0);
 }
 
-/** The first-place commands: `completion` is left out (it still works typed in full). */
-function commandCandidates()           {
+/** The commands with their summary; in first place `completion` is left out (it still works typed in full), after --help it is not. */
+function commandCandidates(withCompletion         )           {
 	return Object.entries(COMMANDS)
-		.filter(([name]) => name !== "completion")
+		.filter(([name]) => withCompletion || name !== "completion")
 		.map(([name, help]) => candidate("command", name, help.summary));
 }
 
@@ -696,7 +712,7 @@ function firstOptions(call             , alone         )           {
 	const calls = Object.entries(CALL_OPTIONS)
 		.filter(([, key]) => call[key] === undefined)
 		.map(([flag, key]) => candidate("option", flag, CALL_HELP[key][1]));
-	const general = alone ? [candidate("option", "--help", "print the help"), candidate("option", "--version", "print the version")] : [];
+	const general = alone ? GENERAL_OPTIONS.map(([flag, text]) => candidate("option", flag, text)) : [];
 	return [...calls, ...general];
 }
 
@@ -707,7 +723,7 @@ function spaceCandidates(spaces          , withBase         )           {
 
 /** What follows a command word: its target, its own options and --help. */
 function commandArguments(command        , spaces          )           {
-	const every = (text        ) => candidate("space", "--every", text);
+	const every = (text        ) => candidate("target", "--every", text);
 	const options = [...COMMANDS[command].options, HELP_OPTION].map((option) => candidate("option", option.flag, option.text));
 	switch (command) {
 		case "remove":
@@ -740,8 +756,10 @@ function candidates(words          , io       )           {
 	const { dir } = resolveSettings(call, io);
 	const rest = words.slice(index);
 	const spaces = listSpaces(dir);
-	if (rest.length === 0) return [...commandCandidates(), ...spaceCandidates(spaces, true), ...firstOptions(call, index === 0)];
-	if (rest.length > 1 || !Object.hasOwn(COMMANDS, rest[0])) return [];
+	if (rest.length === 0) return [...commandCandidates(false), ...spaceCandidates(spaces, true), ...firstOptions(call, index === 0)];
+	if (rest.length > 1) return [];
+	if (isHelpFlag(rest[0])) return commandCandidates(true);
+	if (!Object.hasOwn(COMMANDS, rest[0])) return [];
 	return commandArguments(rest[0], spaces);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jals1212/pi-spaces-cli",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "The pi-space command: pick a space and start Pi in it. Companion to the Pi extension @jals1212/pi-spaces.",
   "license": "MIT",
   "author": "jals1212",