@seamapi/cli 0.12.0 → 0.13.0

package/README.md

@@ -202,17 +202,28 @@ seam completion zsh > "${fpath[1]}/_seam"
 ```
 
 System packages install completion loaders instead: small scripts packaged
-under `completions/` in the published package and attached to each
-[GitHub release]. A loader runs `seam completion` the first time the shell
-completes a seam command, so installed completions always match the CLI's
-current Seam API definitions and never go stale between package updates. The
-`seam-bin` AUR package installs the loaders for all three shells.
+under `completions/` in the published package, and released as
+`seam-completions-v<version>.tar.gz` on each [GitHub release]. A loader runs
+`seam completion` the first time the shell completes a seam command, so
+installed completions always match the CLI's current Seam API definitions and
+never go stale between package updates. The `seam-bin` AUR package installs
+the loaders for all three shells.
 
 Completions are generated from the cached Seam API definitions, so they may
 briefly lag a newly released API. Pass `--update` to refresh the cache first,
 e.g., `seam completion bash --update`. They do not reflect definitions served
 by another Seam API server when `seam config use-remote-api-defs` is enabled.
 
+If completions do not appear after installing them system wide:
+
+- Bash reads them via the [bash-completion] package,
+  so it must be installed and sourced by the shell.
+- Zsh caches the completion functions it found at startup: after installing,
+  rebuild the cache with `rm -f ~/.zcompdump*` and start a new shell.
+  This applies to frameworks that call `compinit -C`, e.g., oh-my-zsh.
+- Fish needs nothing extra: completions load on demand in new sessions.
+
+[bash-completion]: https://github.com/scop/bash-completion
 [GitHub release]: https://github.com/seamapi/cli/releases/latest
 
 ## Development and Testing

package/completions/seam.bash

@@ -7,5 +7,10 @@
 # Install to /usr/share/bash-completion/completions/seam
 
 if command -v seam > /dev/null 2>&1; then
-  eval "$(seam completion bash 2> /dev/null)"
+  __seam_completion_script="$(seam completion bash 2> /dev/null)"
+  # Evaluate only a completion script, never anything else the CLI printed.
+  case "$__seam_completion_script" in
+    '# bash completion for the seam command.'*) eval "$__seam_completion_script" ;;
+  esac
+  unset __seam_completion_script
 fi

package/completions/seam.fish

@@ -7,5 +7,9 @@
 # Install to /usr/share/fish/vendor_completions.d/seam.fish
 
 if command --query seam
-    seam completion fish 2> /dev/null | source
+    set -l __seam_completion_script (seam completion fish 2> /dev/null | string collect)
+    # Source only a completion script, never anything else the CLI printed.
+    if string match --quiet '# fish completion for the seam command.*' -- $__seam_completion_script
+        printf '%s\n' $__seam_completion_script | source
+    end
 end

package/completions/seam.zsh

@@ -7,7 +7,13 @@
 #
 # Install to a directory in fpath as _seam
 
-# The generated script ends by dispatching on funcstack, so evaluating it
-# while this autoloaded _seam runs both redefines _seam and completes the
-# in-flight request.
-eval "$(seam completion zsh 2> /dev/null)"
+local __seam_completion_script
+__seam_completion_script="$(seam completion zsh 2> /dev/null)"
+
+# Evaluate only a completion script, never anything else the CLI printed.
+# The script ends by dispatching on funcstack, so evaluating it while this
+# autoloaded _seam runs both redefines _seam and completes the in-flight
+# request.
+if [[ "$__seam_completion_script" == '#compdef seam'* ]]; then
+  eval "$__seam_completion_script"
+fi

package/lib/completion/index.d.ts

@@ -15,6 +15,14 @@ export declare const renderCompletion: (shell: CompletionShell, blueprint: Bluep
  * at first completion, never at shell startup.
  *
  * The loader degrades to no completions when the seam command is missing or
- * cannot produce a script, e.g., offline before the definitions are cached.
+ * does not produce a completion script: a script is only evaluated when it
+ * starts with the exact first line 'seam completion' generates, so nothing
+ * else the CLI may print, e.g., 'Not logged in' from a version without the
+ * completion command, is ever evaluated as shell code.
  */
 export declare const renderCompletionStub: (shell: CompletionShell) => string;
+/**
+ * First line of each generated completion script, which the loaders require
+ * before evaluating one. Must match the output of {@link renderCompletion}.
+ */
+export declare const completionScriptSentinels: Record<CompletionShell, string>;

package/lib/completion/index.js

@@ -26,9 +26,21 @@ export const renderCompletion = (shell, blueprint) => renderers[shell](getComman
  * at first completion, never at shell startup.
  *
  * The loader degrades to no completions when the seam command is missing or
- * cannot produce a script, e.g., offline before the definitions are cached.
+ * does not produce a completion script: a script is only evaluated when it
+ * starts with the exact first line 'seam completion' generates, so nothing
+ * else the CLI may print, e.g., 'Not logged in' from a version without the
+ * completion command, is ever evaluated as shell code.
  */
 export const renderCompletionStub = (shell) => stubs[shell];
+/**
+ * First line of each generated completion script, which the loaders require
+ * before evaluating one. Must match the output of {@link renderCompletion}.
+ */
+export const completionScriptSentinels = {
+    bash: '# bash completion for the seam command.',
+    fish: '# fish completion for the seam command.',
+    zsh: '#compdef seam',
+};
 const stubHeader = (shell) => `# ${shell} completion loader for the seam command.
 #
 # Generated by @seamapi/cli. Loads completions from the CLI on first use, so
