refactor!: get_config_dir() -> get_workspace_dir()

Author: tony

conftest.py

@@ -15,7 +15,7 @@
 
 from libtmux.test import namer
 from tests.fixtures import utils as test_utils
-from tmuxp.cli.utils import get_config_dir
+from tmuxp.cli.utils import get_workspace_dir
 
 if t.TYPE_CHECKING:
     from libtmux.session import Session
@@ -56,7 +56,7 @@ def tmuxp_configdir_default(
     monkeypatch: pytest.MonkeyPatch, tmuxp_configdir: pathlib.Path
 ) -> None:
     monkeypatch.setenv("TMUXP_CONFIGDIR", str(tmuxp_configdir))
-    assert get_config_dir() == str(tmuxp_configdir)
+    assert get_workspace_dir() == str(tmuxp_configdir)
 
 
 @pytest.fixture(scope="function")

docs/api.md

@@ -46,7 +46,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ## CLI
 
 ```{eval-rst}
-.. automethod:: tmuxp.cli.utils.get_config_dir
+.. automethod:: tmuxp.cli.utils.get_workspace_dir
 ```
 
 ```{eval-rst}

src/tmuxp/cli/__init__.py

@@ -184,7 +184,7 @@ def startup(config_dir: pathlib.Path) -> None:
 
     Parameters
     ----------
-    str : get_config_dir(): Config directory to search
+    str : get_workspace_dir(): Config directory to search
     """
 
     if not os.path.exists(config_dir):

src/tmuxp/cli/convert.py

@@ -5,7 +5,7 @@
 
 from tmuxp.config_reader import ConfigReader
 
-from .utils import find_workspace_file, get_config_dir, prompt_yes_no
+from .utils import find_workspace_file, get_workspace_dir, prompt_yes_no
 
 
 def create_convert_subparser(
@@ -40,7 +40,9 @@ def command_convert(
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
     """Convert a tmuxp config between JSON and YAML."""
-    workspace_file = find_workspace_file(workspace_file, workspace_dir=get_config_dir())
+    workspace_file = find_workspace_file(
+        workspace_file, workspace_dir=get_workspace_dir()
+    )
 
     if isinstance(workspace_file, str):
         workspace_file = pathlib.Path(workspace_file)

src/tmuxp/cli/freeze.py

@@ -10,7 +10,7 @@
 
 from .. import util
 from ..workspace import freezer
-from .utils import get_config_dir, prompt, prompt_choices, prompt_yes_no
+from .utils import get_workspace_dir, prompt, prompt_choices, prompt_yes_no
 
 if t.TYPE_CHECKING:
     from typing_extensions import Literal, TypeAlias, TypeGuard
@@ -137,7 +137,7 @@ def command_freeze(
     while not dest:
         save_to = os.path.abspath(
             os.path.join(
-                get_config_dir(),
+                get_workspace_dir(),
                 "{}.{}".format(
                     sconf.get("session_name"), args.workspace_format or "yaml"
                 ),

src/tmuxp/cli/load.py

@@ -23,7 +23,7 @@
 from ..workspace.builder import WorkspaceBuilder
 from .utils import (
     find_workspace_file,
-    get_config_dir,
+    get_workspace_dir,
     prompt_choices,
     prompt_yes_no,
     style,
@@ -471,7 +471,7 @@ def load_workspace(
 
 
 def workspace_file_completion(ctx, params, incomplete):
-    config_dir = pathlib.Path(get_config_dir())
+    config_dir = pathlib.Path(get_workspace_dir())
     choices: t.List[pathlib.Path] = []
 
     # CWD Paths
@@ -644,7 +644,7 @@ def command_load(
 
     for idx, workspace_file in enumerate(args.workspace_files):
         workspace_file = find_workspace_file(
-            workspace_file, workspace_dir=get_config_dir()
+            workspace_file, workspace_dir=get_workspace_dir()
         )
 
         detached = original_detached_option

src/tmuxp/cli/ls.py

@@ -3,7 +3,7 @@
 import typing as t
 
 from .constants import VALID_WORKSPACE_DIR_FILE_EXTENSIONS
-from .utils import get_config_dir
+from .utils import get_workspace_dir
 
 
 def create_ls_subparser(
@@ -15,7 +15,7 @@ def create_ls_subparser(
 def command_ls(
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
-    tmuxp_dir = get_config_dir()
+    tmuxp_dir = get_workspace_dir()
     if os.path.exists(tmuxp_dir) and os.path.isdir(tmuxp_dir):
         for f in sorted(os.listdir(tmuxp_dir)):
             stem, ext = os.path.splitext(f)

src/tmuxp/cli/utils.py

@@ -32,7 +32,7 @@ def tmuxp_echo(
     print(message)
 
 
-def get_config_dir() -> str:
+def get_workspace_dir() -> str:
     """
     Return tmuxp configuration directory.
 
@@ -93,7 +93,7 @@ def find_workspace_file(
         - a period, .
     """
     if not workspace_dir:
-        workspace_dir = get_config_dir()
+        workspace_dir = get_workspace_dir()
     path = os.path
     exists, join, isabs = path.exists, path.join, path.isabs
     dirname, normpath, splitext = path.dirname, path.normpath, path.splitext

tests/test_cli.py

@@ -25,7 +25,7 @@
 )
 from tmuxp.cli.utils import (
     find_workspace_file,
-    get_config_dir,
+    get_workspace_dir,
     is_pure_name,
     tmuxp_echo,
 )
@@ -157,7 +157,7 @@ def test_tmuxp_configdir_env_var(
 ) -> None:
     monkeypatch.setenv("TMUXP_CONFIGDIR", str(tmp_path))
 
-    assert get_config_dir() == str(tmp_path)
+    assert get_workspace_dir() == str(tmp_path)
 
 
 def test_tmuxp_configdir_xdg_config_dir(
@@ -167,7 +167,7 @@ def test_tmuxp_configdir_xdg_config_dir(
     tmux_dir = tmp_path / "tmuxp"
     tmux_dir.mkdir()
 
-    assert get_config_dir() == str(tmux_dir)
+    assert get_workspace_dir() == str(tmux_dir)
 
 
 def test_resolve_dot(