Move shell completion scripts to their own directory (#259)

* Move shell completion scripts to their own directory * Remove completion scripts from published Cargo package
tealdeer-rs · Jan 20, 2022 · 2177297 · 2177297
1 parent 3b4451f
commit 2177297
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 5 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -29,7 +29,7 @@ jobs:
         run: |
           source ./scripts/upload-asset.sh
           # Upload:           <token>                     <repo>                   <tag>                 <file>                        <name>
-          upload_release_file ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} ${{ matrix.target }}_tealdeer completions_${{ matrix.target }}
+          upload_release_file ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} completion/${{ matrix.target }}_tealdeer completions_${{ matrix.target }}
 
   upload-license:
     needs:

diff --git a/Cargo.toml b/Cargo.toml
@@ -11,7 +11,7 @@ readme = "README.md"
 repository = "https://github.com/dbrgn/tealdeer/"
 documentation = "https://dbrgn.github.io/tealdeer/"
 version = "1.5.0"
-include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png", "/bash_tealdeer", "/fish_tealdeer"]
+include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png"]
 edition = "2018"
 
 [[bin]]

diff --git a/bash_tealdeer → completion/bash_tealdeer b/bash_tealdeer → completion/bash_tealdeer
diff --git a/fish_tealdeer → completion/fish_tealdeer b/fish_tealdeer → completion/fish_tealdeer
diff --git a/zsh_tealdeer → completion/zsh_tealdeer b/zsh_tealdeer → completion/zsh_tealdeer
diff --git a/docs/src/installing.md b/docs/src/installing.md
@@ -57,6 +57,9 @@ To enable the log output, set the `RUST_LOG` env variable:
 
 ## Autocompletion
 
-- *Bash*: copy `bash_tealdeer` to `/usr/share/bash-completion/completions/tldr`
-- *Fish*: copy `fish_tealdeer` to `~/.config/fish/completions/tldr.fish`
-- *Zsh*: copy `zsh_tealdeer` to `/usr/share/zsh/site-functions/_tldr`
+Shell completion scripts are located in the folder `completion`. 
+Just copy them to their designated location:
+
+- *Bash*: `cp completion/bash_tealdeer /usr/share/bash-completion/completions/tldr`
+- *Fish*: `cp completion/fish_tealdeer ~/.config/fish/completions/tldr.fish`
+- *Zsh*: `cp completion/zsh_tealdeer /usr/share/zsh/site-functions/_tldr`