Implement exec.env-vars

#156

AeroSpace.xcodeproj/project.pbxproj

@@ -26,6 +26,7 @@
  2E691C1E3F03B82F8507A435 /* MoveCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1376845BAB666880919B9AA2 /* MoveCommand.swift */; };
  374CE35B85B941B8F584C113 /* FlattenWorkspaceTreeCommandTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 53FDECECC773EBA30661EB8A /* FlattenWorkspaceTreeCommandTest.swift */; };
  3774857EF024E97B7AA5DE78 /* MoveNodeToWorkspaceCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 25AC44D0E9450867215FCBEC /* MoveNodeToWorkspaceCommand.swift */; };
+ 391D591299E4A22F97B686C3 /* parseExecEnvVariables.swift in Sources */ = {isa = PBXBuildFile; fileRef = FBA02146387061665D22C8A9 /* parseExecEnvVariables.swift */; };
  3AFD7EE961B97F38C0914A0C /* ListWorkspacesCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9E6478C499F3FB86C017D7BB /* ListWorkspacesCommand.swift */; };
  3BD6FF4CC51532977DA0C05A /* AeroAny.swift in Sources */ = {isa = PBXBuildFile; fileRef = 82476B9BEBAC00EB9E32256F /* AeroAny.swift */; };
  42197B9C71A0CDDE65804A6A /* accessibility.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9D31BF26EAFA96F675D2C14B /* accessibility.swift */; };
@@ -52,6 +53,7 @@
  6E4E235FDA41307B19F16182 /* ModeCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B0CD3C2A0E86CDB9DF312AB /* ModeCommand.swift */; };
  70A82A4A9DFC89286C4F7696 /* TilingContainer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 00ECDFE176777828D560A737 /* TilingContainer.swift */; };
  74ED0272EF2A3BA6387FD413 /* Rect.swift in Sources */ = {isa = PBXBuildFile; fileRef = AAE5DD3E9DC82D247853956B /* Rect.swift */; };
+ 7705C2DE11B01DD85ACA6429 /* ParseEnvVariablesTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = E5E3423F92314ECE96A30260 /* ParseEnvVariablesTest.swift */; };
  77FA83225024151CD556E1ED /* CloseAllWindowsButCurrentCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 99853C505D93E41F6531C324 /* CloseAllWindowsButCurrentCommand.swift */; };
  78622D72C0CCE8D69B080D29 /* moveWithMouse.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD0938DE74E687A8959E3F9C /* moveWithMouse.swift */; };
  78C38FAF21E574DBE3B88806 /* CloseCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = F8FDC079C530D7B3C568E35F /* CloseCommand.swift */; };
@@ -86,6 +88,7 @@
  BB3C35BE40958AE6E7B4A9FD /* TreeNodeTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD1645D9939F3F896EF21393 /* TreeNodeTest.swift */; };
  BC6511DA2ABE84164D90C181 /* ExecAndForgetCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 569422C0C4C23EF3E024C8E6 /* ExecAndForgetCommand.swift */; };
  BD6301B2CFC16FDE4223ACB8 /* MacApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7DB782C527ABE0CF31740EB /* MacApp.swift */; };
+ BEF31195CE844782E3BC7ECE /* ListExecEnvVarsCommand.swift in Sources */ = {isa = PBXBuildFile; fileRef = 85E575A5103802381C889062 /* ListExecEnvVarsCommand.swift */; };
  BF16873111EEDE60A8AACD6B /* Workspace.swift in Sources */ = {isa = PBXBuildFile; fileRef = C3F068BCC50ED846DCBFDE57 /* Workspace.swift */; };
  C76E421FB0D0F0EB1C93A06C /* Monitor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 739F4FE1DB101DF4E508F3FE /* Monitor.swift */; };
  C830FD347D7F9C06CF53103F /* Socket in Frameworks */ = {isa = PBXBuildFile; productRef = 998F8F4D88E65F73B0B2894D /* Socket */; };
