feat: allow new list-modes commands

closes #1525
_fixes #1026

Author: MikaelCarpenter

Sources/AppBundle/command/impl/ListModesCommand.swift

@@ -6,11 +6,15 @@ struct ListModesCommand: Command {
     /*conforms*/ var shouldResetClosedWindowsCache = false
 
     func run(_ env: CmdEnv, _ io: CmdIo) -> Bool {
-        if args.current {
-            return io.out(activeMode ?? mainModeId)
-        } else {
-            let modeNames: [String] = config.modes.map { $0.key }
-            return io.out(modeNames)
+        let modes: [String] = args.current ? [activeMode ?? mainModeId] : config.modes.keys.sorted()
+        return switch () {
+            case _ where args.outputOnlyCount:
+                io.out("\(modes.count)")
+            case _ where args.json:
+                JSONEncoder.aeroSpaceDefault.encodeToString(modes.map { ["mode-id": $0] }).map(io.out)
+                    ?? io.err("Failed to encode JSON")
+            default:
+                io.out(modes)
         }
     }
 }

Sources/AppBundleTests/command/ListModesTest.swift

@@ -6,5 +6,55 @@ final class ListModesTest: XCTestCase {
     func testParseListModesCommand() {
         testParseCommandSucc("list-modes", ListModesCmdArgs(rawArgs: []))
         testParseCommandSucc("list-modes --current", ListModesCmdArgs(rawArgs: []).copy(\.current, true))
+        testParseCommandSucc("list-modes --json", ListModesCmdArgs(rawArgs: []).copy(\.json, true))
+        testParseCommandSucc("list-modes --count", ListModesCmdArgs(rawArgs: []).copy(\.outputOnlyCount, true))
+        testParseCommandSucc("list-modes --current --json", ListModesCmdArgs(rawArgs: []).copy(\.current, true).copy(\.json, true))
+    }
+
+    func testParseListModesCommandConflicts() {
+        assertEquals(parseCommand("list-modes --json --count").errorOrNil, "ERROR: Conflicting options: --count, --json")
+        assertEquals(parseCommand("list-modes --current --count").errorOrNil, "ERROR: Conflicting options: --count, --current")
+    }
+
+    @MainActor
+    func testListModesOutput() async throws {
+        config.modes = [
+            "main": Mode(name: nil, bindings: [:]),
+            "service": Mode(name: nil, bindings: [:]),
+            "resize": Mode(name: nil, bindings: [:]),
+        ]
+
+        let defaultResult = try await ListModesCommand(args: ListModesCmdArgs(rawArgs: [])).run(.defaultEnv, .emptyStdin)
+        assertEquals(defaultResult.exitCode, 0)
+        assertEquals(defaultResult.stdout, ["main", "resize", "service"])
+        assertEquals(defaultResult.stderr, [])
+
+        let currentResult = try await ListModesCommand(args: ListModesCmdArgs(rawArgs: []).copy(\.current, true)).run(.defaultEnv, .emptyStdin)
+        assertEquals(currentResult.exitCode, 0)
+        assertEquals(currentResult.stdout, ["main"])
+        assertEquals(currentResult.stderr, [])
+
+        let countResult = try await ListModesCommand(args: ListModesCmdArgs(rawArgs: []).copy(\.outputOnlyCount, true)).run(.defaultEnv, .emptyStdin)
+        assertEquals(countResult.exitCode, 0)
+        assertEquals(countResult.stdout, ["3"])
+        assertEquals(countResult.stderr, [])
+
+        let jsonResult = try await ListModesCommand(args: ListModesCmdArgs(rawArgs: []).copy(\.json, true)).run(.defaultEnv, .emptyStdin)
+        let expectedJson = JSONEncoder.aeroSpaceDefault.encodeToString([
+            ["mode-id": "main"],
+            ["mode-id": "resize"],
+            ["mode-id": "service"],
+        ])
+        assertEquals(jsonResult.exitCode, 0)
+        assertEquals(jsonResult.stdout, [expectedJson])
+        assertEquals(jsonResult.stderr, [])
+
+        let currentJsonResult = try await ListModesCommand(args: ListModesCmdArgs(rawArgs: []).copy(\.current, true).copy(\.json, true)).run(.defaultEnv, .emptyStdin)
+        let expectedCurrentJson = JSONEncoder.aeroSpaceDefault.encodeToString([
+            ["mode-id": "main"],
+        ])
+        assertEquals(currentJsonResult.exitCode, 0)
+        assertEquals(currentJsonResult.stdout, [expectedCurrentJson])
+        assertEquals(currentJsonResult.stderr, [])
     }
 }

Sources/Common/cmdArgs/impl/ListModesCmdArgs.swift

@@ -8,14 +8,22 @@ public struct ListModesCmdArgs: CmdArgs {
         allowInConfig: false,
         help: list_modes_help_generated,
         options: [
+            "--count": trueBoolFlag(\.outputOnlyCount),
             "--current": trueBoolFlag(\.current),
+            "--json": trueBoolFlag(\.json),
         ],
         arguments: [],
+        conflictingOptions: [
+            ["--count", "--current"],
+            ["--count", "--json"],
+        ],
     )
 
     /*conforms*/ public var windowId: UInt32?
     /*conforms*/ public var workspaceName: WorkspaceName?
     public var current: Bool = false
+    public var json: Bool = false
+    public var outputOnlyCount: Bool = false
 }
 
 public func parseListModesCmdArgs(_ args: [String]) -> ParsedCmd<ListModesCmdArgs> {

Sources/Common/cmdHelpGenerated.swift

@@ -67,7 +67,7 @@ let list_exec_env_vars_help_generated = """
     USAGE: list-exec-env-vars [-h|--help]
     """
 let list_modes_help_generated = """
-    USAGE: list-modes [-h|--help] [--current]
+    USAGE: list-modes [-h|--help] [--current] [--count] [--json]
     """
 let list_monitors_help_generated = """
     USAGE: list-monitors [-h|--help] [--focused [no]] [--mouse [no]] [--format <output-format>] [--count] [--json]

docs/aerospace-list-modes.adoc

@@ -9,7 +9,7 @@ include::util/man-attributes.adoc[]
 == Synopsis
 [verse]
 // tag::synopsis[]
-aerospace list-modes [-h|--help] [--current]
+aerospace list-modes [-h|--help] [--current] [--count] [--json]
 
 // end::synopsis[]
 
@@ -26,8 +26,14 @@ include::util/conditional-options-header.adoc[]
 
 -h, --help:: Print help
 
---current::
-Only print the currently active mode
+--current:: Only print the currently active mode.
+Incompatible with `--count`
+
+--count:: Output only the number of modes.
+Incompatible with `--current`, `--json`
+
+--json:: Output in JSON format.
+Incompatible with `--count`
 
 // end::body[]
 

grammar/commands-bnf-grammar.txt

@@ -91,7 +91,7 @@ aerospace -h;
 
     | list-exec-env-vars
 
-    | list-modes [--current]
+    | list-modes [--current|--json|--count]
 
     | list-monitors [--focused [no] | --mouse [no] | --format <output_format> | --count | --json]...