feat: integrate usage guide

src/commands/completion/index.ts

@@ -1,4 +1,7 @@
 import { CompletionBase } from '../../base'
+import { getInstructionsForBash } from '../../utils/bash'
+import { getInstructionsForFish } from '../../utils/fish'
+import { getInstructionsForZsh } from '../../utils/zsh'
 
 export default class Completion extends CompletionBase {
   static description = 'completion plugin'
@@ -13,13 +16,23 @@ export default class Completion extends CompletionBase {
 
   async run() {
     const { flags } = this.parse(Completion)
+    const { bin } = this.config
     const shell = flags.shell
 
-    this.log(
-      [
-        `Run the following command to generate completion script for ${shell} shell:`,
-        `$ ${this.config.bin} completion:generate --shell=${shell}`,
-      ].join('\n')
-    )
+    let instructions: string[] = []
+
+    if (shell === 'bash') {
+      instructions = getInstructionsForBash({ bin, shell })
+    }
+
+    if (shell === 'fish') {
+      instructions = getInstructionsForFish({ bin, shell })
+    }
+
+    if (shell === 'zsh') {
+      instructions = getInstructionsForZsh({ bin, shell })
+    }
+
+    this.log(instructions.join('\n'))
   }
 }

src/utils/bash.ts

@@ -419,3 +419,36 @@ export function generateCompletionScriptForBash({
 
   return scriptParts.join('\n'.repeat(2))
 }
+
+export function getInstructionsForBash({
+  bin,
+  shell,
+}: {
+  bin: string
+  shell: string
+}): string[] {
+  const scriptName = bin
+
+  const lines = [
+    `Make sure you have the "bash-completion" package installed on your system.`,
+    ``,
+    `Running the following command will generate the completion script for ${shell} shell:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > ${scriptName}`,
+    ``,
+    `You need to put that "${scriptName}" file in one of the following directories (depending on your system):`,
+    ``,
+    `- $XDG_DATA_HOME/bash-completion/completions`,
+    `- ~/.local/share/bash-completion/completions`,
+    `- /usr/local/share/bash-completion/completions`,
+    `- /usr/share/bash-completion/completions`,
+    ``,
+    `Usually this should work:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > ~/.local/share/bash-completion/completions/${scriptName}`,
+    ``,
+    `Enjoy!`,
+  ]
+
+  return lines
+}

src/utils/fish.ts

@@ -57,3 +57,30 @@ export function generateCompletionScriptForFish({
 
   return scriptParts.join('\n'.repeat(2))
 }
+
+export function getInstructionsForFish({
+  bin,
+  shell,
+}: {
+  bin: string
+  shell: string
+}): string[] {
+  const scriptName = `${bin}.fish`
+
+  const lines = [
+    `Running the following command will generate the completion script for ${shell} shell:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > ${scriptName}`,
+    ``,
+    `You need to put that "${scriptName}" file in one of the directories present in "$fish_complete_path" environment variable:`,
+    ``,
+    `  $ echo $fish_complete_path`,
+    ``,
+    `Usually this should work:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > ~/.config/fish/completions/${scriptName}`,
+    ``,
+    `Enjoy!`,
+  ]
+  return lines
+}

src/utils/zsh.ts

@@ -178,3 +178,30 @@ function _${bin}_${command.id} {
 
   return scriptParts.join('\n'.repeat(2))
 }
+
+export function getInstructionsForZsh({
+  bin,
+  shell,
+}: {
+  bin: string
+  shell: string
+}): string[] {
+  const scriptName = `_${bin}`
+
+  const lines = [
+    `Running the following command will generate the completion script for ${shell} shell:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > ${scriptName}`,
+    ``,
+    `You need to put that "${scriptName}" file in one of the directories present in "$FPATH" environment variable:`,
+    ``,
+    `  $ echo $FPATH`,
+    ``,
+    `Usually this should work by automatically find an appropriate directory for you:`,
+    ``,
+    `  $ ${bin} completion:generate --shell=${shell} > "$(echo \${FPATH} | tr ':' '\\n' | grep site-functions | head -n1)/${scriptName}"`,
+    ``,
+    `Enjoy!`,
+  ]
+  return lines
+}