@@ -40,7 +52,12 @@ const stubs = {
 # Install to /usr/share/bash-completion/completions/seam
 
 if command -v seam > /dev/null 2>&1; then
-  eval "$(seam completion bash 2> /dev/null)"
+  __seam_completion_script="$(seam completion bash 2> /dev/null)"
+  # Evaluate only a completion script, never anything else the CLI printed.
+  case "$__seam_completion_script" in
+    '${completionScriptSentinels.bash}'*) eval "$__seam_completion_script" ;;
+  esac
+  unset __seam_completion_script
 fi
 `,
     fish: `${stubHeader('fish')}
@@ -48,7 +65,11 @@ fi
 # Install to /usr/share/fish/vendor_completions.d/seam.fish
 
 if command --query seam
-    seam completion fish 2> /dev/null | source
+    set -l __seam_completion_script (seam completion fish 2> /dev/null | string collect)
+    # Source only a completion script, never anything else the CLI printed.
+    if string match --quiet '${completionScriptSentinels.fish}*' -- $__seam_completion_script
+        printf '%s\\n' $__seam_completion_script | source
+    end
 end
 `,
     zsh: `#compdef seam
@@ -56,10 +77,16 @@ ${stubHeader('zsh')}
 #
 # Install to a directory in fpath as _seam
 
-# The generated script ends by dispatching on funcstack, so evaluating it
-# while this autoloaded _seam runs both redefines _seam and completes the
-# in-flight request.
-eval "$(seam completion zsh 2> /dev/null)"
+local __seam_completion_script
+__seam_completion_script="$(seam completion zsh 2> /dev/null)"
+
+# Evaluate only a completion script, never anything else the CLI printed.
+# The script ends by dispatching on funcstack, so evaluating it while this
+# autoloaded _seam runs both redefines _seam and completes the in-flight
+# request.
+if [[ "$__seam_completion_script" == '${completionScriptSentinels.zsh}'* ]]; then
+  eval "$__seam_completion_script"
+fi
 `,
 };
 //# sourceMappingURL=index.js.map

package/lib/completion/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/completion/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACrE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAErD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAU,CAAA;AAIhE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA4B,EAAE,CAC5E,gBAAgB,CAAC,QAAQ,CAAC,KAAwB,CAAC,CAAA;AAErD,oEAAoE;AACpE,MAAM,CAAC,MAAM,mBAAmB,GAAoC;IAClE,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,GAAG,EAAE,UAAU;CAChB,CAAA;AAED,MAAM,SAAS,GAA2D;IACxE,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB;IAC1B,GAAG,EAAE,mBAAmB;CACzB,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,KAAsB,EACtB,SAAoB,EACZ,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAA;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAsB,EAAU,EAAE,CACrE,KAAK,CAAC,KAAK,CAAC,CAAA;AAEd,MAAM,UAAU,GAAG,CAAC,KAAsB,EAAU,EAAE,CACpD,KAAK,KAAK;;;;uEAI2D,KAAK,IAAI,CAAA;AAEhF,MAAM,KAAK,GAAoC;IAC7C,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC;;;;;;;CAO5B;IACC,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC;;;;;;;CAO5B;IACC,GAAG,EAAE;EACL,UAAU,CAAC,KAAK,CAAC;;;;;;;;CAQlB;CACA,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/completion/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACrE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAErD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAU,CAAA;AAIhE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA4B,EAAE,CAC5E,gBAAgB,CAAC,QAAQ,CAAC,KAAwB,CAAC,CAAA;AAErD,oEAAoE;AACpE,MAAM,CAAC,MAAM,mBAAmB,GAAoC;IAClE,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,GAAG,EAAE,UAAU;CAChB,CAAA;AAED,MAAM,SAAS,GAA2D;IACxE,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB;IAC1B,GAAG,EAAE,mBAAmB;CACzB,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,KAAsB,EACtB,SAAoB,EACZ,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAA;AAExD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAsB,EAAU,EAAE,CACrE,KAAK,CAAC,KAAK,CAAC,CAAA;AAEd;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAoC;IACxE,IAAI,EAAE,yCAAyC;IAC/C,IAAI,EAAE,yCAAyC;IAC/C,GAAG,EAAE,eAAe;CACrB,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,KAAsB,EAAU,EAAE,CACpD,KAAK,KAAK;;;;uEAI2D,KAAK,IAAI,CAAA;AAEhF,MAAM,KAAK,GAAoC;IAC7C,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC;;;;;;;;OAQtB,yBAAyB,CAAC,IAAI;;;;CAIpC;IACC,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC;;;;;;;+BAOE,yBAAyB,CAAC,IAAI;;;;CAI5D;IACC,GAAG,EAAE;EACL,UAAU,CAAC,KAAK,CAAC;;;;;;;;;;;wCAWqB,yBAAyB,CAAC,GAAG;;;CAGpE;CACA,CAAA"}

package/lib/version.d.ts

@@ -1,4 +1,4 @@
-declare const seamapiCliVersion = "0.12.0";
+declare const seamapiCliVersion = "0.13.0";
 declare const seamapiBlueprintVersion = "1.2.0";
 export { seamapiBlueprintVersion };
 export default seamapiCliVersion;

package/lib/version.js

@@ -1,5 +1,5 @@
 // Versions are replaced with generated values when the package is packed.
-const seamapiCliVersion = '0.12.0';
+const seamapiCliVersion = '0.13.0';
 const seamapiBlueprintVersion = '1.2.0';
 export { seamapiBlueprintVersion };
 export default seamapiCliVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/cli",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "A command line interface (CLI) for interacting with the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/completion/index.ts

@@ -40,11 +40,24 @@ export const renderCompletion = (
  * at first completion, never at shell startup.
  *
  * The loader degrades to no completions when the seam command is missing or
- * cannot produce a script, e.g., offline before the definitions are cached.
+ * does not produce a completion script: a script is only evaluated when it
+ * starts with the exact first line 'seam completion' generates, so nothing
+ * else the CLI may print, e.g., 'Not logged in' from a version without the
+ * completion command, is ever evaluated as shell code.
  */
 export const renderCompletionStub = (shell: CompletionShell): string =>
   stubs[shell]
 
+/**
+ * First line of each generated completion script, which the loaders require
+ * before evaluating one. Must match the output of {@link renderCompletion}.
+ */
+export const completionScriptSentinels: Record<CompletionShell, string> = {
+  bash: '# bash completion for the seam command.',
+  fish: '# fish completion for the seam command.',
+  zsh: '#compdef seam',
+}
+
 const stubHeader = (shell: CompletionShell): string =>
   `# ${shell} completion loader for the seam command.
 #
