rem - brk|doc - Removed WelcomeMessage from public...

... API --- The class itself is not removed, but we've removed it from the public API. This is because it's not meant to be open to the public and is called early. --- Type: rem Breaking: True Doc Required: True Backport Required: False Part: 1/1
Aptivi · Dec 26, 2024 · a23951c · a23951c
1 parent d472195
commit a23951c
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 43 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -23,7 +23,7 @@
           changes!
         -->
         <NitrocidModAPIVersionMajor>3.0.27</NitrocidModAPIVersionMajor>
-        <NitrocidModAPIVersionChangeset>16</NitrocidModAPIVersionChangeset>
+        <NitrocidModAPIVersionChangeset>17</NitrocidModAPIVersionChangeset>
 
         <!-- The above two properties are to be installed to the file version -->
         <NitrocidModAPIVersion>$(NitrocidModAPIVersionMajor).$(NitrocidModAPIVersionChangeset)</NitrocidModAPIVersion>

diff --git a/public/Nitrocid.Addons/Nitrocid.Extras.Tips/TipsInit.cs b/public/Nitrocid.Addons/Nitrocid.Extras.Tips/TipsInit.cs
@@ -24,7 +24,7 @@
 using System;
 using System.Collections.ObjectModel;
 using System.Reflection;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
