tmuxp.workspace.finders.find_workspace_file

API reference · Markdown

tmuxp.workspace.finders.find_workspace_file ( workspace_file : StrPath , workspace_dir : StrPath | None = None ) → str

function [source] ¶

function [source] ¶

tmuxp.workspace.finders.find_workspace_file

Return the real config path or raise an exception.

If workspace file is directory, scan for .tmuxp.{yaml,yml,json} in directory. If one or more found, it will warn and pick the first.

If workspace file is ".", "./" or None, it will scan current directory.

If workspace file is has no path and only a filename, e.g. "my_workspace.yaml" it will search workspace dir.

If workspace file has no path and no extension, e.g. "my_workspace", it will scan for file name with yaml, yml and json. If multiple exist, it will warn and pick the first.

Parameters

• workspace_file ( StrPath ) – Workspace file, valid examples: - a file name, my_workspace.yaml - relative path, ../my_workspace.yaml or ../project - a period, .

Returns

str Resolved absolute path to workspace file.

Raises

• FileNotFoundError – If workspace file cannot be found.