Bump version

.github/workflows/build_and_test.yml

@@ -9,17 +9,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
-        submodules: recursive
+        fetch-depth: 0
     
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         dotnet-version: |
-            6.0.x
             8.0.x
             9.0.x
+            10.0.x
         
     - name: Run tests
       run: dotnet test
@@ -27,8 +27,16 @@ jobs:
     - name: Run publish script
       run: ./publish-nix.sh
 
+    - name: Update rolling tag
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+        git tag -f rolling
+        git push origin :refs/tags/rolling || true
+        git push origin rolling --force
+
     - name: Upload to rolling
-      uses: ncipollo/release-action@v1.14.0
+      uses: ncipollo/release-action@v1.20.0
       with:
         allowUpdates: True
         artifacts: "*.nupkg,*.snupkg"

.github/workflows/check_pr.yml

@@ -6,15 +6,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         dotnet-version: |
-            6.0.x
             8.0.x
             9.0.x
+            10.0.x
       
     - name: Build
       run: dotnet build

SabreTools.CommandLine.Test/CommandSetTests.cs

@@ -13,9 +13,16 @@ namespace SabreTools.CommandLine.Test
             var input1 = new FlagInput("input1", "--input1", "input1");
             var input2 = new FlagInput("input2", "--input2", "input2");
 
+            var feature1 = new MockFeature("feature1", "feature1", "feature1");
+            var inputA = new FlagInput("inputA", "--inputA", "inputA");
+            var inputB = new FlagInput("inputB", "--inputB", "inputB");
+            feature1.Add(inputA);
+            feature1.Add(inputB);
+
             var featureSet = new CommandSet();
             featureSet.Add(input1);
             featureSet.Add(input2);
+            featureSet.AddFrom(feature1);
 
             var actualInput1 = featureSet["input1"];
             Assert.NotNull(actualInput1);
@@ -27,6 +34,14 @@ namespace SabreTools.CommandLine.Test
 
             var actualInput3 = featureSet["input3"];
             Assert.Null(actualInput3);
+
+            var actualInputA = featureSet["inputA"];
+            Assert.NotNull(actualInputA);
+            Assert.Equal("inputA", actualInputA.Name);
+
+            var actualinputB = featureSet["inputB"];
+            Assert.NotNull(actualinputB);
+            Assert.Equal("inputB", actualinputB.Name);
         }
 
         [Fact]
