diff --git a/docs/src/release_notes/v0.29.md b/docs/src/release_notes/v0.29.md index acf6bbd55e..843e2d6dcf 100644 --- a/docs/src/release_notes/v0.29.md +++ b/docs/src/release_notes/v0.29.md @@ -8,28 +8,31 @@ One step further to exchange completions between commands. Registered the domain [carapace.sh](https://carapace.sh). -## Specs - -The [JSON Schema](http://json-schema.org/) is now hosted at [https://carapace.sh/schemas/command.json](https://carapace.sh/schemas/command.json). -The local generation was removed and the spec header needs to be changed to: - -```yaml -# yaml-language-server: $schema=https://carapace.sh/schemas/command.json -```` - ## Root Command Restructured the `carapace` root command which was (and still is) a bit of a mess. -Some "flags" (subcommands) were renamed/changed for consistency. +Some *flags* (subcommands) were renamed/changed for consistency. - `--list=json` -> `--list --format json` - `--macros` -> `--macro` - `--scrape [spec]` -> `--codegen [spec]` +## Specs + +The [JSON Schema](http://json-schema.org/) is now hosted at [https://carapace.sh/schemas/command.json](https://carapace.sh/schemas/command.json). + +```yaml +# yaml-language-server: $schema=https://carapace.sh/schemas/command.json +``` + +> `~/.config/carapace/schema.json` is now deprecated and can be removed. + ## Macro `$_` prefix in specs is now deprecated and needs to be replaced with `$carapace.` +If a macro name contains `.` the first segment is handled as command that will be invoked. + ```sh $carapace.color.HexColors # invokes `carapace _carapace macro color.HexColors ""` @@ -38,11 +41,17 @@ $carapace-spec.Spec(example.yaml) # invokes `carapace-spec _carapace macro "Spec(example.yaml)" ""` ``` -> You can replace this with the `--in-place` flag directly: -> ```sh -> sed 's/$_/$carapace./g' ~/.config/carapace/specs/*.yaml -> ``` - +> This will change again in the future to support custom macros. + +With the `--in-place` flag of `sed` this can be updated directly. +```sh +sed 's/$_/$carapace./g' ~/.config/carapace/specs/*.yaml +``` + +## Inshellisense + +Added a bridge for [inshellisense](https://github.com/microsoft/inshellisense) (which uses [fig](https://fig.io) under the hood). + ## Nushell Support for colored completion (requires [nushell#11442](https://github.com/nushell/nushell/pull/11442)).