+using Nitrocid.Kernel.Starting;
 
 namespace Nitrocid.Extras.Tips
 {

diff --git a/public/Nitrocid.Templates/templates/KSMod/ModName.cs b/public/Nitrocid.Templates/templates/KSMod/ModName.cs
@@ -10,7 +10,7 @@ public class ModName : IMod
         public string Name { get; set; } = "My Mod";
         public string Version { get; set; } = "1.0.0";
 
-        public Version MinimumSupportedApiVersion => new(3, 0, 27, 15);
+        public Version MinimumSupportedApiVersion => new(3, 0, 27, 17);
 
         public ReadOnlyDictionary<string, Delegate> PubliclyAvailableFunctions => null;
 

diff --git a/public/Nitrocid/Kernel/Configuration/Instances/KernelMainConfig.cs b/public/Nitrocid/Kernel/Configuration/Instances/KernelMainConfig.cs
@@ -43,7 +43,6 @@
 using Nitrocid.Files.Operations.Querying;
 using Nitrocid.Kernel.Debugging.RemoteDebug.RemoteChat;
 using Nitrocid.Kernel.Time.Timezones;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
 using Nitrocid.Network.Types.RPC;
 using Nitrocid.Network;
 using Terminaux.Inputs.Styles.Selection;
@@ -54,6 +53,7 @@
 using Terminaux.Inputs;
 using Nitrocid.Users.Login.Widgets;
 using Nitrocid.Users.Login.Widgets.Implementations;
+using Nitrocid.Kernel.Starting;
 
 namespace Nitrocid.Kernel.Configuration.Instances
 {

diff --git a/public/Nitrocid/Kernel/KernelEntry.cs b/public/Nitrocid/Kernel/KernelEntry.cs
@@ -33,7 +33,6 @@
 using Nitrocid.ConsoleBase.Colors;
 using Terminaux.Writer.ConsoleWriters;
 using Nitrocid.Kernel.Power;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
 using Terminaux.Base.Checks;
 using Nitrocid.Users.Login.Motd;
 using Nitrocid.Kernel.Configuration;

diff --git a/public/Nitrocid/Kernel/Starting/KernelInitializers.cs b/public/Nitrocid/Kernel/Starting/KernelInitializers.cs
@@ -52,7 +52,6 @@
 using Nitrocid.Kernel.Power;
 using Nitrocid.Kernel.Threading.Watchdog;
 using Terminaux.Colors;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
 using Terminaux.Base.Checks;
 using Nitrocid.Users.Login.Motd;
 using Nitrocid.Network.Types.RPC;

diff --git a/public/Nitrocid/Kernel/Starting/KernelStageActions.cs b/public/Nitrocid/Kernel/Starting/KernelStageActions.cs
@@ -28,7 +28,6 @@
 using Nitrocid.Modifications;
 using Nitrocid.Users;
 using Nitrocid.Users.Groups;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
 using Nitrocid.Network.Types.RPC;
 using Nitrocid.Kernel.Starting.Bootloader.Apps;
 using Nitrocid.Kernel.Starting.Bootloader;

diff --git a/public/Nitrocid/Kernel/Starting/KernelStageTools.cs b/public/Nitrocid/Kernel/Starting/KernelStageTools.cs
@@ -70,11 +70,6 @@ internal static void RunKernelStage(int stageNum)
                 ReportNewStage(stageNum, "");
         }
 
-        /// <summary>
-        /// Reports the new kernel stage
-        /// </summary>
-        /// <param name="StageNumber">The stage number</param>
-        /// <param name="StageText">The stage text</param>
         internal static void ReportNewStage(int StageNumber, string StageText)
         {
             // Show the stage finish times

diff --git a/...ase/Writers/MiscWriters/WelcomeMessage.cs → ...itrocid/Kernel/Starting/WelcomeMessage.cs b/...ase/Writers/MiscWriters/WelcomeMessage.cs → ...itrocid/Kernel/Starting/WelcomeMessage.cs
@@ -22,7 +22,6 @@
 using Terminaux.Inputs.Styles.Infobox;
 using Terminaux.Writer.ConsoleWriters;
 using Nitrocid.Drivers.RNG;
-using Nitrocid.Kernel;
 using Nitrocid.Kernel.Configuration;
 using Nitrocid.Languages;
 using Nitrocid.Misc.Text.Probers.Placeholder;
@@ -31,27 +30,18 @@
 using Terminaux.Inputs;
 using System;
 using Terminaux.Inputs.Styles;
+using Nitrocid.ConsoleBase.Writers;
 
-namespace Nitrocid.ConsoleBase.Writers.MiscWriters
+namespace Nitrocid.Kernel.Starting
 {
-    /// <summary>
-    /// Welcome message writer
-    /// </summary>
-    public static class WelcomeMessage
+    internal static class WelcomeMessage
     {
-
         internal static string customBanner = "";
         internal static string[] tips = [];
 
-        /// <summary>
-        /// Show tips on log-in
-        /// </summary>
-        public static bool ShowTip { get; internal set; }
+        internal static bool ShowTip { get; set; }
 
-        /// <summary>
-        /// Gets the custom banner actual text with placeholders parsed
-        /// </summary>
-        public static string GetCustomBanner()
+        internal static string GetCustomBanner()
         {
             // The default message to write
             string MessageWrite = "     --> " + Translate.DoTranslation("Welcome to Nitrocid Kernel! - Version") + " v{0} <--     ";
@@ -64,10 +54,7 @@ public static string GetCustomBanner()
             return MessageWrite;
         }
 
-        /// <summary>
-        /// Writes the welcoming message to the console (welcome to kernel)
-        /// </summary>
-        public static void WriteMessage()
+        internal static void WriteMessage()
         {
             if (!Config.MainConfig.EnableSplash)
             {
@@ -88,20 +75,13 @@ public static void WriteMessage()
             }
         }
 
-        /// <summary>
-        /// Writes the license
-        /// </summary>
-        public static void WriteLicense()
+        internal static void WriteLicense()
         {
             TextFancyWriters.WriteSeparator(Translate.DoTranslation("License information"), KernelColorType.Stage);
             TextWriters.Write(GetLicenseString(), true, KernelColorType.License);
         }
 
-        /// <summary>
-        /// Gets the license string
-        /// </summary>
-        /// <returns></returns>
-        public static string GetLicenseString() =>
+        internal static string GetLicenseString() =>
             $"""
             {Translate.DoTranslation("This program is licensed under GNU General Public License 3.0 or later.")}
 
@@ -212,6 +192,5 @@ internal static void ShowRandomTip()
             TextWriters.Write(
                 "* " + Translate.DoTranslation("Pro tip: Did you know") + " " + GetRandomTip(), true, KernelColorType.Tip);
         }
-
     }
 }
diff --git a/public/Nitrocid/Shell/ShellBase/Shells/Unified/Tip.cs b/public/Nitrocid/Shell/ShellBase/Shells/Unified/Tip.cs
@@ -21,7 +21,7 @@
 using Nitrocid.ConsoleBase.Writers;
 using Nitrocid.Languages;
 using Nitrocid.Shell.ShellBase.Commands;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
+using Nitrocid.Kernel.Starting;
 
 namespace Nitrocid.Shell.ShellBase.Shells.Unified
 {

diff --git a/public/Nitrocid/Shell/Shells/UESH/Commands/License.cs b/public/Nitrocid/Shell/Shells/UESH/Commands/License.cs
@@ -18,7 +18,7 @@
 //
 
 using Nitrocid.Shell.ShellBase.Commands;
-using Nitrocid.ConsoleBase.Writers.MiscWriters;
+using Nitrocid.Kernel.Starting;
 
 namespace Nitrocid.Shell.Shells.UESH.Commands
 {