Various bug fixes (#32)

✓ Fix `Systems.Immutable` cascading dependency issue
✓ Fix `clear-history` adding itself to history
✓ Fix extraneous warnings

Author: wallstop

CHANGELOG.md

@@ -1,45 +1,25 @@
-Changelog
-=========
+# Changelog
 
-## 1.02 `08a66da` - 2018-09-14
+All notable changes to this project will be documented in this file.
 
-### Added
-- Variables: defined with `set name value`, accessed with `$name`. Run `set` with no arguments to display all variables and their values.
-- Option to change the alpha value of the input background texture.
-- Command hint argument for better error messages. Use `RegisterCommand(Hint = "Command $a")]` to show a command's usage.
-
-### Changed
-- Better autocompletion: autocomplete can now partially complete words when there are multiple suggestions available.
-
-### Fixed
-- Fix background texture being destroyed when loading a scene with the Terminal set to `DontDestroyOnLoad`.
-- Fix hotkeys bound to function keys causing the input to not register the first character.
-- Fix formatting on autocomplete suggestions.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## 1.01 `9a1b0b3` - 2018-08-09
+## [1.0.0-rc25.0] - 2026-03-10
 
 ### Added
-- Option to to change the position of the toggle GUI buttons.
-- Option to change the window size ratio between the partial and full window height.
-- Optional GUI button to run a command (useful for mobile devices).
+
+- Per-command history opt-out: set `AddToHistory = false` on `RegisterCommandAttribute` to prevent a command from being recorded in history. Also available as the `addToHistory` parameter and field on `CommandInfo` and the `addToHistory` parameter on `CommandShell.AddCommand` (all defaulting to `true`).
+- `ReadOnlyHashSet<T>` and `ReadOnlyHashSetExtensions` (with `ToReadOnlyHashSet` extension method) in `WallstopStudios.DxCommandTerminal.DataStructures`.
 
 ### Changed
-- Autocomplete now uses the last word in the input text, rather than just completing the first word.
 
-## 1.0  `db07b43` - 2018-07-15
+- `clear-history` command no longer records itself in command history.
+- `CommandShell.AutoRegisteredCommands` and `CommandShell.IgnoredCommands` changed type from `ImmutableHashSet<string>` to `ReadOnlyHashSet<string>`.
 
-### Added
-- Customizable toggle hotkey.
-- Two new terminal colors (customizable).
-- Option to change prompt character (or remove it).
-- Option to open a larger terminal window with a separate hotkey.
-- Command autocompletion (use the tab key while typing a command).
-- Option to toggle window using GUI buttons (disabled by default).
-- Option to customize the input background contrast.
+### Removed
+
+- Bundled `System.Collections.Immutable.dll` has been removed; projects that already reference `System.Collections.Immutable` (e.g. via NuGet or another package) will no longer experience DLL conflicts.
 
 ### Fixed
-- Input registering hotkey character when hotkey was pressed.
-- Inspector presentation.
 
-### Removed
-- `LS` command in favor of `HELP` with no arguments to list all registered commands.
+- Setting `ignoreDefaultCommands` to `true` on `TerminalUI` had no effect — built-in commands were still registered. Root cause: the `RegisterCommandAttribute` internal constructor was not propagating the `isDefault` parameter to the `Default` property.

Runtime/AssemblyInfo.cs

@@ -0,0 +1,4 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("WallstopStudios.DxCommandTerminal.Editor")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxCommandTerminal.Tests.Runtime")]

Runtime/AssemblyInfo.cs.meta

@@ -19,14 +19,19 @@ public sealed class RegisterCommandAttribute : Attribute
 
         public bool DevelopmentOnly { get; set; }
 
+        public bool AddToHistory { get; set; } = true;
+
         public RegisterCommandAttribute(string commandName = null)
         {
             commandName = commandName?.Replace(" ", string.Empty).Trim();
             Name = commandName;
         }
 
         internal RegisterCommandAttribute(bool isDefault)
-            : this(string.Empty) { }
+            : this(string.Empty)
+        {
+            Default = isDefault;
+        }
 
         public void NormalizeName(MethodInfo method)
         {

Runtime/Attributes/RegisterCommandAttribute.cs

@@ -267,7 +267,8 @@ public static void CommandClearConsole(CommandArg[] args)
             isDefault: true,
             Name = "clear-history",
             Help = "Clear the command console's history",
-            MaxArgCount = 0
+            MaxArgCount = 0,
+            AddToHistory = false
         )]
         public static void CommandClearHistory(CommandArg[] args)
         {

Runtime/CommandTerminal/Backend/BuiltinCommands.cs

@@ -9,6 +9,8 @@ public sealed class CommandHistory
     {
         public int Capacity => _history.Capacity;
 
+        public int Count => _history.Count;
+
         private readonly CyclicBuffer<(string text, bool? success, bool? errorFree)> _history;
 
         private int _position;

Runtime/CommandTerminal/Backend/CommandHistory.cs

@@ -9,20 +9,23 @@ public readonly struct CommandInfo
         public readonly int maxArgCount;
         public readonly string help;
         public readonly string hint;
+        public readonly bool addToHistory;
 
         public CommandInfo(
             Action<CommandArg[]> proc,
             int minArgCount,
             int maxArgCount,
             string help,
-            string hint
+            string hint,
+            bool addToHistory = true
         )
         {
             this.proc = proc;
             this.maxArgCount = maxArgCount;
             this.minArgCount = minArgCount;
             this.help = help;
             this.hint = hint;
+            this.addToHistory = addToHistory;
         }
     }
 }

