Version update (#1219)

update changelog for 2.6 release

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: phlptp

.github/workflows/codeql.yml

@@ -49,8 +49,6 @@ jobs:
           build-mode: autobuild
         - language: python
           build-mode: none
-        - language: ruby
-          build-mode: none
         # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
         # Use `c-cpp` to analyze code written in C, C++ or both
         # Use 'java-kotlin' to analyze code written in Java, Kotlin or both

.github/workflows/tests.yml

@@ -127,9 +127,9 @@ jobs:
         run: cmake --build build -j2
 
   cuda12-build:
-    name: CUDA 12 build only
+    name: CUDA 13 build only
     runs-on: ubuntu-latest
-    container: nvidia/cuda:12.3.1-devel-ubuntu22.04
+    container: nvidia/cuda:13.0.0-devel-ubuntu22.04
     steps:
       - name: Add build tools
         run: apt-get update && apt-get install -y wget git cmake
@@ -387,3 +387,9 @@ jobs:
           cmake-version: "4.0"
           args: -DCLI11_BUILD_EXAMPLES_JSON=ON
         if: success() || failure()
+
+      - name: Check CMake 4.1
+        uses: ./.github/actions/quick_cmake
+        with:
+          cmake-version: "4.1"
+        if: success() || failure()

CHANGELOG.md

@@ -2,51 +2,164 @@
 
 ## Unreleased
 
+## Version 2.6.0
+
+This version adds finer grained control of when option callbacks are executed,
+and further refinements in the help formatting. It also fixes a number of bugs
+in type support and the ordering of options. The other major change is moving
+Extra Validators to a new file which can be disabled for slightly faster
+compilation if not used, and allowing additional future Validators to be easily
+added.
+
+### Added
+
+- Added option to align long options with a ratio via
+  `long_option_alignment_ratio` in the formatter. This allows more control over
+  help output formatting. [#1185][]
+- Added support for `std::string_view` in the `as<T>` method on options.
+  [#1187][]
+- Added flags on the formatter to disable formatting for the description and
+  footer, allowing custom formatting such as word art. [#1150][]
+- Added subcommand prefix matching as a modifier to `CLI::App`. Also included an
+  example of close matching logic. [#1152][]
+- Added additional fuzzing mechanics, including fuzzing subcommands, and
+  improved handling of edge cases. [#1170][]
+- Added new tests for array options and fixed ambiguity between tuple and
+  container conversions. [#1136][]
+- Added ability to use rvalue references in `add_flag` descriptions. [#1173][]
+- Added CMake presets for default and tidy builds. [#1181][]
+- Added several validator examples and documentation [#1192][]
+- Added permission validators for files and directories [#1203][]
+- Added fine grained control for option callback priority, and in what order
+  options including help execute in the processing sequence. [#1226][]
+- Added github action to link with future testing is oss-fuzz [#1225][]
+
+### Changed
+
+- Moved several of the validators to `ExtraValidators.hpp` and
+  `ExtraValidators_inl.hpp` files, The compilation of these nonessential
+  validators can be disabled by setting `CLI11_DISABLE_EXTRA_VALIDATORS` to
+  `OFF`. Future additional validators will be behind a compile flag
+  `CLI11_ENABLE_EXTRA_VALIDATORS`. All non-essential validators will be under
+  this option with version 3.0. [#1192][]
+- Updated processing order: requirements are now checked before callbacks,
+  avoiding unexpected side effects. [#1186][]
+- Updated minimum required CMake version to 3.14+. [#1182][]
+- Improved Meson build: support for building shared precompiled libraries,
+  pkgconfig, and header installation. [#1167][]
+- Improved fuzzing tests with new failure cases and extended coverage. [#1164][]
+- Updated CI to remove deprecated images and add new ones (Windows-2022/2025,
+  arm64, FreeBSD). [#1172][], [#1178][]
+- Updated license file to include the correct version number for packagers.
+  [#1180][]
+
+### Fixed
+
+- Fixed issue with IPV4 validator where it would allow a trailing `.`. [#1192][]
+- Fixed edge case where a missing config file and no default caused a segfault.
+  [#1199][]
+- Fixed issue with TOML multiline arrays when the first line contained only a
+  single character. [#1196][]
+- Fixed default value conversion errors when locales added thousands separators.
+  [#1160][]
+- Fixed multiple footer printing in help output for option groups. [#1161][]
+- Fixed incorrect argument order in extras error messages. [#1162][]
+- Fixed reversed argument order in unexpected argument error messages. [#1158][]
+- Fixed ambiguity with `vector<array>` options. [#1147][]
+- Fixed bug parsing negative floating point values without a leading zero.
+  [#1140][]
+- Fixed spelling mistake in `Error.hpp`. [#1129][]
+- Fixed compilation issue with MSVC 2017. [#1143][]
+- Fixed issue with default strings of arrays in config output. [#1155][]
+- Fixed fuzzing issues with NaNs and certain error pathways. [#1138][]
+- Fixed fuzzer misinterpreting `--sub1.-` as a short option. [#1148][]
+- Fixed issue where parse_order was not cleared on reset. [#1218][]
+- modify code to make compatible with /GR- option in MSVC [#1206][]
+- Fixed issue where the version flag would not take precedence over option
+  requirements [#1226][]
+- Fixed extra newlines being printed if a footer was in use [#1229][]
+
+[#1129]: https://github.com/CLIUtils/CLI11/pull/1129
+[#1136]: https://github.com/CLIUtils/CLI11/pull/1136
+[#1138]: https://github.com/CLIUtils/CLI11/pull/1138
+[#1140]: https://github.com/CLIUtils/CLI11/pull/1140
+[#1143]: https://github.com/CLIUtils/CLI11/pull/1143
+[#1147]: https://github.com/CLIUtils/CLI11/pull/1147
+[#1148]: https://github.com/CLIUtils/CLI11/pull/1148
+[#1150]: https://github.com/CLIUtils/CLI11/pull/1150
+[#1152]: https://github.com/CLIUtils/CLI11/pull/1152
+[#1155]: https://github.com/CLIUtils/CLI11/pull/1155
+[#1158]: https://github.com/CLIUtils/CLI11/pull/1158
+[#1160]: https://github.com/CLIUtils/CLI11/pull/1160
+[#1161]: https://github.com/CLIUtils/CLI11/pull/1161
+[#1162]: https://github.com/CLIUtils/CLI11/pull/1162
+[#1164]: https://github.com/CLIUtils/CLI11/pull/1164
+[#1167]: https://github.com/CLIUtils/CLI11/pull/1167
+[#1170]: https://github.com/CLIUtils/CLI11/pull/1170
+[#1172]: https://github.com/CLIUtils/CLI11/pull/1172
+[#1173]: https://github.com/CLIUtils/CLI11/pull/1173
+[#1178]: https://github.com/CLIUtils/CLI11/pull/1178
+[#1180]: https://github.com/CLIUtils/CLI11/pull/1180
+[#1181]: https://github.com/CLIUtils/CLI11/pull/1181
+[#1182]: https://github.com/CLIUtils/CLI11/pull/1182
+[#1185]: https://github.com/CLIUtils/CLI11/pull/1185
+[#1186]: https://github.com/CLIUtils/CLI11/pull/1186
+[#1187]: https://github.com/CLIUtils/CLI11/pull/1187
+[#1192]: https://github.com/CLIUtils/CLI11/pull/1192
+[#1196]: https://github.com/CLIUtils/CLI11/pull/1196
+[#1199]: https://github.com/CLIUtils/CLI11/pull/1199
+[#1203]: https://github.com/CLIUtils/CLI11/pull/1203
+[#1206]: https://github.com/CLIUtils/CLI11/pull/1206
+[#1218]: https://github.com/CLIUtils/CLI11/pull/1218
+[#1225]: https://github.com/CLIUtils/CLI11/pull/1225
+[#1226]: https://github.com/CLIUtils/CLI11/pull/1226
+[#1229]: https://github.com/CLIUtils/CLI11/pull/1229
+
 ## Version 2.5: Help Formatter
 
-This version add a new formatter with improved control capabilities and output
-aligned with standards for help output. It also add a modifier to enable use of
-non-standard option names. Along with several bug fixes for edge cases in string
+This version adds a new formatter with improved control capabilities and output
+aligned with standards for help output. It also adds a modifier to enable use of
+non-standard option names, along with several bug fixes for edge cases in string
 and config file parsing.
 
-- Better help formatter [#866][], this better aligns the help generation with
-  UNIX standard and allows use in help2man. [#1093][]
-- Add mechanism to allow option groups to be hidden and all options be
+- Improved help formatter [#866][], better aligns help generation with UNIX
+  standards and allows use in help2man. [#1093][]
+- Added mechanism to allow option groups to be hidden and all options to be
   considered part of the parent for help display [#1039][]
-- Add a modifier to allow non-standard single flag option names such as
+- Added a modifier to allow non-standard single flag option names such as
   `-option`. [#1078][]
-- Add modifier for subcommands to disable fallthrough which can resolve some
+- Added modifier for subcommands to disable fallthrough, which can resolve some
   issues with positional arguments [#1073][]
-- Add some polish to config file output removing some unnecessary output and add
+- Added polish to config file output, removing unnecessary output and adding
   modifier to control output of default values [#1075][]
-- Add the ability to specify pair/tuple defaults and improved parsing [#1081][]
+- Added ability to specify pair/tuple defaults and improved parsing [#1081][]
 - Bugfix: Take the configurability of an option name into account when
   determining naming conflicts [#1049][]
-- Bugfix: Fix an issue where an extra subcommand header was being printed in the
-  output [#1058][]
-- Bugfix: Add additional fuzzing tests and fixes for a bug in escape string
-  processing, and resolve inconsistencies in the handing of `{}` between command
-  line parsing and config file parsing. [#1060][]
-- Bugfix: Improve handling of some ambiguities in vector input processing for
-  config files, specifically in the case of vector of vector inputs. [#1069][]
-- Bugfix: Fix an issue in the handling of uint8_t enums, and some issues related
-  to single element tuples [#1087][]
-- Bugfix: Fix an issue with binary strings containing a `\x` [#1097][]
-- Bugfix: Move the help generation priority so it triggers before config file
+- Bugfix: Fixed an issue where an extra subcommand header was being printed in
+  the output [#1058][]
+- Bugfix: Added additional fuzzing tests and fixes for a bug in escape string
+  processing, and resolved inconsistencies in the handling of `{}` between
+  command line parsing and config file parsing. [#1060][]
+- Bugfix: Improved handling of ambiguities in vector input processing for config
+  files, specifically in the case of vector of vector inputs. [#1069][]
+- Bugfix: Fixed an issue in the handling of uint8_t enums, and issues related to
+  single element tuples [#1087][]
+- Bugfix: Fixed an issue with binary strings containing a `\x` [#1097][]
+- Bugfix: Moved the help generation priority so it triggers before config file
   processing [#1106][]
 - Bugfix: Fixed an issue where max/min on positionals was not being respected
   and optional positionals were being ignored [#1108][]
-- Bugfix: Fix an issue with strings which started and ended with brackets being
-  misinterpreted as vectors. The parsing now has special handling of strings
+- Bugfix: Fixed an issue with strings which started and ended with brackets
+  being misinterpreted as vectors. Parsing now has special handling of strings
   which start with `[[` [#1110][]
-- Bugfix: Fix some macros for support in C++26 related to wide string parsing
+- Bugfix: Fixed some macros for support in C++26 related to wide string parsing
   [#1113][]
-- Bugfix: Allow trailing spaces on numeric string conversions [#1115][]
-- Docs: Update pymod.find_installation to find python in meson.build [#1076][]
-- Docs: Add example for transform validators [#689][]
-- Docs: Fix several spelling mistakes [#1101][]
-- Backend: Update copyright dates to 2025 [#1112][]
-- Backend: Update CMAKE minimum version to 3.10 [#1084][]
+- Bugfix: Allowed trailing spaces on numeric string conversions [#1115][]
+- Docs: Updated pymod.find_installation to find Python in meson.build [#1076][]
+- Docs: Added example for transform validators [#689][]
+- Docs: Fixed several spelling mistakes [#1101][]
+- Backend: Updated copyright dates to 2025 [#1112][]
+- Backend: Updated CMAKE minimum version to 3.10 [#1084][]
 
 [#1039]: https://github.com/CLIUtils/CLI11/pull/1039
 [#1049]: https://github.com/CLIUtils/CLI11/pull/1049
@@ -79,6 +192,11 @@ strings, digit separators, string escape sequences,and dot notation. An initial
 round of a fuzzer was added to testing which has caught several bugs related to
 config file processing, and a few other edge cases not previously observed.
 
+NOTE: The fuzzer fixes have had some previously unrecognized changes to allowed
+positional names. Positional names with spaces are no longer allowed. This was
+not explicitly allowed but not disallowed either, and now it is no longer
+allowed as these options may be called in config file parsing.
+
 - Add Unicode support and bug fixes [#804][], [#923][], [#876][], [#848][],
   [#832][], [#987][]
 - Match TOML standard for string and numerical entries, multiline strings

LICENSE

@@ -1,4 +1,4 @@
-CLI11 2.5 Copyright (c) 2017-2025 University of Cincinnati, developed by Henry
+CLI11 2.6 Copyright (c) 2017-2025 University of Cincinnati, developed by Henry
 Schreiner under NSF AWARD 1414736. All rights reserved.
 
 Redistribution and use in source and binary forms of CLI11, with or without

README.md

@@ -40,13 +40,12 @@ set with a simple and intuitive interface.
       - [Default Validators](#default-validators)
       - [Validators that may be disabled 🚧](#validators-that-may-be-disabled-)
       - [Extra Validators 🚧](#extra-validators-)
-  - [permission. Requires C++17.](#permission-requires-c17)
-    - [Validator Usage](#validator-usage)
-      - [Transforming Validators](#transforming-validators)
-      - [Validator operations](#validator-operations)
-      - [Custom Validators](#custom-validators)
-      - [Querying Validators](#querying-validators)
-    - [Getting results](#getting-results)
+      - [Validator Usage](#validator-usage)
+        - [Transforming Validators](#transforming-validators)
+        - [Validator operations](#validator-operations)
+        - [Custom Validators](#custom-validators)
+        - [Querying Validators](#querying-validators)
+      - [Getting results](#getting-results)
     - [Subcommands](#subcommands)
       - [Subcommand options](#subcommand-options)
       - [Callbacks](#callbacks)
@@ -167,11 +166,14 @@ this library:
   incomplete arguments. It's better not to guess. Most third party command line
   parsers for python actually reimplement command line parsing rather than using
   argparse because of this perceived design flaw (recent versions do have an
-  option to disable it).
+  option to disable it). 🆕 The latest version of CLI11 does include partial
+  option matching for option prefixes. This is enabled by
+  `.allow_subcommand_prefix_matching()`, along with an example that generates
+  suggested close matches.
 - Autocomplete: This might eventually be added to both Plumbum and CLI11, but it
   is not supported yet.
 - While not recommended, CLI11 does now support non standard option names such
-  as `-option`. 🆕. This is enabled through `allow_non_standard_option_names()`
+  as `-option`. This is enabled through `allow_non_standard_option_names()`
   modifier on an app.
 
 ## Install
@@ -503,7 +505,7 @@ Before parsing, you can set the following options:
   validation checks for the option to be executed when the option value is
   parsed vs. at the end of all parsing. This could cause the callback to be
   executed multiple times. Also works with positional options.
-- `->callback_priority(CallbackPriority priority)`: 🚧 changes the order in
+- `->callback_priority(CallbackPriority priority)`: 🆕 changes the order in
   which the option callback is executed. Four principal callback call-points are
   available. `CallbackPriority::First` executes at the very beginning of
   processing, before configuration files are read and environment variables are
@@ -669,7 +671,6 @@ setting `CLI11_ENABLE_EXTRA_VALIDATORS` to 1
   write permission. Requires C++17.
 - `CLI::ExecPermission`: Requires that the file given exist and have execution
   permission. Requires C++17.
-  -
 
 #### Validator Usage
 
@@ -988,15 +989,15 @@ option_groups. These are:
   the form of `/s /long /file:file_name.ext` This option does not change how
   options are specified in the `add_option` calls or the ability to process
   options in the form of `-s --long --file=file_name.ext`.
-- `.allow_non_standard_option_names()`:🆕 Allow specification of single `-` long
+- `.allow_non_standard_option_names()`: Allow specification of single `-` long
   form option names. This is not recommended but is available to enable
   reworking of existing interfaces. If this modifier is enabled on an app or
   subcommand, options or flags can be specified like normal but instead of
   throwing an exception, long form single dash option names will be allowed. It
   is not allowed to have a single character short option starting with the same
   character as a single dash long form name; for example, `-s` and `-single` are
   not allowed in the same application.
-- `.allow_subcommand_prefix_matching()`:🚧 If this modifier is enabled,
+- `.allow_subcommand_prefix_matching()`:🆕 If this modifier is enabled,
   unambiguious prefix portions of a subcommand will match. For example
   `upgrade_package` would match on `upgrade_`, `upg`, `u` as long as no other
   subcommand would also match. It also disallows subcommand names that are full
@@ -1005,8 +1006,8 @@ option_groups. These are:
   through" and be matched on a parent option. Subcommands by default are allowed
   to "fall through" as in they will first attempt to match on the current
   subcommand and if they fail will progressively check parents for matching
-  subcommands. This can be disabled through `subcommand_fallthrough(false)` 🆕.
-- `.subcommand_fallthrough()`: 🆕 Allow subcommands to "fall through" and be
+  subcommands. This can be disabled through `subcommand_fallthrough(false)`.
+- `.subcommand_fallthrough()`: Allow subcommands to "fall through" and be
   matched on a parent option. Disabling this prevents additional subcommands at
   the same level from being matched. It can be useful in certain circumstances
   where there might be ambiguity between subcommands and positionals. The

include/CLI/Version.hpp

@@ -11,8 +11,8 @@
 // [CLI11:version_hpp:verbatim]
 
 #define CLI11_VERSION_MAJOR 2
-#define CLI11_VERSION_MINOR 5
+#define CLI11_VERSION_MINOR 6
 #define CLI11_VERSION_PATCH 0
-#define CLI11_VERSION "2.5.0"
+#define CLI11_VERSION "2.6.0"
 
 // [CLI11:version_hpp:end]

include/CLI/impl/Formatter_inl.hpp

@@ -177,7 +177,7 @@ CLI11_INLINE std::string Formatter::make_help(const App *app, std::string name,
     if(is_footer_paragraph_formatting_enabled()) {
         detail::streamOutAsParagraph(out, footer_string, footer_paragraph_width_);  // Format footer as paragraph
     } else {
-        out << footer_string << '\n';
+        out << footer_string;
     }
 
     return out.str();