gdx 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +10 -4
  2. package/dist/index.js +616 -622
  3. package/package.json +6 -5
package/README.md CHANGED
@@ -87,9 +87,15 @@ Your compiled binary will be in `./dist/` folder.
87
87
 
88
88
  ### Optional: Shell Integration
89
89
 
90
- To enable features like `gdx parallel switch` (auto-cd into worktrees), you need to add shell integration.
90
+ To enable features like `gdx parallel switch` (auto-cd into worktrees) and **tab completion**, you need to add shell integration.
91
91
 
92
- To do this add the following line to the **End** of your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
92
+ Shell integration provides:
93
+
94
+ - **Auto-cd support**: Allows `gdx parallel switch` to change directories
95
+ - **Tab completion**: Intelligent completion for gdx commands, shorthands, and git subcommands
96
+ - **Git fallback**: Falls back to native git completion when gdx has no suggestions (git fallback requires you to install git's completion scripts separately)
97
+
98
+ To add shell integration, add the following line to the **End** of your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
93
99
 
94
100
  #### For bash and zsh:
95
101
 
@@ -113,7 +119,7 @@ Invoke-Expression (& { (gdx --init --shell pwsh | Out-String) })
113
119
  ```
114
120
 
115
121
  > [!TIP]
116
- > you can add `--cmd` to the `gdx --init` command to create custom aliases.
122
+ > You can add `--cmd` to the `gdx --init` command to create custom aliases.
117
123
  > For example, `gdx --init --shell zsh --cmd g` will create `g` as an alias for `gdx`.
118
124
 
119
125
  ## Core Features
@@ -236,7 +242,7 @@ This project uses **Bun** for development because it's fast and the developer ex
236
242
  Since this is currently a solo "scratch your own itch" project, the roadmap is fluid, but here is what is on the horizon:
237
243
 
238
244
  - [x] **Configurability:** Allow users to define their own shorthands in a `.gdxrc.toml` file.
239
- - [ ] **Shell Integration:** Auto-completion scripts for Zsh/Bash/Fish/Powershell.
245
+ - [x] **Shell Integration:** Auto-completion scripts for Zsh/Bash/Fish/Powershell with git fallback.
240
246
  - [ ] **Commit with specified editor:** like, `gdx commit --vim` to open Vim for commit messages.
241
247
  - [ ] **Quick commit:** `add`, `commit`, and `push` in one command like `gdx qc -pa` (`git add . && gdx commit auto && git push`)
242
248
  - [x] **Quick linting before push:** `gdx lint` to run following checks before pushing: