From 04d0ab89ca3bb06a986c7d5b7792913c4a832e37 Mon Sep 17 00:00:00 2001 From: Renan Araujo Date: Tue, 18 Apr 2023 17:36:23 +0100 Subject: [PATCH 1/3] docs: update readme with a troubleshooting section --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae9913a..48ceaaa 100644 --- a/README.md +++ b/README.md @@ -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. @@ -81,6 +83,21 @@ Future runCommand(ArgResults topLevelResults) async { // ... analytics and other unrelated stuff ``` +#### Tab completion is not working on my zsh terminal + +If you dont have 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 +``` + +If you already have a zsh framework that already run those lines, you shouldnt need to do anything. + + [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 @@ -99,3 +116,4 @@ Future 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/ From 78de4bce5bf8d773c4b3c5241b8dc5d88934a11d Mon Sep 17 00:00:00 2001 From: Renan Araujo Date: Tue, 18 Apr 2023 17:37:55 +0100 Subject: [PATCH 2/3] respect markdown --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48ceaaa..ed3a6df 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ For an overview of how this package works, check out the [documentation][docs_li ## Troubleshooting 🧠🔨 -#### Tab completion is taking too long +### Tab completion is taking too long Handling completion requests should be straightforward. @@ -83,7 +83,7 @@ Future runCommand(ArgResults topLevelResults) async { // ... analytics and other unrelated stuff ``` -#### Tab completion is not working on my zsh terminal +### Tab completion is not working on my zsh terminal If you dont have any zsh framework such as [Oh My Zsh][oh_my_zsh], you have to start the completion system manually. From d860cf503040efe323338f1c8b011646284a2a06 Mon Sep 17 00:00:00 2001 From: Renan Araujo Date: Tue, 18 Apr 2023 17:40:20 +0100 Subject: [PATCH 3/3] cmon --- .github/cspell.json | 4 +++- README.md | 5 +---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/cspell.json b/.github/cspell.json index dac7f94..322c4ae 100644 --- a/.github/cspell.json +++ b/.github/cspell.json @@ -19,6 +19,8 @@ "words": [ "subcommand", "inverseflag", - "trueflag" + "trueflag", + "autoload", + "compinit" ] } diff --git a/README.md b/README.md index ed3a6df..2e43487 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ Future runCommand(ArgResults topLevelResults) async { ### Tab completion is not working on my zsh terminal -If you dont have any zsh framework such as [Oh My Zsh][oh_my_zsh], you have to start the completion system manually. +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: @@ -95,9 +95,6 @@ autoload -Uz compinit compinit ``` -If you already have a zsh framework that already run those lines, you shouldnt need to do anything. - - [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