@@ -58,7 +71,12 @@ const stubs: Record<CompletionShell, string> = {
 # Install to /usr/share/bash-completion/completions/seam
 
 if command -v seam > /dev/null 2>&1; then
-  eval "$(seam completion bash 2> /dev/null)"
+  __seam_completion_script="$(seam completion bash 2> /dev/null)"
+  # Evaluate only a completion script, never anything else the CLI printed.
+  case "$__seam_completion_script" in
+    '${completionScriptSentinels.bash}'*) eval "$__seam_completion_script" ;;
+  esac
+  unset __seam_completion_script
 fi
 `,
   fish: `${stubHeader('fish')}
@@ -66,7 +84,11 @@ fi
 # Install to /usr/share/fish/vendor_completions.d/seam.fish
 
 if command --query seam
-    seam completion fish 2> /dev/null | source
+    set -l __seam_completion_script (seam completion fish 2> /dev/null | string collect)
+    # Source only a completion script, never anything else the CLI printed.
+    if string match --quiet '${completionScriptSentinels.fish}*' -- $__seam_completion_script
+        printf '%s\\n' $__seam_completion_script | source
+    end
 end
 `,
   zsh: `#compdef seam
@@ -74,9 +96,15 @@ ${stubHeader('zsh')}
 #
 # Install to a directory in fpath as _seam
 
-# The generated script ends by dispatching on funcstack, so evaluating it
-# while this autoloaded _seam runs both redefines _seam and completes the
-# in-flight request.
-eval "$(seam completion zsh 2> /dev/null)"
+local __seam_completion_script
+__seam_completion_script="$(seam completion zsh 2> /dev/null)"
+
+# Evaluate only a completion script, never anything else the CLI printed.
+# The script ends by dispatching on funcstack, so evaluating it while this
+# autoloaded _seam runs both redefines _seam and completes the in-flight
+# request.
+if [[ "$__seam_completion_script" == '${completionScriptSentinels.zsh}'* ]]; then
+  eval "$__seam_completion_script"
+fi
 `,
 }

package/src/lib/version.ts

@@ -1,5 +1,5 @@
 // Versions are replaced with generated values when the package is packed.
-const seamapiCliVersion = '0.12.0'
+const seamapiCliVersion = '0.13.0'
 const seamapiBlueprintVersion = '1.2.0'
 
 export { seamapiBlueprintVersion }