Skip to content

docs: update readme with a troubleshooting section #63

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.

Sign up for GitHub

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

Merged
scarletteliza merged 3 commits into from
Apr 18, 2023
Merged

docs: update readme with a troubleshooting section #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04d0ab8
docs: update readme with a troubleshooting section
renancaraujo Apr 18, 2023
78de4bc
respect markdown
renancaraujo Apr 18, 2023
d860cf5
cmon
renancaraujo Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
"words": [
"subcommand",
"inverseflag",
"trueflag"
"trueflag",
"autoload",
"compinit"
]
}
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ For an overview of how this package works, check out the [documentation][docs_li

---

### ⚠️ Using analytics
## Troubleshooting 🧠🔨

### Tab completion is taking too long

Handling completion requests should be straightforward.

Expand All @@ -81,6 +83,18 @@ Future<int?> runCommand(ArgResults topLevelResults) async {
// ... analytics and other unrelated stuff
```

### Tab completion is not working on my zsh terminal

If you are not using any zsh framework such as [Oh My Zsh][oh_my_zsh], you have to start the completion system manually.

Add the following lines to your `~/.zshrc` file:

```zsh
# Add this to the start of your zsh starter file (~/.zshrc)
autoload -Uz compinit
compinit
```

[dart_install_link]: https://dart.dev/get-dart
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
Expand All @@ -99,3 +113,4 @@ Future<int?> runCommand(ArgResults topLevelResults) async {
[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/cli_completion/main/coverage_badge.svg
[ci_badge]: https://github.com/VeryGoodOpenSource/cli_completion/workflows/ci/badge.svg
[ci_link]: https://github.com/VeryGoodOpenSource/cli_completion/actions
[oh_my_zsh]: https://ohmyz.sh/