template: add instructions to the template command

Author: leecannon

src/Command.zig

@@ -83,12 +83,16 @@ fn printFullHelp(command: Command, io: IO, exe_path: []const u8) error{AlreadyHa
         if (result.output_name) try io.stdoutWriteAll(exe_path);
     }
 
-    if (command.extended_help) |extended_help| {
-        std.debug.assert(extended_help.len != 0); // non-null extended help should not be empty
-        std.debug.assert(extended_help[extended_help.len - 1] == '\n'); // extended help should end with a newline
+    if (!std.mem.eql(u8, command.name, "template")) {
+        if (command.extended_help) |extended_help| {
+            std.debug.assert(extended_help.len != 0); // non-null extended help should not be empty
+            std.debug.assert(extended_help[extended_help.len - 1] == '\n'); // extended help should end with a newline
 
-        try io.stdoutWriteByte('\n');
-        try io.stdoutWriteAll(extended_help);
+            try io.stdoutWriteByte('\n');
+            try io.stdoutWriteAll(extended_help);
+        }
+    } else {
+        std.debug.assert(command.extended_help.?.len == 0); // template has an extended help but it is empty
     }
 }
 
@@ -287,9 +291,11 @@ pub fn testHelp(command: Command, comptime include_shorthand: bool) !void {
             }
         }
 
-        if (command.extended_help) |extended_help| {
-            try sb.append(std.testing.allocator, '\n');
-            try sb.appendSlice(std.testing.allocator, extended_help);
+        if (!std.mem.eql(u8, command.name, "template")) { // template has an extended help but it is empty
+            if (command.extended_help) |extended_help| {
+                try sb.append(std.testing.allocator, '\n');
+                try sb.appendSlice(std.testing.allocator, extended_help);
+            }
         }
 
         break :blk try sb.toOwnedSlice(std.testing.allocator);

src/commands/template.zig

@@ -1,8 +1,16 @@
 // SPDX-License-Identifier: MIT
 // SPDX-FileCopyrightText: 2025 Lee Cannon <[email protected]>
 
+// STEPS TO CREATE A NEW COMMAND:
+//  - Copy this file and rename it to the name of the command
+//  - Search the new file for "CHANGE THIS" and update the code
+//  - Add the new command to `src/subcommands/listing.zig`
+//  - Implement the functionality
+//  - Add tests
+//  - PROFIT
+
 /// Is this command enabled for the current target?
-pub const enabled: bool = true; // USE `shared.target_os` TO DETERMINE IF THE COMMAND IS ENABLED FOR THE CURRENT TARGET
+pub const enabled: bool = true; // CHANGE THIS - USE `shared.target_os` TO DETERMINE IF THE COMMAND IS ENABLED FOR THE CURRENT TARGET
 
 pub const command: Command = .{
     .name = "template", // CHANGE THIS
@@ -19,7 +27,9 @@ pub const command: Command = .{
     \\
     ,
 
-    // ADD `.extended_help` IF EXAMPLES SHOULD BE DISPLAYED
+    .extended_help = // CHANGE THIS - ADD EXAMPLES OR DELETE THIS IF NO EXAMPLES ARE NEEDED
+    \\
+    ,
 
     .execute = impl.execute,
 };
@@ -42,7 +52,7 @@ const impl = struct {
         log.debug("options={}", .{options});
     }
 
-    const TemplateOptions = struct {
+    const TemplateOptions = struct { // CHANGE THIS - IF NO OPTIONS ARE NEEDED DELETE THIS
         pub fn format(
             options: TemplateOptions,
             comptime _: []const u8,
@@ -129,19 +139,19 @@ const impl = struct {
         };
     }
 
-    test "template no args" {
+    test "template no args" { // CHANGE THIS
         try command.testExecute(&.{}, .{});
     }
 
-    test "template help" {
+    test "template help" { // CHANGE THIS
         try command.testHelp(true);
     }
 
-    test "template version" {
+    test "template version" { // CHANGE THIS
         try command.testVersion();
     }
 
-    test "template fuzz" { // DELETE THIS IF THE COMMAND INTERACTS WITH THE SYSTEM
+    test "template fuzz" { // CHANGE THIS - DELETE THIS IF THE COMMAND INTERACTS WITH THE SYSTEM
         try command.testFuzz(.{});
     }
 };