refactor!: Rename config file to workspace file

Author: tony

docs/api.md

@@ -70,7 +70,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ### Finding
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.is_config_file
+.. automethod:: tmuxp.config.is_workspace_file
 ```
 
 ```{eval-rst}

docs/configuration/index.md

@@ -105,7 +105,7 @@ Breaking down the basic configuration into sections:
 You can create a configuration and load it from anywhere in your file system.
 
 ```console
-$ tmuxp load [config_file]
+$ tmuxp load [workspace-file]
 ```
 
 ````{tab} Relative

src/tmuxp/cli/__init__.py

@@ -147,17 +147,17 @@ def cli(_args: t.Optional[t.List[str]] = None) -> None:
             return
         elif import_subparser_name == "teamocil":
             command_import_teamocil(
-                config_file=args.config_file,
+                workspace_file=args.workspace_file,
                 parser=parser,
             )
         elif import_subparser_name == "tmuxinator":
             command_import_tmuxinator(
-                config_file=args.config_file,
+                workspace_file=args.workspace_file,
                 parser=parser,
             )
     elif args.subparser_name == "convert":
         command_convert(
-            config_file=args.config_file,
+            workspace_file=args.workspace_file,
             answer_yes=args.answer_yes,
             parser=parser,
         )
@@ -166,7 +166,7 @@ def cli(_args: t.Optional[t.List[str]] = None) -> None:
 
     elif args.subparser_name == "edit":
         command_edit(
-            config_file=args.config_file,
+            workspace_file=args.workspace_file,
             parser=parser,
         )
     elif args.subparser_name == "freeze":

src/tmuxp/cli/convert.py

@@ -11,16 +11,16 @@
 def create_convert_subparser(
     parser: argparse.ArgumentParser,
 ) -> argparse.ArgumentParser:
