🐛 Fix Bash completion install to .bashrc (#81)

* 🐛 Fix Bash completion setup to .bashrc

* 📝 Update docs and script for Windows development environment

docs/contributing.md

@@ -8,50 +8,74 @@ If you already cloned the repository and you know that you need to deep dive in
 
 You can create a virtual environment in a directory using Python's `venv` module:
 
+<div class="termy">
+
 ```console
 $ python -m venv env
 ```
 
+</div>
+
 That will create a directory `./env/` with the Python binaries and then you will be able to install packages for that isolated environment.
 
 ### Activate the environment
 
 Activate the new environment with:
 
+<div class="termy">
+
 ```console
 $ source ./env/bin/activate
 ```
 
+</div>
+
 Or in Windows' PowerShell:
 
+<div class="termy">
+
 ```console
 $ .\env\Scripts\Activate.ps1
 ```
 
+</div>
+
 Or if you use Bash for Windows (e.g. <a href="https://gitforwindows.org/" class="external-link" target="_blank">Git Bash</a>):
 
+<div class="termy">
+
 ```console
 $ source ./env/Scripts/activate
 ```
 
+</div>
+
 To check it worked, use:
 
+<div class="termy">
+
 ```console
 $ which pip
 
 some/directory/typer/env/bin/pip
 ```
 
+</div>
+
 If it shows the `pip` binary at `env/bin/pip` then it worked. 🎉
 
 Or in Windows PowerShell:
 
+<div class="termy">
+
 ```console
 $ Get-Command pip
 
 some/directory/typer/env/bin/pip
 ```
 
+</div>
+
 !!! tip
     Every time you install a new package with `pip` under that environment, activate the environment again.
 
@@ -63,18 +87,42 @@ some/directory/typer/env/bin/pip
 
 After activating the environment as described above, install `flit`:
 
+<div class="termy">
+
 ```console
 $ pip install flit
+
+---> 100%
 ```
 
+</div>
+
 Now re-activate the environment to make sure you are using the `flit` you just installed (and not a global one).
 
 And now use `flit` to install the development dependencies:
 
+<div class="termy">
+
 ```console
 $ flit install --deps develop --symlink
+
+---> 100%
 ```
 
+</div>
+
+If you are on Windows, use `--pth-file` instead of `--symlink`:
+
+<div class="termy">
+
+```console
+$ flit install --deps develop --pth-file
+
+---> 100%
+```
+
+</div>
+
 It will install all the dependencies and your local Typer in your local environment.
 
 #### Using your local Typer
@@ -89,26 +137,30 @@ That way, you don't have to "install" your local version to be able to test ever
 
 There is a script that you can run that will format and clean all your code:
 
+<div class="termy">
+
 ```console
 $ bash scripts/format.sh
 ```
 
+</div>
+
 It will also auto-sort all your imports.
 
-For it to sort them correctly, you need to have Typer installed locally in your environment, with the command in the section above:
-
-```console
-$ flit install --symlink
-```
+For it to sort them correctly, you need to have Typer installed locally in your environment, with the command in the section above using `--symlink` (or `--pth-file` on Windows).
 
 ### Format imports
 
 There is another script that formats all the imports and makes sure you don't have unused imports:
 
+<div class="termy">
+
 ```console
 $ bash scripts/format-imports.sh
 ```
 
+</div>
+
 As it runs one command after the other and modifies and reverts many files, it takes a bit longer to run, so it might be easier to use `scripts/format.sh` frequently and `scripts/format-imports.sh` only before committing.
 
 ## Docs
@@ -137,10 +189,19 @@ This helps making sure that:
 
 During local development, there is a script that builds the site and checks for any changes, live-reloading:
 
+<div class="termy">
+
 ```console
 $ bash scripts/docs-live.sh
+
+<span style="color: green;">[INFO]</span>    -  Building documentation...
+<span style="color: green;">[INFO]</span>    -  Cleaning site directory
+<span style="color: green;">[INFO]</span>    -  Documentation built in 2.74 seconds
+<span style="color: green;">[INFO]</span>    -  Serving on http://127.0.0.1:8008
 ```
 
+</div>
+
 It will serve the documentation on `http://127.0.0.1:8008`.
 
 That way, you can edit the documentation/source files and see the changes live.
@@ -149,10 +210,14 @@ That way, you can edit the documentation/source files and see the changes live.
 
 There is a script that you can run locally to test all the code and generate coverage reports in HTML:
 
+<div class="termy">
+
 ```console
 $ bash scripts/test-cov-html.sh
 ```
 
+</div>
+
 This command generates a directory `./htmlcov/`, if you open the file `./htmlcov/index.html` in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.
 
 ### Tests in your editor

scripts/docs-live.sh

@@ -2,4 +2,4 @@
 
 set -e
 
-mkdocs serve --dev-addr 0.0.0.0:8008
+mkdocs serve --dev-addr 127.0.0.1:8008

tests/test_completion/test_completion.py

@@ -22,7 +22,7 @@ def test_show_completion():
 
 
 def test_install_completion():
-    bash_completion_path: Path = Path.home() / ".bash_completion"
+    bash_completion_path: Path = Path.home() / ".bashrc"
     text = ""
     if bash_completion_path.is_file():  # pragma: nocover
         text = bash_completion_path.read_text()

tests/test_completion/test_completion_install.py

@@ -30,7 +30,7 @@ def test_completion_install_no_shell():
 
 
 def test_completion_install_bash():
-    bash_completion_path: Path = Path.home() / ".bash_completion"
+    bash_completion_path: Path = Path.home() / ".bashrc"
     text = ""
     if bash_completion_path.is_file():
         text = bash_completion_path.read_text()

typer/completion.py

@@ -166,7 +166,7 @@ def install(
         shell, _ = shellingham.detect_shell()
     mode = None
     if shell == "bash":
-        path_obj = Path.home() / ".bash_completion"
+        path_obj = Path.home() / ".bashrc"
         mode = mode or "a"
     elif shell == "zsh":
         path_obj = Path.home() / ".zshrc"