Summary

Rework the setup-completion command to be more generally useful.

Review Request #13068 — Created May 25, 2023 and submitted May 30, 2023, 3:25 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

~~13069~~, ~~13070~~, ~~13071~~

Reviewers

Groups

rbtools

People

Description

The setup-completion command has been around for a while, but it's
become less useful with time. It made an attempt to write completion
files to system directories for Linux or macOS, leaving Windows out, and
in fact leaving macOS out since system directories can't be written to.

Looking into what it would take to write these files safely to local
directories, it seems to be a mess, depending on bash/zsh versions,
distros, and configurations (e.g., Oh-My-ZSH vs. native ZSH setups).

Looking at some other completion-generator commands (npm, pip, and
pyenv), it seems that most don't bother trying to write and instead
leave it up to the user to place the code in the right place.

Given options, outputting the code is the best way to go, and has the
advantage of simplifying code considerably.

Documentation has been updated to walk users through configuring this.

Testing Done

Tested the auto-completion scripts with Bash and Zsh.

Tested default shell detection.

Tested using --json to get the script.

Built the docs. Read through them and checked for bad links, build
errors, and spelling errors.

Commits

Summary	ID
Rework the setup-completion command to be more generally useful. The `setup-completion` command has been around for a while, but it's become less useful with time. It made an attempt to write completion files to system directories for Linux or macOS, leaving Windows out, and in fact leaving macOS out since system directories can't be written to. Looking into what it would take to write these files safely to local directories, it seems to be a mess, depending on bash/zsh versions, distros, and configurations (e.g., Oh-My-ZSH vs. native ZSH setups). Looking at some other completion-generator commands (npm, pip, and pyenv), it seems that most don't bother trying to write and instead leave it up to the user to place the code in the right place. Given options, outputting the code is the best way to go, and has the advantage of simplifying code considerably. Documentation has been updated to walk users through configuring this.	3f65f0718de4eaedb3f89ed37913e18e42f7f7e0

Summary

Rework the setup-completion command to be more generally useful.

The `setup-completion` command has been around for a while, but it's become less useful with time. It made an attempt to write completion files to system directories for Linux or macOS, leaving Windows out, and in fact leaving macOS out since system directories can't be written to. Looking into what it would take to write these files safely to local directories, it seems to be a mess, depending on bash/zsh versions, distros, and configurations (e.g., Oh-My-ZSH vs. native ZSH setups). Looking at some other completion-generator commands (npm, pip, and pyenv), it seems that most don't bother trying to write and instead leave it up to the user to place the code in the right place. Given options, outputting the code is the best way to go, and has the advantage of simplifying code considerably. Documentation has been updated to walk users through configuring this.

3f65f0718de4eaedb3f89ed37913e18e42f7f7e0

Issues

Description	From	Last Updated
'rbtools.utils.appdirs.user_data_dir' imported but unused Column: 1 Error code: F401	reviewbot	May 25, 2023, 1:59 a.m.
'rbtools.utils.filesystem.get_home_path' imported but unused Column: 1 Error code: F401	reviewbot	May 25, 2023, 1:59 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/setup_completion.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'rbtools.utils.appdirs.user_data_dir' imported but unused

Column: 1
Error code: F401
```

rbtools/commands/setup_completion.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.utils.filesystem.get_home_path' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Rework the setup-completion command to be more generally useful. The `setup-completion` command has been around for a while, but it's become less useful with time. It made an attempt to write completion files to system directories for Linux or macOS, leaving Windows out, and in fact leaving macOS out since system directories can't be written to. Looking into what it would take to write these files safely to local directories, it seems to be a mess, depending on bash/zsh versions, distros, and configurations (e.g., Oh-My-ZSH vs. native ZSH setups). Looking at some other completion-generator commands (npm, pip, and pyenv), it seems that most don't bother trying to write and instead leave it up to the user to place the code in the right place. Given options, outputting the code is the best way to go, and has the advantage of simplifying code considerably. Documentation has been updated to walk users through configuring this.	0879eb4be5583295d1d09c1cc128154b79e7ab6d
	Rework the setup-completion command to be more generally useful. The `setup-completion` command has been around for a while, but it's become less useful with time. It made an attempt to write completion files to system directories for Linux or macOS, leaving Windows out, and in fact leaving macOS out since system directories can't be written to. Looking into what it would take to write these files safely to local directories, it seems to be a mess, depending on bash/zsh versions, distros, and configurations (e.g., Oh-My-ZSH vs. native ZSH setups). Looking at some other completion-generator commands (npm, pip, and pyenv), it seems that most don't bother trying to write and instead leave it up to the user to place the code in the right place. Given options, outputting the code is the best way to go, and has the advantage of simplifying code considerably. Documentation has been updated to walk users through configuring this.	3f65f0718de4eaedb3f89ed37913e18e42f7f7e0

Diff:

Revision 2 (+374 -270)

Show changes

	docs/rbtools/rbt/commands/setup-completion.rst
	rbtools/commands/setup_completion.py
	rbtools/commands/conf/rbt-bash-completion
	rbtools/commands/conf/_rbt-zsh-completion
	rbtools/commands/tests/test_setup_completion.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (ed11f56)