@@ -172,6 +175,7 @@
  82476B9BEBAC00EB9E32256F /* AeroAny.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AeroAny.swift; sourceTree = "<group>"; };
  826EA316AB62F913D1A94466 /* FocusSourceOfTruth.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FocusSourceOfTruth.swift; sourceTree = "<group>"; };
  84AB57B5B8014931BD0F30DB /* AbstractApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AbstractApp.swift; sourceTree = "<group>"; };
+ 85E575A5103802381C889062 /* ListExecEnvVarsCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ListExecEnvVarsCommand.swift; sourceTree = "<group>"; };
  883D7F7F87FBE7D0BDE4E87F /* ArrayEx.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ArrayEx.swift; sourceTree = "<group>"; };
  8B7A2DF0D1F72B80B1F04240 /* BundleEx.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BundleEx.swift; sourceTree = "<group>"; };
  8FE45A887100EB70912B07F0 /* default-config.toml */ = {isa = PBXFileReference; path = "default-config.toml"; sourceTree = "<group>"; };
@@ -211,6 +215,7 @@
  D61FE8B343B068F0FFFC2373 /* focused.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = focused.swift; sourceTree = "<group>"; };
  DAC5AF4019D1F5DAB5AF2B56 /* layoutRecursive.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = layoutRecursive.swift; sourceTree = "<group>"; };
  DB8177AB37FF2FCA122C14AF /* testExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = testExtensions.swift; sourceTree = "<group>"; };
+ E5E3423F92314ECE96A30260 /* ParseEnvVariablesTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ParseEnvVariablesTest.swift; sourceTree = "<group>"; };
  E761155C73F06E2CF5E292A4 /* FocusCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FocusCommand.swift; sourceTree = "<group>"; };
  E9589EFDEBA4EB9C7DBAFCFD /* MoveNodeToWorkspaceCommandTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MoveNodeToWorkspaceCommandTest.swift; sourceTree = "<group>"; };
  E9FCB66B928701F68AD8CA78 /* ListWindowsCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ListWindowsCommand.swift; sourceTree = "<group>"; };
@@ -221,6 +226,7 @@
  F3C5B6719EF0BC14D7CF868C /* FlattenWorkspaceTreeCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FlattenWorkspaceTreeCommand.swift; sourceTree = "<group>"; };
  F77C03164B8BFD1E59779C6E /* testUtil.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = testUtil.swift; sourceTree = "<group>"; };
  F8FDC079C530D7B3C568E35F /* CloseCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CloseCommand.swift; sourceTree = "<group>"; };
+ FBA02146387061665D22C8A9 /* parseExecEnvVariables.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = parseExecEnvVariables.swift; sourceTree = "<group>"; };
  FD6BB613EC44C1B32CE4A47E /* ListMonitorsCommand.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ListMonitorsCommand.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -335,6 +341,7 @@
  69CB1289E3FA51A35F839238 /* HotkeyBinding.swift */,
  1C0D40CBD65704BA9595C2FA /* keysMap.swift */,
  67DBAF4ECF8A0B931FC34EAD /* parseConfig.swift */,
+ FBA02146387061665D22C8A9 /* parseExecEnvVariables.swift */,
  CCDFB9D7321F08B5CCEF6AFB /* parseGaps.swift */,
  64EBF5912CC4BBEC0E5E4B1C /* parseKeyMapping.swift */,
  0A9DFF8980BB3F90A3793BE9 /* parseOnWindowDetected.swift */,
@@ -366,6 +373,7 @@
  isa = PBXGroup;
  children = (
  54679FCD1EC1196B27E964D5 /* ConfigTest.swift */,
+ E5E3423F92314ECE96A30260 /* ParseEnvVariablesTest.swift */,
  );
  path = config;
  sourceTree = "<group>";
@@ -432,6 +440,7 @@
  9ECC990B6C2D66D343216A12 /* FullscreenCommand.swift */,
  D27A7AF7E9A049700BDE276B /* JoinWithCommand.swift */,
  1A2B673C67B00DBFCC27FFE7 /* LayoutCommand.swift */,
+ 85E575A5103802381C889062 /* ListExecEnvVarsCommand.swift */,
  BF3D87FF4D8238F07870F2F6 /* MacosNativeFullscreenCommand.swift */,
  7862747CF7F654B8BF8C9CF9 /* MacosNativeMinimizeCommand.swift */,
  4B0CD3C2A0E86CDB9DF312AB /* ModeCommand.swift */,
@@ -591,6 +600,7 @@
  423853C015185583E1F58E61 /* ListWorkspacesTest.swift in Sources */,
  6898172108196A4694FD6A42 /* MoveCommandTest.swift in Sources */,
  9305D5380C7A1D293F24FF41 /* MoveNodeToWorkspaceCommandTest.swift in Sources */,
