From 8510422ce64a7486ee5efce69585a1c379f0e3cc Mon Sep 17 00:00:00 2001 From: William G Underwood <42812654+WGUNDERWOOD@users.noreply.github.com> Date: Wed, 4 Dec 2024 10:40:03 +0000 Subject: [PATCH] Update NEWS.md --- NEWS.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ notes.org | 2 +- 2 files changed, 46 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index 7eb0c11..e1a79b4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,48 @@ +# v0.5.0-alpha + +Version v0.5.0 will be a major release, including breaking changes and +substantial new features. I would be very grateful for any help with testing, +along with any comments, questions or suggestions, +to ensure as much functionality as possible in v0.5.0. Please work from the +`main` branch to ensure you have the latest version. + +## Changes to existing CLI options +- The option to disable line wrapping has been changed from + `--keep` to `--nowrap`. +- The option to set the number of characters used per indentation level + has been changed from `--tab` to `--tabsize`. +- The option to set the maximum line length for wrapping + has been changed from `--wrap` to `--wraplen`. +- See below for information on the new `--config`, + `--man` and `--completion` flags. + +## Configuration file support +Configuring tex-fmt can now be achieved using a configuration file +as well as CLI arguments. +The configuration file can be read from a user-specified path, +from the current working directory, from the root of the current +git repository, or from the user's configuration directory, +in order of decreasing priority. +Arguments passed on the command line will always override those +specified in configuration files. + +## Man pages +Man pages can be generated using the `--man` flag. +Pre-build man pages are also available for download +from the GitHub repository. + +## Shell completion +Completion files for popular shells, including +bash, fish, zsh, elvish and PowerShell, +can be generated using the `--completion ` flag. +Pre-built completion scripts are also available for download +from the GitHub repository. + +## Minor changes +- Fixed bug with `\itemsep` matching the `\item` pattern +- Added last non-indented line number to + "Indent did not return to zero" error messages + # v0.4.7 - Fix bug with `--stdin` adding newlines at EOF diff --git a/notes.org b/notes.org index cd94a3b..f2af594 100644 --- a/notes.org +++ b/notes.org @@ -13,7 +13,7 @@ ** Config args parser function * Release process ** Update release notes -*** git log --oneline --no-merges vX.X.X main +*** git log --oneline --no-merges vX.X.X..main *** Write in NEWS.md ** Update version number in Cargo.toml ** Update Nix flake and lock