diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 4178957e..28dc04f4 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -40,6 +40,7 @@ - [carapace-generate](./development/tools/carapace-generate.md) - [Release Notes](./release_notes.md) - [v1.x](./release_notes/v1.x.md) + - [v1.3](./release_notes/v1.3.md) - [v1.2](./release_notes/v1.2.md) - [v1.1](./release_notes/v1.1.md) - [v1.0](./release_notes/v1.0.md) diff --git a/docs/src/release_notes/v1.3.md b/docs/src/release_notes/v1.3.md new file mode 100644 index 00000000..4fa20c3a --- /dev/null +++ b/docs/src/release_notes/v1.3.md @@ -0,0 +1,46 @@ +# v1.3 - Commander Key + +![](./v1.3/banner.png) + +Command Prompt is Toast! + +## Cmd + +Experimental support for [Cmd](https://en.wikipedia.org/wiki/Cmd.exe) through [Clink](https://chrisant996.github.io/clink/). + +```lua +# ~/AppData/Local/clink/carapace.lua +load(io.popen('carapace _carapace cmd-clink'):read("*a"))() +``` + +![](./v1.3/cmd.png) + +> Very early version with a lot of fundamental features not yet working. + +## Fish + +With [4.0b1](https://github.com/fish-shell/fish-shell/releases/tag/4.0b1) onwards the following workaround is **not** needed anymore: +```sh +mkdir -p ~/.config/fish/completions +carapace --list | awk '{print $1}' | xargs -I{} touch ~/.config/fish/completions/{}.fish # disable auto-loaded completions (#185) +``` +see [fish-shell/fish#6716](https://github.com/fish-shell/fish-shell/issues/6716) + +> Remove the leftover placeholders in `~/.config/fish/completions/`. + +## Bridge + +- Switched to [`$fish_complete_path`](https://fishshell.com/docs/current/completions.html#where-to-put-completions) to list available completions in the Fish bridge. + > This should fix `nix`-based installations. +- Added another call to `compinit` to [adopt changes](https://www.reddit.com/r/zsh/comments/gk2c91/comment/kpjmntg/) to `fpath` in the Zsh bridge. + > At this point it should not be neccessary to call `compinit` in the `.zshrc`. + +## Git + +Added [reflog](https://www.youtube.com/watch?v=cp2eGmWy9UI&t=158s) completion. + +![](./v1.3/reflog.cast) + +## Freckles + +Added [Freckles](https://freckles.carapace.sh) as example project. diff --git a/docs/src/release_notes/v1.3/banner.png b/docs/src/release_notes/v1.3/banner.png new file mode 100644 index 00000000..fb4a54ea Binary files /dev/null and b/docs/src/release_notes/v1.3/banner.png differ diff --git a/docs/src/release_notes/v1.x/cmd.png b/docs/src/release_notes/v1.3/cmd.png similarity index 100% rename from docs/src/release_notes/v1.x/cmd.png rename to docs/src/release_notes/v1.3/cmd.png diff --git a/docs/src/release_notes/v1.x/reflog.cast b/docs/src/release_notes/v1.3/reflog.cast similarity index 100% rename from docs/src/release_notes/v1.x/reflog.cast rename to docs/src/release_notes/v1.3/reflog.cast diff --git a/docs/src/release_notes/v1.x.md b/docs/src/release_notes/v1.x.md index 2f41a131..765a2327 100644 --- a/docs/src/release_notes/v1.x.md +++ b/docs/src/release_notes/v1.x.md @@ -3,48 +3,3 @@ ![](./v1.x/banner.png) Under development. - -## Cmd - -Experimental support for [Cmd](https://en.wikipedia.org/wiki/Cmd.exe) through [Clink](https://chrisant996.github.io/clink/). - -```lua -# ~/AppData/Local/clink/carapace.lua -load(io.popen('carapace _carapace cmd-clink'):read("*a"))() -``` - -![](./v1.x/cmd.png) - -> Very early version with a lot of fundamental features not yet working (multiparts, quotes, nospace, ...). -> -> Flags _should_ work (though somehow not for `git`). - - -## Fish - -With [4.0b1](https://github.com/fish-shell/fish-shell/releases/tag/4.0b1) onwards the following workaround is **not** needed anymore: -```sh -mkdir -p ~/.config/fish/completions -carapace --list | awk '{print $1}' | xargs -I{} touch ~/.config/fish/completions/{}.fish # disable auto-loaded completions (#185) -``` -see [fish-shell/fish#6716](https://github.com/fish-shell/fish-shell/issues/6716) - -> Remove the leftover placeholders in `~/.config/fish/completions/`. - -Also switched to [`$fish_complete_path`](https://fishshell.com/docs/current/completions.html#where-to-put-completions) to list available completions in the bridge. - -## Git - -Added [reflog](https://www.youtube.com/watch?v=cp2eGmWy9UI&t=158s) completion. - -![](./v1.x/reflog.cast) - -## Zsh - -Added another call to `compinit` to [adopt changes](https://www.reddit.com/r/zsh/comments/gk2c91/comment/kpjmntg/) to `fpath` in the bridge. - -> At this point it should not be neccessary to call `compinit` in the `.zshrc`. - -## Freckles - -Added [Freckles](https://freckles.carapace.sh) as example project.