+ 7705C2DE11B01DD85ACA6429 /* ParseEnvVariablesTest.swift in Sources */,
  22175400298B985658E774EE /* ResizeCommandTest.swift in Sources */,
  DCCC05496BDAAFB745E99624 /* SplitCommandTest.swift in Sources */,
  7ED8C2A66DD6F903796F090C /* TestApp.swift in Sources */,
@@ -630,6 +640,7 @@
  5DA2DA21600E8B5BCA3DCFC0 /* LayoutCommand.swift in Sources */,
  D12277DFEAAAC7AE19D0B629 /* LazySequenceProtocolEx.swift in Sources */,
  63D2357EADCF6137D630F7C5 /* ListAppsCommand.swift in Sources */,
+ BEF31195CE844782E3BC7ECE /* ListExecEnvVarsCommand.swift in Sources */,
  F69159A961FEE54847EC9A8D /* ListMonitorsCommand.swift in Sources */,
  B17CC799E7913F75451B55FD /* ListWindowsCommand.swift in Sources */,
  3AFD7EE961B97F38C0914A0C /* ListWorkspacesCommand.swift in Sources */,
@@ -674,6 +685,7 @@
  EB171FD9A347F000AC63B573 /* normalizeLayoutReason.swift in Sources */,
  4E0BC093AD1FBCCA718A26EC /* parseCommand.swift in Sources */,
  A0765C31043BCFB0420BF1C9 /* parseConfig.swift in Sources */,
+ 391D591299E4A22F97B686C3 /* parseExecEnvVariables.swift in Sources */,
  5BA537EABFE48178D6BD2544 /* parseGaps.swift in Sources */,
  4A11D06CCDAD05595AB67239 /* parseKeyMapping.swift in Sources */,
  21D0512B48E0E3C28F8CA42A /* parseOnWindowDetected.swift in Sources */,

LocalPackage/Sources/Cli/subcommandDescriptionsGenerated.swift