@@ -764,7 +779,7 @@ namespace SabreTools.CommandLine.Test
         [Fact]
         public void ProcessArgs_EmptyArgs_Success()
         {
-            CommandSet commandSet = new CommandSet();
+            var commandSet = new CommandSet();
 
             string[] args = [];
 
@@ -775,7 +790,7 @@ namespace SabreTools.CommandLine.Test
         [Fact]
         public void ProcessArgs_ValidArgs_Success()
         {
-            CommandSet commandSet = new CommandSet();
+            var commandSet = new CommandSet();
             Feature feature = new MockFeature("a", "a", "a");
             feature.Add(new FlagInput("b", "b", "b"));
             feature.Add(new FlagInput("c", "c", "c"));
@@ -791,7 +806,7 @@ namespace SabreTools.CommandLine.Test
         [Fact]
         public void ProcessArgs_InvalidArg_AddedAsGeneric()
         {
-            CommandSet commandSet = new CommandSet();
+            var commandSet = new CommandSet();
             Feature feature = new MockFeature("a", "a", "a");
             feature.Add(new FlagInput("b", "b", "b"));
             feature.Add(new FlagInput("d", "d", "d"));
@@ -808,7 +823,7 @@ namespace SabreTools.CommandLine.Test
         [Fact]
         public void ProcessArgs_NestedArgs_Success()
         {
-            CommandSet commandSet = new CommandSet();
+            var commandSet = new CommandSet();
             Feature feature = new MockFeature("a", "a", "a");
             var sub = new FlagInput("b", "b", "b");
             sub.Add(new FlagInput("c", "c", "c"));

SabreTools.CommandLine.Test/SabreTools.CommandLine.Test.csproj

@@ -1,7 +1,7 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
         <IsPackable>false</IsPackable>
         <LangVersion>latest</LangVersion>
         <Nullable>enable</Nullable>
@@ -16,7 +16,7 @@
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
         <PackageReference Include="xunit" Version="2.9.3" />
         <PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

SabreTools.CommandLine/CommandSet.cs

@@ -40,6 +40,41 @@ namespace SabreTools.CommandLine
 
         #endregion
 
+        #region Properties
+
+        /// <summary>
+        /// Custom help text to print instead of the automatically
+        /// generated generic help
+        /// </summary>
+        /// <remarks>
+        /// This only replaces the automatically generated help
+        /// for <see cref="OutputGenericHelp"/>. It does not impact
+        /// either <see cref="OutputAllHelp"/> or <see cref="OutputFeatureHelp"/>.
+        /// </remarks>
+        public string? CustomHelp { get; set; }
+
+        /// <summary>
+        /// Feature that represents the default functionality
+        /// for a command set
+        /// </summary>
+        /// <remarks>
+        /// It is recommended to use this in applications that
+        /// do not need multiple distinct functional modes.
+        ///
+        /// When printing help text, the flags and description
+        /// of this feature will be omitted, instead printing
+        /// the children of the feature directly at the
+        /// top level.
+        ///
+        /// If the default feature is included as a normal
+        /// top-level input for the command set, then the flags
+        /// will be printed twice - once under the feature
+        /// itself and once at the top level.
+        /// </remarks>
+        public Feature? DefaultFeature { get; set; }
+
+        #endregion
+
         #region Constructors
 
         /// <summary>
@@ -120,6 +155,29 @@ namespace SabreTools.CommandLine
         public void Add(UserInput input)
             => _inputs.Add(input.Name, input);
 
+        /// <summary>
+        /// Add all children from an input to the set
+        /// </summary>
+        /// <param name="input">UserInput object to retrieve children from</param>
+        /// <remarks>
+        /// This should only be used in situations where an input is defined
+        /// but not used within the context of the command set directly.
+        ///
+        /// This is helpful for when there are applications with default functionality
+        /// that need to be able to expose both defined features as well as
+        /// the default functionality in help text.
+        ///
+        /// If there is any overlap between existing names and the names from
+        /// any of the children, this operation will overwrite them.
+        /// </reamrks>
+        public void AddFrom(UserInput input)
+        {
+            foreach (var kvp in input.Children)
+            {
+                _inputs.Add(kvp.Key, kvp.Value);
+            }
+        }
+
         #endregion
 
         #region Children
@@ -730,13 +788,34 @@ namespace SabreTools.CommandLine
             if (_header.Count > 0)
                 output.AddRange(_header);
 
-            // Now append all available top-level flags
-            output.Add("Available options:");
-            foreach (var input in _inputs.Values)
+            // If custom help text is defined
+            if (CustomHelp != null)
             {
-                var outputs = input.Format(pre: 2, midpoint: 30, detailed);
-                if (outputs != null)
-                    output.AddRange(outputs);
+                string customHelp = CustomHelp.Replace("\r\n", "\n");
+                string[] customLines = customHelp.Split('\n');
+                output.AddRange(customLines);
+            }
+            else
+            {
+                // Append all available top-level flags
+                output.Add("Available options:");
+                foreach (var input in _inputs.Values)
+                {
+                    var outputs = input.Format(pre: 2, midpoint: 30, detailed);
+                    if (outputs != null)
+                        output.AddRange(outputs);
+                }
+
+                // If there is a default feature
+                if (DefaultFeature != null)
+                {
+                    foreach (var input in DefaultFeature.Children)
+                    {
+                        var outputs = input.Value.Format(pre: 2, midpoint: 30, detailed);
+                        if (outputs != null)
+                            output.AddRange(outputs);
+                    }
+                }
             }
 
             // Append the footer, if needed
@@ -760,7 +839,7 @@ namespace SabreTools.CommandLine
             if (_header.Count > 0)
                 output.AddRange(_header);
 
-            // Now append all available flags recursively
+            // Append all available flags recursively
             output.Add("Available options:");
             foreach (var input in _inputs.Values)
             {
@@ -769,6 +848,17 @@ namespace SabreTools.CommandLine
                     output.AddRange(outputs);
             }
 
+            // If there is a default feature
+            if (DefaultFeature != null)
+            {
+                foreach (var input in DefaultFeature.Children)
+                {
+                    var outputs = input.Value.Format(pre: 2, midpoint: 30, detailed);
+                    if (outputs != null)
+                        output.AddRange(outputs);
+                }
+            }
+
             // Append the footer, if needed
             if (_footer.Count > 0)
                 output.AddRange(_footer);
@@ -891,7 +981,7 @@ namespace SabreTools.CommandLine
             // If there's no arguments, show help
             if (args.Length == 0)
             {
-                OutputGenericHelp();
+                OutputAllHelp();
                 return true;
             }
 

SabreTools.CommandLine/Inputs/BooleanInput.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="bool"/> 
+    /// Represents a user input bounded to the range of <see cref="bool"/>
     /// </summary>
     public class BooleanInput : UserInput<bool?>
     {

SabreTools.CommandLine/Inputs/Int16Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="short"/> 
+    /// Represents a user input bounded to the range of <see cref="short"/>
     /// </summary>
     public class Int16Input : UserInput<short?>
     {

SabreTools.CommandLine/Inputs/Int32Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="int"/> 
+    /// Represents a user input bounded to the range of <see cref="int"/>
     /// </summary>
     public class Int32Input : UserInput<int?>
     {

SabreTools.CommandLine/Inputs/Int64Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="long"/> 
+    /// Represents a user input bounded to the range of <see cref="long"/>
     /// </summary>
     public class Int64Input : UserInput<long?>
     {

SabreTools.CommandLine/Inputs/Int8Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="sbyte"/> 
+    /// Represents a user input bounded to the range of <see cref="sbyte"/>
     /// </summary>
     public class Int8Input : UserInput<sbyte?>
     {

SabreTools.CommandLine/Inputs/UInt16Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="ushort"/> 
+    /// Represents a user input bounded to the range of <see cref="ushort"/>
     /// </summary>
     public class UInt16Input : UserInput<ushort?>
     {

SabreTools.CommandLine/Inputs/UInt32Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="uint"/> 
+    /// Represents a user input bounded to the range of <see cref="uint"/>
     /// </summary>
     public class UInt32Input : UserInput<uint?>
     {

SabreTools.CommandLine/Inputs/UInt64Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="ulong"/> 
+    /// Represents a user input bounded to the range of <see cref="ulong"/>
     /// </summary>
     public class UInt64Input : UserInput<ulong?>
     {

SabreTools.CommandLine/Inputs/UInt8Input.cs

@@ -3,7 +3,7 @@ using System.Text;
 namespace SabreTools.CommandLine.Inputs
 {
     /// <summary>
-    /// Represents a user input bounded to the range of <see cref="byte"/> 
+    /// Represents a user input bounded to the range of <see cref="byte"/>
     /// </summary>
     public class UInt8Input : UserInput<byte?>
     {

SabreTools.CommandLine/Inputs/UserInput.cs

@@ -41,7 +41,7 @@ namespace SabreTools.CommandLine.Inputs
         /// <summary>
         /// Set of children associated with this input
         /// </summary>
-        protected readonly Dictionary<string, UserInput> Children = [];
+        internal protected readonly Dictionary<string, UserInput> Children = [];
 
         #endregion
 
@@ -86,7 +86,7 @@ namespace SabreTools.CommandLine.Inputs
         /// </summary>
         public UserInput? this[UserInput subfeature]
         {
-           get
+            get
             {
                 if (!Children.TryGetValue(subfeature.Name, out var input))
                     return null;

SabreTools.CommandLine/SabreTools.CommandLine.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <!-- Assembly Properties -->
-        <TargetFrameworks>net20;net35;net40;net452;net462;net472;net48;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+        <TargetFrameworks>net20;net35;net40;net452;net462;net472;net48;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0;net10.0;netstandard2.0;netstandard2.1</TargetFrameworks>
         <CheckEolTargetFramework>false</CheckEolTargetFramework>
         <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
         <IncludeSymbols>true</IncludeSymbols>
@@ -11,7 +11,7 @@
         <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-        <Version>1.3.2</Version>
+        <Version>1.4.0</Version>
 
         <!-- Package Properties -->
         <Authors>Matt Nadareski</Authors>

publish-nix.sh

@@ -1,7 +1,7 @@
 #! /bin/bash
 
 # This batch file assumes the following:
-# - .NET 9.0 (or newer) SDK is installed and in PATH
+# - .NET 10.0 (or newer) SDK is installed and in PATH
 #
 # If any of these are not satisfied, the operation may fail
 # in an unpredictable way and result in an incomplete output.

publish-win.ps1

@@ -1,5 +1,5 @@
 # This batch file assumes the following:
-# - .NET 9.0 (or newer) SDK is installed and in PATH
+# - .NET 10.0 (or newer) SDK is installed and in PATH
 #
 # If any of these are not satisfied, the operation may fail
 # in an unpredictable way and result in an incomplete output.