Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move completion files to the right directory when installing tldr #342

Open
marchersimon opened this issue Apr 22, 2021 · 3 comments
Open

Comments

@marchersimon
Copy link
Contributor

marchersimon commented Apr 22, 2021

The completion files at bin/completion for bash and zsh currently aren't copied anywhere, so they cannot be seen by bash or zsh.

For bash completion files have to go to /usr/share/bash-completion/completions/.

For zsh completion files have to be in any directory in $fpath (e.g. /usr/share/zsh/functions/Completion/Zsh/).

Is there a reason this hasn't been done yet?

@vladimyr
Copy link
Collaborator

Is there a reason this hasn't been done yet?

Because the only way to do that is to utilize a post-install script which is considered a kinda grey zone territory. Some folks explicitly prevent those from running using either npm config or the corresponding installation-time CLI option.

@vladimyr
Copy link
Collaborator

As I mentioned here #311 (comment) cleaner way would be to implement completion subcommand like:

tldr completion bash
# or
tldr completion zsh

which would then output the completion code for the requested shell. That way users can either add it to their profile or write to completion dirs you already listed. And they would have to do that manually as opposed to running stuff behind their back.

@owenvoke
Copy link
Member

I agree @vladimyr, a subcommand would probably be the best option and is also pretty common. 👍🏻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

3 participants