@@ -10,6 +10,7 @@ let subcommandDescriptions = [
  [" join-with", "Puts the currently focused window and the nearest node in the specified direction under a common parent container"],
  [" layout", "Changes layout of the focused window to the given layout"],
  [" list-apps", "Prints the list of running applications that appears in the Dock and may have a user interface"],
+ [" list-exec-env-vars", "List environment variables that `exec-*` commands and options are run with"],
  [" list-monitors", "Prints monitors that satisfy conditions"],
  [" list-windows", "Prints windows that satisfy conditions"],
  [" list-workspaces", "Prints workspaces that satisfy conditions"],

LocalPackage/Sources/Common/cmdArgs/ListExecEnvVarsCmdArgs.swift

@@ -0,0 +1,4 @@
+public struct ListExecEnvVarsCmdArgs: RawCmdArgs, CmdArgs {
+ public init() {}
+ public static let parser: CmdParser<Self> = noArgsParser(.listExecEnvVars, allowInConfig: true)
+}

LocalPackage/Sources/Common/cmdArgs/other/CmdKind.swift

@@ -10,6 +10,7 @@ public enum CmdKind: String, CaseIterable, Equatable {
  case joinWith = "join-with"
  case layout
  case listApps = "list-apps"
+ case listExecEnvVars = "list-exec-env-vars"
  case listMonitors = "list-monitors"
  case listWindows = "list-windows"
  case listWorkspaces = "list-workspaces"

LocalPackage/Sources/Common/cmdArgs/other/parseCmdArgs.swift

@@ -40,6 +40,8 @@ private func initSubcommands() -> [String: any SubCommandParserProtocol] {
  result[kind.rawValue] = SubCommandParser(parseLayoutCmdArgs)
  case .listApps:
  result[kind.rawValue] = defaultSubCommandParser(ListAppsCmdArgs())
+ case .listExecEnvVars:
+ result[kind.rawValue] = defaultSubCommandParser(ListExecEnvVarsCmdArgs())
  case .listMonitors:
  result[kind.rawValue] = defaultSubCommandParser(ListMonitorsCmdArgs())
  case .listWindows:

docs/aerospace-list-exec-env-vars.adoc

@@ -0,0 +1,29 @@
+= aerospace-list-exec-env-vars(1)
+include::util/man-attributes.adoc[]
+:manname: aerospace-list-exec-env-vars
+// tag::purpose[]
+:manpurpose: List environment variables that exec-* commands and options are run with
+// end::purpose[]
+
+== Synopsis
+// tag::synopsis[]
+aerospace list-exec-env-vars [-h|--help]
+// end::synopsis[]
+
+== Description
+
+// tag::body[]
+{manpurpose}
+
+Examples of commands and options:
+
+* _aerospace exec-and-forget_ command
+* _exec-on-workspace-change-callback_
+
+// end::body[]
+
+include::util/conditional-options-header.adoc[]
+
+-h, --help:: Print help
+
+include::util/man-footer.adoc[]

docs/commands.adoc

@@ -195,6 +195,13 @@ include::aerospace-list-apps.adoc[tags=synopsis]
 include::aerospace-list-apps.adoc[tags=purpose]
 include::aerospace-list-apps.adoc[tags=body]
 
+=== list-exec-env-vars
+----
+include::aerospace-list-exec-env-vars.adoc[tags=synopsis]
+----
+include::aerospace-list-exec-env-vars.adoc[tags=purpose]
+include::aerospace-list-exec-env-vars.adoc[tags=body]
+
 === list-monitors
 ----
 include::aerospace-list-monitors.adoc[tags=synopsis]

docs/config-examples/default-config.toml

@@ -40,7 +40,7 @@ default-root-container-orientation = 'auto'
 indent-for-nested-containers-with-the-same-orientation = 30
 
 # Possible values: (qwerty|dvorak)
-# See https://nikitabobko.github.io/AeroSpace/guide.html#key-mapping
+# See https://nikitabobko.github.io/AeroSpace/guide#key-mapping
 key-mapping.preset = 'qwerty'
 
 # Gaps between windows (inner-*) and between monitor edges (outer-*).
@@ -50,12 +50,19 @@ key-mapping.preset = 'qwerty'
 # In this example, 24 is a default value when there is no match.
 # Monitor pattern is the same as for 'workspace-to-monitor-force-assignment'.
 # See: https://nikitabobko.github.io/AeroSpace/guide#assign-workspaces-to-monitors
-gaps.inner.horizontal = 0
-gaps.inner.vertical = 0
-gaps.outer.left = 0
-gaps.outer.bottom = 0
-gaps.outer.top = 0
-gaps.outer.right = 0
+[gaps]
+inner.horizontal = 0
+inner.vertical = 0
+outer.left = 0
+outer.bottom = 0
+outer.top = 0
+outer.right = 0
+
+# See https://nikitabobko.github.io/AeroSpace/guide#exec-env-vars
+[exec]
+inherit-env-vars = true
+[exec.env-vars]
+PATH = '/opt/homebrew/bin:/opt/homebrew/sbin:${PATH}'
 
 # 'main' binding mode declaration
 # See: https://nikitabobko.github.io/AeroSpace/guide#binding-modes

docs/guide.adoc

@@ -108,6 +108,25 @@ key-mapping.preset = 'dvorak'
 * For `colemak` users, there is xref:goodness.adoc#colemak-keys-remap[a compiled mapping].
 `colemak` may be added as preconfigured preset similar to `dvorak` in the future, if there is enough demand
 
+[#exec-env-vars]
+=== exec-* Environment Variables
+
+You can configure environment variables of `exec-*` commands and options (such as xref:commands.adoc#exec-and-forget[exec-and-forget], <<exec-on-workspace-change-callback>>)
+
+* `exec.inherit-env-vars = true` configures whether inherit environment variables of `AeroSpace.app` or not. (The default is `true`)
+* You can override env variables with the following syntax:
++
+[source,toml]
+----
+[exec.env-vars]
+PATH = '${HOME}/bin:${PATH}'
+----
++
+Environment variable substitution is supported in form of `+${ENV_VAR}+`
+* If not overridden, `default-config.toml` adds Homebrew to `$PATH` `+/opt/homebrew/bin:/opt/homebrew/sbin:${PATH}+`.
+See the problem statement: https://docs.brew.sh/FAQ#my-mac-apps-dont-find-homebrew-utilities
+* You can inspect what is the end result of environment variables using xref:commands.adoc#list-exec-env-vars[`list-exec-env-vars` command]
+
 [#tree]
 == Tree
 
@@ -417,7 +436,7 @@ exec-on-workspace-change = ['/bin/bash', '-c',
 ]
 ----
 
-The process has access to the following environment variables:
+Besides the <<exec-env-vars,`exec.env-vars`>>, the process has access to the following environment variables:
 
 * `AEROSPACE_FOCUSED_WORKSPACE` - the workspace user switched to
 * `AEROSPACE_PREV_WORKSPACE` - the workspace user switched from
@@ -525,8 +544,3 @@ run = 'layout tiling'
 check-further-callbacks = true
 run = 'layout floating'
 ----
-
-=== Homebrew utilities in $PATH
-
-xref:commands.adoc#exec-and-forget[`exec-and-forget`] doesn't have Homebrew in its `$PATH` by default.
-See https://docs.brew.sh/FAQ#my-mac-apps-dont-find-homebrew-utilities

generate.sh

@@ -12,7 +12,7 @@ EOF
 
 entries() {
  for file in $(ls docs/aerospace-*.adoc); do
- if grep -q 'exec' <<< $file; then
+ if grep -q 'exec-and-forget' <<< $file; then
  continue
  fi
  subcommand=$(basename $file | sed 's/^aerospace-//' | sed 's/\.adoc$//')

src/command/ExecAndForgetCommand.swift

@@ -7,8 +7,11 @@ struct ExecAndForgetCommand: Command {
  // todo shall exec-and-forget fork exec session?
  check(Thread.current.isMainThread)
  // It doesn't throw if exit code is non-zero
- Result { try Process.run(URL(filePath: "/bin/bash"), arguments: ["-c", args.bashScript]) }
- .getOrThrow()
+ let process = Process()
+ process.environment = config.execConfig.envVariables
+ process.executableURL = URL(filePath: "/bin/bash")
+ process.arguments = ["-c", args.bashScript]
+ Result { try process.run() }.getOrThrow()
  return true
  }
 }

src/command/ListExecEnvVarsCommand.swift

@@ -0,0 +1,13 @@
+import Common
+
+struct ListExecEnvVarsCommand: Command {
+ let args: ListExecEnvVarsCmdArgs
+
+ func _run(_ state: CommandMutableState, stdin: String) -> Bool {
+ check(Thread.current.isMainThread)
+ for (key, value) in config.execConfig.envVariables {
+ state.stdout.append("\(key)=\(value)")
+ }
+ return true
+ }
+}

src/command/other/parseCommand.swift

@@ -31,6 +31,8 @@ extension CmdArgs {
  command = LayoutCommand(args: self as! LayoutCmdArgs)
  case .listApps:
  command = ListAppsCommand(args: self as! ListAppsCmdArgs)
+ case .listExecEnvVars:
+ command = ListExecEnvVarsCommand(args: self as! ListExecEnvVarsCmdArgs)
  case .listMonitors:
  command = ListMonitorsCommand(args: self as! ListMonitorsCmdArgs)
  case .listWindows:

src/config/Config.swift

@@ -2,7 +2,7 @@ import HotKey
 import Common
 
 let mainModeId = "main"
-let defaultConfig = initDefaultConfig(parseConfig(try! String(contentsOf: Bundle.main.url(forResource: "default-config", withExtension: "toml")!)))
+let defaultConfig: Config = initDefaultConfig(parseConfig(try! String(contentsOf: Bundle.main.url(forResource: "default-config", withExtension: "toml")!)))
 var config: Config = defaultConfig
 
 struct Config: Copyable {
@@ -18,6 +18,7 @@ struct Config: Copyable {
  var enableNormalizationOppositeOrientationForNestedContainers: Bool = true
  var execOnWorkspaceChange: [String] = []
  var keyMapping = KeyMapping()
+ var execConfig: ExecConfig = ExecConfig()
 
  var gaps: Gaps = .zero
  var workspaceToMonitorForceAssignment: [String: [MonitorDescription]] = [:]

src/config/parseConfig.swift

@@ -136,6 +136,7 @@ private let configParser: [String: any ParserProtocol<Config>] = [
  "start-at-login": Parser(\.startAtLogin, parseBool),
  "accordion-padding": Parser(\.accordionPadding, parseInt),
  "exec-on-workspace-change": Parser(\.execOnWorkspaceChange, parseExecOnWorkspaceChange),
+ "exec": Parser(\.execConfig, parseExecConfig),
 
  keyMappingConfigRootKey: Parser(\.keyMapping, skipParsing(Config().keyMapping)), // Parsed manually
  modeConfigRootKey: Parser(\.modes, skipParsing(Config().modes)), // Parsed manually