refactor!: More renaming of config to workspace · tmux-python/tmuxp@85c7412 · GitHub
Skip to content

Commit 85c7412

Browse files
committed
refactor!: More renaming of config to workspace
1 parent f93179d commit 85c7412

14 files changed

Lines changed: 29 additions & 25 deletions

File tree

‎docs/cli/freeze.md‎

Lines changed: 1 addition & 1 deletion

‎docs/cli/load.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ $ tmuxp load [filename]
8484

8585
## Inside sessions
8686

87-
If you try to load a config file from within a tmux session, it will ask you
87+
If you try to load a workspace file from within a tmux session, it will ask you
8888
if you want to load and attach to the new session, or just load detached.
89-
You can also load a config file and append the windows to the current active session.
89+
You can also load a workspace file and append the windows to the current active session.
9090

9191
```
9292
Already inside TMUX, switch to session? yes/no

‎docs/configuration/examples.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ Edit this page.
699699
- <https://github.com/tony/sphinxcontrib-github/blob/master/.tmuxp.yaml>
700700

701701
You can use `start_directory: ./` to make the directories relative to
702-
the config file / project root.
702+
the workspace file / project root.
703703

704704
## Bonus: pipenv auto-bootstrapping
705705

‎docs/configuration/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Configuration
66

7-
tmuxp loads your terminal workspace into tmux using config files.
7+
tmuxp loads your terminal workspace into tmux using workspace files.
88

99
The configuration file can be JSON or YAML. It's declarative style resembles tmux's object hierarchy: session, window and wanes.
1010

@@ -24,7 +24,7 @@ tmuxp will offers to assist when:
2424
- _When inside a tmux client_, `tmuxp` will let you create a new session and switch to it, or append the windows to your existing
2525
session.
2626

27-
## What's in a config file?
27+
## What's in a workspace file?
2828

2929
1. A session name
3030
2. A list of _windows_
@@ -98,7 +98,7 @@ Breaking down the basic configuration into sections:
9898
# command options
9999
```
100100

101-
## Where do I store config files?
101+
## Where do I store workspace files?
102102

103103
### Direct
104104

‎docs/configuration/top-level.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Used for:
1212

1313
Notes:
1414

15-
- Session names may differ from config filename.
15+
- Session names may differ from workspace filename.
1616

1717
e.g. _apple.yaml_:
1818

‎examples/start-directory.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@
5151
{
5252
"shell_command": [
5353
"echo '\\033c",
54-
"./ is relative to config file location",
55-
"../ will be parent of config file",
56-
"./test will be \\\"test\\\" dir inside dir of config file'"
54+
"./ is relative to workspace file location",
55+
"../ will be parent of workspace file",
56+
"./test will be \\\"test\\\" dir inside dir of workspace file'"
5757
]
5858
},
5959
{

‎examples/start-directory.yaml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,15 @@ windows:
2626
panes:
2727
- echo '\033c absolute paths also have precedence.'
2828
- echo hello
29-
- window_name: should be config's dir
29+
- window_name: should be workspace file's dir
30+
3031
start_directory: ./
3132
panes:
3233
- shell_command:
3334
- echo '\033c
34-
- ./ is relative to config file location
35-
- ../ will be parent of config file
36-
- ./test will be \"test\" dir inside dir of config file'
35+
- ./ is relative to workspace file location
36+
- ../ will be parent of workspace file
37+
- ./test will be \"test\" dir inside dir of workspace file'
3738
- shell_command:
3839
- echo '\033c
3940
- This way you can load up workspaces from projects and maintain

‎src/tmuxp/cli/convert.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def create_convert_subparser(
1515
dest="workspace_file",
1616
type=str,
1717
metavar="config-file",
18-
help="checks tmuxp and current directory for config files.",
18+
help="checks tmuxp and current directory for workspace files.",
1919
)
2020
try:
2121
import shtab

‎src/tmuxp/cli/edit.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ def create_edit_subparser(
1414
dest="workspace_file",
1515
metavar="workspace-file",
1616
type=str,
17-
help="checks current tmuxp and current directory for config files.",
17+
help="checks current tmuxp and current directory for workspace files.",
1818
)
1919
return parser
2020

‎src/tmuxp/cli/freeze.py‎

Lines changed: 6 additions & 3 deletions

0 commit comments

Comments
 (0)