google/keep-sorted v0.5.0

on GitHub

WARNING: This release is semi-breaking.

This release adds support for YAML lists ([a, b, c]) for multi-valued options like ignore_prefixes. This allows you to include special characters and spaces in the values for those options. This will break any pre-existing option values that start with a left square bracket [.

It's only semi-breaking because there's a workaround: YAML list support is controlled by a hidden option allow_yaml_lists and keep-sorted now allows you to specify the default options on the command line.

1. When updating your version of the tool, also change the --default-options to include allow_yaml_lists=no.
   TIP: Run keep-sorted --help to see what the rest of the standard default options are
2. For the pre-existing option values that are broken by YAML lists either add allow_yaml_lists=yes to the pre-existing directive and fix the value so it's a valid YAML list (e.g. [,* would become ['[', *]) OR add allow_yaml_lists=no to the pre-existing directive
3. [Optionally] Flip the default of allow_yaml_lists back to yes
4. [Optionally] Remove any allow_yaml_lists=yes in the codebase

What's Changed

• chore: Remove unused protobuf dependency. by @JeffFaer in #32
• feat: Allow default options to be customzied with a flag. by @JeffFaer in #35
• feat: Surface option parsing warnings via findings. by @JeffFaer in #41
• feat: Allow for spaces and commas in string-valued options. by @JeffFaer in #29

Full Changelog: v0.4.0...v0.5.0