LibTmux.Workspace.WorkspaceFile.Resolve

API reference · Markdown

LibTmux.Workspace.WorkspaceFile.Resolve ( baseDirectory : string , variables : IReadOnlyDictionary<string, string>? ) → WorkspaceFile

method [source] ¶

Resolves inherited pane directories against an explicit document base.

Description#

Resolves relative paths against the parent declaration's directory. Expansion accepts $NAME, ${NAME}, and a leading ~ using the supplied HOME variable; $$ produces a literal dollar sign. Session, window and pane option values expand supplied variables; unknown variables remain literal. Resolution reads neither the process environment nor the filesystem. The builder treats resolved directories as literal paths, including tmux format characters. Commands, the host script, names and environment values remain literal. Failures retain the original YAML or JSON value's line and column when the declaration was parsed.

Parameters

• baseDirectory ( string ) – The absolute directory containing the declaration.

• variables ( IReadOnlyDictionary<string, string>? ) – The only variables available to directory and option-value expansion.

Returns

A new declaration with absolute inherited directories and its document directory.

Raises

• ArgumentException – The document base is not absolute.

• WorkspaceFormatException – A directory or expansion is invalid.

Discussed in C# workspace builder behavior