Runtime/CommandTerminal/Backend/CommandInfo.cs

@@ -2,11 +2,11 @@ namespace WallstopStudios.DxCommandTerminal.Backend
 {
     using System;
     using System.Collections.Generic;
-    using System.Collections.Immutable;
     using System.Linq;
     using System.Reflection;
     using System.Text;
     using Attributes;
+    using DataStructures;
     using UnityEngine;
 
     public sealed class CommandShell
@@ -117,11 +117,11 @@ public CommandShell(CommandHistory history)
         public IReadOnlyDictionary<string, CommandInfo> Commands => _commands;
         public IReadOnlyDictionary<string, CommandArg> Variables => _variables;
 
-        public ImmutableHashSet<string> AutoRegisteredCommands { get; private set; } =
-            ImmutableHashSet<string>.Empty;
+        public ReadOnlyHashSet<string> AutoRegisteredCommands { get; private set; } =
+            ReadOnlyHashSet<string>.Empty;
 
-        public ImmutableHashSet<string> IgnoredCommands { get; private set; } =
-            ImmutableHashSet<string>.Empty;
+        public ReadOnlyHashSet<string> IgnoredCommands { get; private set; } =
+            ReadOnlyHashSet<string>.Empty;
 
         public bool IgnoringDefaultCommands { get; private set; }
 
@@ -168,7 +168,7 @@ public int ClearAutoRegisteredCommands()
             }
 
             _autoRegisteredCommands.Clear();
-            AutoRegisteredCommands = ImmutableHashSet<string>.Empty;
+            AutoRegisteredCommands = ReadOnlyHashSet<string>.Empty;
             return count;
         }
 
@@ -186,7 +186,7 @@ public void InitializeAutoRegisteredCommands(
                 _commands.Remove(ignoredCommand);
             }
 
-            IgnoredCommands = _ignoredCommands.ToImmutableHashSet(StringComparer.OrdinalIgnoreCase);
+            IgnoredCommands = _ignoredCommands.ToReadOnlyHashSet(StringComparer.OrdinalIgnoreCase);
             _rejectedCommands.Clear();
 
             foreach (
@@ -234,15 +234,16 @@ public void InitializeAutoRegisteredCommands(
                     attribute.MinArgCount,
                     attribute.MaxArgCount,
                     attribute.Help,
-                    attribute.Hint
+                    attribute.Hint,
+                    attribute.AddToHistory
                 );
                 if (success)
                 {
                     _autoRegisteredCommands.Add(commandName);
                 }
             }
 
-            AutoRegisteredCommands = _autoRegisteredCommands.ToImmutableHashSet(
+            AutoRegisteredCommands = _autoRegisteredCommands.ToReadOnlyHashSet(
                 StringComparer.OrdinalIgnoreCase
             );
 
@@ -296,6 +297,7 @@ public bool RunCommand(string line)
 
             if (_arguments.Count == 0)
             {
+                // No command identified, unconditional push
                 _history.Push(line, false, true);
                 return false;
             }
@@ -360,6 +362,7 @@ public bool RunCommand(string commandName, CommandArg[] arguments)
             if (!_commands.TryGetValue(commandName, out CommandInfo command))
             {
                 IssueErrorMessage($"Command {commandName} not found");
+                // Unknown command, unconditional push
                 _history.Push(line, false, false);
                 return false;
             }
@@ -392,13 +395,21 @@ public bool RunCommand(string commandName, CommandArg[] arguments)
                 }
 
                 _errorMessages.Enqueue(invalidMessage);
-                _history.Push(line, false, false);
+                // Known command with invalid arguments, respect addToHistory flag
+                if (command.addToHistory)
+                {
+                    _history.Push(line, false, false);
+                }
                 return false;
             }
 
             int errorCount = _errorMessages.Count;
             command.proc?.Invoke(arguments);
-            _history.Push(line, true, errorCount == _errorMessages.Count);
+            // Known command executed, respect addToHistory flag
+            if (command.addToHistory)
+            {
+                _history.Push(line, true, errorCount == _errorMessages.Count);
+            }
             return true;
         }
 
@@ -432,10 +443,11 @@ public bool AddCommand(
             int minArgs = 0,
             int maxArgs = -1,
             string help = "",
-            string hint = null
+            string hint = null,
+            bool addToHistory = true
         )
         {
-            CommandInfo info = new(proc, minArgs, maxArgs, help, hint);
+            CommandInfo info = new(proc, minArgs, maxArgs, help, hint, addToHistory);
             return AddCommand(name, info);
         }
 

Runtime/CommandTerminal/Backend/CommandShell.cs

@@ -144,10 +144,11 @@ protected virtual void OnValidate()
 
         private void VerifyControlOrderIntegrity()
         {
-            if (!_controlOrder.ToHashSet().SetEquals(ControlTypes))
+            TerminalControlTypes[] missingControls = ControlTypes.Except(_controlOrder).ToArray();
+            if (missingControls.Length > 0)
             {
                 Debug.LogWarning(
-                    $"Control Order is missing the following controls: [{string.Join(", ", ControlTypes.Except(_controlOrder))}]. "
+                    $"Control Order is missing the following controls: [{string.Join(", ", missingControls)}]. "
                         + "Input for these will not be handled. Is this intentional?",
                     this
                 );

Runtime/CommandTerminal/Input/TerminalKeyboardController.cs

@@ -1,7 +1,3 @@
-using System.Runtime.CompilerServices;
-
-[assembly: InternalsVisibleTo("WallstopStudios.DxCommandTerminal.Editor")]
-
 namespace WallstopStudios.DxCommandTerminal.UI
 {
     using System;