@jals1212/pi-spaces-cli 0.8.0 → 0.8.1

package/CHANGELOG.md

@@ -6,6 +6,17 @@ commands and options and a patch version fixes.
 
 ## Unreleased
 
+## 0.8.1
+
+### Changed
+
+- Completion lists the spaces first, in alphabetical order, then the
+  commands (also alphabetical), and keeps that order under fzf-tab: the
+  script sets `zstyle ':completion:*:pi-space:*' sort false`.
+- A space's description says what it is and which program opens it:
+  `base home of gentle (gentle-shell --)`, `space of gentle (gentle-shell --)`,
+  instead of `the home gentle starts with` and the bare command.
+
 ## 0.8.0
 
 ### Changed

package/README.md

@@ -203,7 +203,7 @@ It asks the command itself for the candidates each time, through the hidden `pi-
 
 | After | Candidates |
 | --- | --- |
-| `pi-space` (and the call options) | the commands, then `<profile>/base` and the spaces of every profile (`completion` is not offered, but works typed in full) |
+| `pi-space` (and the call options) | `<profile>/base` and the spaces of every profile, in alphabetical order, then the commands (`completion` is not offered, but works typed in full) |
 | `--config`, `--dir` | files (the shell's own completion) |
 | `remove`, `rename` | the spaces of every profile (never `base`) |
 | `setup` | the spaces, `--every` ("every profile") and `<profile>/--every` |
@@ -212,7 +212,7 @@ It asks the command itself for the candidates each time, through the hidden `pi-
 
 There is no `--profile` to complete: the profile is the first word of the space. In first place the call options not typed yet come too, and `--help` and `--version` when nothing comes before. After a command word the options come too: `--help` for every command, and `--yes` and `--no-backup` after `remove`. zsh shows them once the word starts with `-`, so `pi-space new <TAB>` never fills in a lone `--help`.
 
-The candidates come in groups, each with a description, and zsh lists each group apart: commands, spaces, targets (`--every`), shells and options. The hidden `pi-space __complete` prints one `<group>\t<value>\t<description>` line per candidate (or the single line `__files__` when the shell should complete a file), so a script for another shell can use it.
+The candidates come in groups, each with a description, and zsh lists each group apart: spaces, commands, targets (`--every`), shells and options. A space says what it is and which program opens it: `gentle/base -- base home of gentle (gentle-shell --)`, `gentle/work -- space of gentle (gentle-shell --)`. Spaces always come first, in alphabetical order, and the commands follow in alphabetical order: the script sets `zstyle ':completion:*:pi-space:*' sort false`, so neither zsh nor fzf-tab sorts them again into one list. The hidden `pi-space __complete` prints one `<group>\t<value>\t<description>` line per candidate (or the single line `__files__` when the shell should complete a file), so a script for another shell can use it.
 
 Completion also works through an abbreviation or alias: they expand first, so what the alias stands for is what completes. A config file that is wrong just gives no candidates; completion never prints an error.
 

package/dist/cli.js

@@ -751,14 +751,18 @@ const ZSH_COMPLETION = [
 	'      option) [[ "$PREFIX" == -* ]] && opts+=("$value:$text") ;;',
 	"    esac",
 	"  done",
+	// The spaces come first, as an unsorted group in pi-space's own (alphabetical) order; with the `sort false` style
+	// below, zsh and fzf-tab show every group in the order it is added here.
+	"  (( $#spaces )) && _describe -t spaces 'space' spaces -V pi-space-spaces && ret=0",
 	"  (( $#cmds )) && _describe -t commands 'command' cmds && ret=0",
-	"  (( $#spaces )) && _describe -t spaces 'space' spaces && ret=0",
 	"  (( $#targets )) && _describe -t targets 'target' targets && ret=0",
 	"  (( $#shells )) && _describe -t shells 'shell' shells && ret=0",
 	"  (( $#opts )) && _describe -t options 'option' opts && ret=0",
 	"  return ret",
 	"}",
 	"compdef _pi_space pi-space",
+	// pi-space already gives its candidates in order (spaces first, alphabetical); zsh and fzf-tab must not resort them.
+	"zstyle ':completion:*:pi-space:*' sort false",
 	"",
 ].join("\n");
 
@@ -785,10 +789,11 @@ function complete(words          , io       )       {
 	return io.exit(0);
 }
 
-/** The commands with their summary; in first place `completion` is left out (it still works typed in full), after --help it is not. */
+/** The commands with their summary, in alphabetical order; 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]) => withCompletion || name !== "completion")
+		.sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))
 		.map(([name, help]) => candidate("command", name, help.summary));
 }
 
@@ -811,10 +816,13 @@ function firstOptions(call             , alone         )           {
 
 /** `<profile>/base`, if asked, then `<profile>/<name>`, for each profile in order. */
 function spaceCandidates(profiles                     , withBase         )           {
-	return profiles.flatMap((profile) => [
-		...(withBase ? [candidate("space", `${profile.name}/${BASE}`, `the home ${profile.name} starts with`)] : []),
-		...profile.spaces.map((name) => candidate("space", `${profile.name}/${name}`, profile.command)),
+	const spaces = profiles.flatMap((profile) => [
+		...(withBase ? [{ value: `${profile.name}/${BASE}`, text: `base home of ${profile.name} (${profile.command})` }] : []),
+		...profile.spaces.map((name) => ({ value: `${profile.name}/${name}`, text: `space of ${profile.name} (${profile.command})` })),
 	]);
+	// Alphabetical by the whole name, whatever the order of the profiles in the file.
+	spaces.sort((a, b) => (a.value < b.value ? -1 : a.value > b.value ? 1 : 0));
+	return spaces.map(({ value, text }) => candidate("space", value, text));
 }
 
 /** The `--every` targets: one for every profile, then one `<profile>/--every` for each. */
@@ -862,7 +870,7 @@ function candidates(words          , io       )           {
 		return { name, command: profile.command ?? "pi", spaces: listSpaces(dirOverride ?? profile.dir) };
 	});
 	const rest = words.slice(index);
-	if (rest.length === 0) return [...commandCandidates(false), ...spaceCandidates(profiles, true), ...firstOptions(call, index === 0)];
+	if (rest.length === 0) return [...spaceCandidates(profiles, true), ...commandCandidates(false), ...firstOptions(call, index === 0)];
 	if (rest.length > 1) return [];
 	if (isHelpFlag(rest[0])) return commandCandidates(true);
 	if (!Object.hasOwn(COMMANDS, rest[0])) return [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jals1212/pi-spaces-cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "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",