-    config_file = parser.add_argument(
-        dest="config_file",
+    workspace_file = parser.add_argument(
+        dest="workspace_file",
         type=str,
         metavar="config-file",
         help="checks tmuxp and current directory for config files.",
     )
     try:
         import shtab
 
-        config_file.complete = shtab.FILE  # type: ignore
+        workspace_file.complete = shtab.FILE  # type: ignore
     except ImportError:
         pass
 
@@ -35,17 +35,17 @@ def create_convert_subparser(
 
 
 def command_convert(
-    config_file: t.Union[str, pathlib.Path],
+    workspace_file: t.Union[str, pathlib.Path],
     answer_yes: bool,
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
     """Convert a tmuxp config between JSON and YAML."""
-    config_file = scan_config(config_file, config_dir=get_config_dir())
+    workspace_file = scan_config(workspace_file, config_dir=get_config_dir())
 
-    if isinstance(config_file, str):
-        config_file = pathlib.Path(config_file)
+    if isinstance(workspace_file, str):
+        workspace_file = pathlib.Path(workspace_file)
 
-    _, ext = os.path.splitext(config_file)
+    _, ext = os.path.splitext(workspace_file)
     ext = ext.lower()
     if ext == ".json":
         to_filetype = "yaml"
@@ -54,14 +54,14 @@ def command_convert(
     else:
         raise Exception(f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])")
 
-    configparser = ConfigReader.from_file(config_file)
-    newfile = config_file.parent / (str(config_file.stem) + f".{to_filetype}")
+    configparser = ConfigReader.from_file(workspace_file)
+    newfile = workspace_file.parent / (str(workspace_file.stem) + f".{to_filetype}")
 
     export_kwargs = {"default_flow_style": False} if to_filetype == "yaml" else {}
     new_config = configparser.dump(format=to_filetype, indent=2, **export_kwargs)
 
     if not answer_yes:
-        if prompt_yes_no(f"Convert to <{config_file}> to {to_filetype}?"):
+        if prompt_yes_no(f"Convert to <{workspace_file}> to {to_filetype}?"):
             if prompt_yes_no("Save config to %s?" % newfile):
                 answer_yes = True
 

src/tmuxp/cli/edit.py

@@ -11,19 +11,19 @@ def create_edit_subparser(
     parser: argparse.ArgumentParser,
 ) -> argparse.ArgumentParser:
     parser.add_argument(
-        dest="config_file",
-        metavar="config-file",
+        dest="workspace_file",
+        metavar="workspace-file",
         type=str,
         help="checks current tmuxp and current directory for config files.",
     )
     return parser
 
 
 def command_edit(
-    config_file: t.Union[str, pathlib.Path],
+    workspace_file: t.Union[str, pathlib.Path],
     parser: t.Optional[argparse.ArgumentParser] = None,
 ):
-    config_file = scan_config(config_file)
+    workspace_file = scan_config(workspace_file)
 
     sys_editor = os.environ.get("EDITOR", "vim")
-    subprocess.call([sys_editor, config_file])
+    subprocess.call([sys_editor, workspace_file])

src/tmuxp/cli/import_config.py

@@ -55,7 +55,7 @@ def _resolve_path_no_overwrite(config: str) -> str:
 
 
 def command_import(
-    config_file: str,
+    workspace_file: str,
     print_list: str,
     parser: argparse.ArgumentParser,
 ):
@@ -74,8 +74,8 @@ def create_import_subparser(
     )
 
     import_teamocilgroup = import_teamocil.add_mutually_exclusive_group(required=True)
-    teamocil_config_file = import_teamocilgroup.add_argument(
-        dest="config_file",
+    teamocil_workspace_file = import_teamocilgroup.add_argument(
+        dest="workspace_file",
         type=str,
         nargs="?",
         metavar="config-file",
@@ -92,8 +92,8 @@ def create_import_subparser(
     import_tmuxinatorgroup = import_tmuxinator.add_mutually_exclusive_group(
         required=True
     )
-    tmuxinator_config_file = import_tmuxinatorgroup.add_argument(
-        dest="config_file",
+    tmuxinator_workspace_file = import_tmuxinatorgroup.add_argument(
+        dest="workspace_file",
         type=str,
         nargs="?",
         metavar="config-file",
@@ -107,20 +107,20 @@ def create_import_subparser(
     try:
         import shtab
 
-        teamocil_config_file.complete = shtab.FILE  # type: ignore
-        tmuxinator_config_file.complete = shtab.FILE  # type: ignore
+        teamocil_workspace_file.complete = shtab.FILE  # type: ignore
+        tmuxinator_workspace_file.complete = shtab.FILE  # type: ignore
     except ImportError:
         pass
 
     return parser
 
 
 def import_config(
-    config_file: str,
+    workspace_file: str,
     importfunc: t.Callable,
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
-    existing_config = ConfigReader._from_file(pathlib.Path(config_file))
+    existing_config = ConfigReader._from_file(pathlib.Path(workspace_file))
     cfg_reader = ConfigReader(importfunc(existing_config))
 
     config_format = prompt_choices(
@@ -167,21 +167,21 @@ def import_config(
 
 
 def command_import_tmuxinator(
-    config_file: str,
+    workspace_file: str,
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
-    """Convert a tmuxinator config from config_file to tmuxp format and import
+    """Convert a tmuxinator config from workspace_file to tmuxp format and import
     it into tmuxp."""
-    config_file = scan_config(config_file, config_dir=get_tmuxinator_dir())
-    import_config(config_file, config.import_tmuxinator)
+    workspace_file = scan_config(workspace_file, config_dir=get_tmuxinator_dir())
+    import_config(workspace_file, config.import_tmuxinator)
 
 
 def command_import_teamocil(
-    config_file: str,
+    workspace_file: str,
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
-    """Convert a teamocil config from config_file to tmuxp format and import
+    """Convert a teamocil config from workspace_file to tmuxp format and import
     it into tmuxp."""
-    config_file = scan_config(config_file, config_dir=get_teamocil_dir())
+    workspace_file = scan_config(workspace_file, config_dir=get_teamocil_dir())
 
-    import_config(config_file, config.import_teamocil)
+    import_config(workspace_file, config.import_teamocil)

src/tmuxp/cli/load.py

@@ -40,7 +40,7 @@ class OptionOverrides(TypedDict):
 
 
 class CLILoadNamespace(argparse.Namespace):
-    config_files: t.List[str]
+    workspace_files: t.List[str]
     socket_name: t.Optional[str]
     socket_path: t.Optional[str]
     tmux_config_file: t.Optional[str]
@@ -256,7 +256,7 @@ def _setup_plugins(builder: WorkspaceBuilder) -> Session:
 
 
 def load_workspace(
-    config_file: StrPath,
+    workspace_file: StrPath,
     socket_name: t.Optional[str] = None,
     socket_path: None = None,
     tmux_config_file: None = None,
@@ -271,7 +271,7 @@ def load_workspace(
 
     Parameters
     ----------
-    config_file : list of str
+    workspace_file : list of str
         paths or session names to workspace files
     socket_name : str, optional
         ``tmux -L <socket-name>``
@@ -361,18 +361,19 @@ def load_workspace(
        Accessed April 8th, 2018.
     """
     # get the canonical path, eliminating any symlinks
-    if isinstance(config_file, (str, os.PathLike)):
-        config_file = pathlib.Path(config_file)
+    if isinstance(workspace_file, (str, os.PathLike)):
+        workspace_file = pathlib.Path(workspace_file)
 
     tmuxp_echo(
-        style("[Loading] ", fg="green") + style(str(config_file), fg="blue", bold=True)
+        style("[Loading] ", fg="green")
+        + style(str(workspace_file), fg="blue", bold=True)
     )
 
     # ConfigReader allows us to open a yaml or json file as a dict
-    raw_config = config_reader.ConfigReader._from_file(config_file) or {}
+    raw_config = config_reader.ConfigReader._from_file(workspace_file) or {}
 
     # shapes configurations relative to config / profile file location
-    sconfig = config.expand(raw_config, cwd=os.path.dirname(config_file))
+    sconfig = config.expand(raw_config, cwd=os.path.dirname(workspace_file))
     # Overwrite session name
     if new_session_name:
         sconfig["session_name"] = new_session_name
@@ -382,7 +383,7 @@ def load_workspace(
     t = Server(  # create tmux server object
         socket_name=socket_name,
         socket_path=socket_path,
-        config_file=tmux_config_file,
+        workspace_file=tmux_config_file,
         colors=colors,
     )
 
@@ -393,7 +394,7 @@ def load_workspace(
             sconf=sconfig, plugins=load_plugins(sconfig), server=t
         )
     except exc.EmptyConfigException:
-        tmuxp_echo("%s is empty or parsed no config data" % config_file)
+        tmuxp_echo("%s is empty or parsed no config data" % workspace_file)
         return None
 
     session_name = sconfig["session_name"]
@@ -468,7 +469,7 @@ def load_workspace(
     return _setup_plugins(builder)
 
 
-def config_file_completion(ctx, params, incomplete):
+def workspace_file_completion(ctx, params, incomplete):
     config_dir = pathlib.Path(get_config_dir())
     choices: t.List[pathlib.Path] = []
 
@@ -491,8 +492,8 @@ def config_file_completion(ctx, params, incomplete):
 
 
 def create_load_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
-    config_files = parser.add_argument(
-        "config_files",
+    workspace_files = parser.add_argument(
+        "workspace_files",
         nargs="+",
         metavar="config-file",
         help="filepath to session or filename of session if in tmuxp config directory",
@@ -574,7 +575,7 @@ def create_load_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentP
     try:
         import shtab
 
-        config_files.complete = shtab.FILE  # type: ignore
+        workspace_files.complete = shtab.FILE  # type: ignore
         tmux_config_file.complete = shtab.FILE  # type: ignore
         log_file.complete = shtab.FILE  # type: ignore
     except ImportError:
@@ -629,19 +630,19 @@ def command_load(
         "append": args.append,
     }
 
-    if args.config_files is None or len(args.config_files) == 0:
+    if args.workspace_files is None or len(args.workspace_files) == 0:
         tmuxp_echo("Enter at least one config")
         if parser is not None:
             parser.print_help()
         sys.exit()
         return
 
-    last_idx = len(args.config_files) - 1
+    last_idx = len(args.workspace_files) - 1
     original_detached_option = tmux_options.pop("detached")
     original_new_session_name = tmux_options.pop("new_session_name")
 
-    for idx, config_file in enumerate(args.config_files):
-        config_file = scan_config(config_file, config_dir=get_config_dir())
+    for idx, workspace_file in enumerate(args.workspace_files):
+        workspace_file = scan_config(workspace_file, config_dir=get_config_dir())
 
         detached = original_detached_option
         new_session_name = original_new_session_name
@@ -651,7 +652,7 @@ def command_load(
             new_session_name = None
 
         load_workspace(
-            config_file,
+            workspace_file,
             detached=detached,
             new_session_name=new_session_name,
             **tmux_options,

src/tmuxp/config.py

@@ -45,7 +45,7 @@ def validate_schema(session_config):
     return True
 
 
-def is_config_file(filename, extensions=[".yml", ".yaml", ".json"]):
+def is_workspace_file(filename, extensions=[".yml", ".yaml", ".json"]):
     """
     Return True if file has a valid config file type.
 
@@ -84,7 +84,7 @@ def in_dir(
     configs = []
 
     for filename in os.listdir(config_dir):
-        if is_config_file(filename, extensions) and not filename.startswith("."):
+        if is_workspace_file(filename, extensions) and not filename.startswith("."):
             configs.append(filename)
 
     return configs
@@ -109,7 +109,7 @@ def in_cwd():
     configs = []
 
     for filename in os.listdir(os.getcwd()):
-        if filename.startswith(".tmuxp") and is_config_file(filename):
+        if filename.startswith(".tmuxp") and is_workspace_file(filename):
             configs.append(filename)
 
     return configs

tests/fixtures/config/expand2.py

@@ -4,10 +4,10 @@
 
 
 def unexpanded_yaml():
-    return test_utils.read_config_file("config/expand2-unexpanded.yaml")
+    return test_utils.read_workspace_file("config/expand2-unexpanded.yaml")
 
 
 def expanded_yaml():
-    return test_utils.read_config_file("config/expand2-expanded.yaml").format(
+    return test_utils.read_workspace_file("config/expand2-expanded.yaml").format(
         HOME=os.path.expanduser("~")
     )