kakoune/doc/pages/changelog.asciidoc

= Changelog

This changelog contains major and/or breaking changes to Kakoune between
released versions.

== Development version

This version contains a significant overhaul of various Kakoune
features that can break user configuration. This was a necessary
change to make Kakoune command model cleaner and more robust.

* `%sh{...}` strings are not reparsed automatically anymore, they need
  to go through an explicit `evaluate-commands`

* The `-allow-override` switch from `define-command` has been renamed
  `-override`.

* The search prompt uses buffer word completion so that fuzzy completion
  can be used to quickly search for a buffer word.

* The `wrap` highlighter can accept a new `-marker <marker_text>` switch.

* The command line syntax has changed to support robust escaping, see
  <<command-parsing#,`:doc command-parsing`>>.

* Various lists (options, registers...) in Kakoune are now written using
  the command line syntax:

  - `set-register` now take an arbitrary number of parameters and sets
    the register to multiple strings. `%reg` expands to a list of strings.

  - `%opt` expands list options as list of strings.

  - selection descs are whitespaces separated instead of `:` separated

* Highlighters syntax has changed to permit explicit naming and remove
  highlighter specific name parameters (such as for the group highlighter)
  `add-highlighter <path>/<name> <type> <params>` is the new syntax.

* Regions highlighters have been overhauled and are now specified with
  a sequence of commands instead of a single one:

  ------------------------------------------------------------------
  add-highlighter <path>/<name> regions
  add-highlighter <path>/<name>/<region name> region <begin> <end> \
  <type> <params>
  ------------------------------------------------------------------

  The recursion regex is opt-in through a `-recurse <recurse>` flag.

  They also are not necessarily groups anymore, a region can directly
  apply any other highlighter

  See <<highlighters#,`:doc highlighters`>>

== Kakoune 2018.04.13

First official Kakoune release.
Add a changelog.asciidoc doc page changelog.asciidoc should track major/breaking changes between versions. 2018-05-19 03:05:28 +02:00			`= Changelog`

			`This changelog contains major and/or breaking changes to Kakoune between`
			`released versions.`

			`== Development version`

Update Changelog to describe the list syntax overhaul 2018-06-03 07:05:48 +02:00			`This version contains a significant overhaul of various Kakoune`
			`features that can break user configuration. This was a necessary`
			`change to make Kakoune command model cleaner and more robust.`

Do not reparse %sh{...} strings Automatic reparsing of %sh{...}, while convenient in many cases, can be surprising as well, and can lead to security problems: 'echo %sh{ printf "foo\necho bar" }' runs 'echo foo', then 'echo bar'. we make this danger explicit, and we fix the 'nop %sh{...}' pattern. To reparse %sh{...} strings, they can be passed to evaluate-commands, which has been fixed to work in every cases where %sh{...} reparsing was used.. 2018-05-06 23:29:52 +02:00			* `%sh{...}` strings are not reparsed automatically anymore, they need
			to go through an explicit `evaluate-commands`

Add a changelog.asciidoc doc page changelog.asciidoc should track major/breaking changes between versions. 2018-05-19 03:05:28 +02:00			* The `-allow-override` switch from `define-command` has been renamed
			`-override`.

			`* The search prompt uses buffer word completion so that fuzzy completion`
			`can be used to quickly search for a buffer word.`

docs: fix missing `]` in wrap hl -marker switch docstring Also add the related changelog entry 2018-05-30 18:11:19 +02:00			* The `wrap` highlighter can accept a new `-marker <marker_text>` switch.

Update Changelog to describe the list syntax overhaul 2018-06-03 07:05:48 +02:00			`* The command line syntax has changed to support robust escaping, see`
			<<command-parsing#,`:doc command-parsing`>>.

			`* Various lists (options, registers...) in Kakoune are now written using`
			`the command line syntax:`

			- `set-register` now take an arbitrary number of parameters and sets
			the register to multiple strings. `%reg` expands to a list of strings.

			- `%opt` expands list options as list of strings.

			- selection descs are whitespaces separated instead of `:` separated

Add highlighter syntax change informations in changelog 2018-06-28 13:18:23 +02:00			`* Highlighters syntax has changed to permit explicit naming and remove`
			`highlighter specific name parameters (such as for the group highlighter)`
			`add-highlighter <path>/<name> <type> <params>` is the new syntax.

			`* Regions highlighters have been overhauled and are now specified with`
			`a sequence of commands instead of a single one:`

			`------------------------------------------------------------------`
			`add-highlighter <path>/<name> regions`
			`add-highlighter <path>/<name>/<region name> region <begin> <end> \`
Make recurse regex opt-in with a -recurse switch instead of opt-out 2018-07-02 12:59:12 +02:00			`<type> <params>`
Add highlighter syntax change informations in changelog 2018-06-28 13:18:23 +02:00			`------------------------------------------------------------------`

Make recurse regex opt-in with a -recurse switch instead of opt-out 2018-07-02 12:59:12 +02:00			The recursion regex is opt-in through a `-recurse <recurse>` flag.

Add highlighter syntax change informations in changelog 2018-06-28 13:18:23 +02:00			`They also are not necessarily groups anymore, a region can directly`
			`apply any other highlighter`

			See <<highlighters#,`:doc highlighters`>>

Add a changelog.asciidoc doc page changelog.asciidoc should track major/breaking changes between versions. 2018-05-19 03:05:28 +02:00			`== Kakoune 2018.04.13`

			`First official Kakoune release.`