Skip to content

Commit 96feaa7

Browse files
author
Johan van Overbeeke
committed
Clarify naming of the two types
1 parent 4982ae4 commit 96feaa7

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,34 +83,34 @@ _task "$@"
8383

8484
Now after running `task shorthand`, your `task` commands will get autocompleted.
8585

86-
## SubTaskfiles
86+
## Splitting Taskfiles
8787

8888
Have a (mono)repo with multiple projects, a group of less-used or specialized tasks or just waaay to many tasks for a
89-
single Taskfile? SubTaskfiles might be for you! They allow you to divide your tasks across multiple files while still
90-
(also) calling them from a single one.
89+
single Taskfile? Splitting your Taskfiles might be for you! This allows you to divide your tasks across multiple files
90+
while still (also) calling them from a single one.
9191

92-
There are two flavours, but in both cases tasks from the subTaskfile are called "via" a task in the root Taskfile,
92+
There are two types, but in both cases tasks from the secondary Taskfile are called "via" a task in the root Taskfile,
9393
like this: `./Taskfile foo <task> <args>`
9494

95-
### Full SubTaskfile
95+
### Remote Taskfile
9696

97-
This flavour of subTaskfile is more verbose, but can be used on its own as well. Most useful in (mono)repos where people might
98-
be working on part as often as the whole project.
97+
This type is more verbose, but can be used on its own as well. Most useful in (mono)repos where people might be working
98+
in a subdirectory as often as on the project as a whole.
9999

100-
In the main Taskfile you call the subTaskfile like any other script:
100+
In the main Taskfile you call the secondary like any other script:
101101
```shell
102102
function task:foo { ## bar
103-
./path/to/subtaskfile/Taskfile "${@-help}"
103+
./path/to/secondary/Taskfile "${@-help}"
104104
}
105105
```
106106

107-
The subTaskfile is just a regular Taskfile, including utilities like `task:help`, `file:ensure` and a line with `task:"${@-help}"`
108-
at the bottom.
107+
The secondary is just a regular Taskfile, including utilities (semi) optional ones like `task:help`, `file:ensure` and
108+
the required line with `task:"${@-help}"`at the bottom.
109109

110-
### Lean SubTaskfile
110+
### SubTaskfile
111111

112-
This flavour of subTaskfile cannot be called on its own, but has a lot less boilerplate. Most useful for splitting off a
113-
group of tasks that can be logically grouped together, possibly because they are rarely used.
112+
This type cannot be called on its own, but has a lot less boilerplate. Most useful for splitting off a group of tasks
113+
that can be logically grouped together, for specific tasks or because they are rarely used.
114114

115115
In the main Taskfile:
116116
```shell
@@ -125,7 +125,7 @@ function task:foo { ## bar
125125

126126
The subTaskfile just needs to contain the tasks and sections you need, but has a few notes:
127127
```shell
128-
# Files in the subTaskfile's directory need to be prefixed with $SUB_TASKFILE_DIR
128+
# When you use files in the subTaskfile's directory, you need prefix them with $SUB_TASKFILE_DIR
129129
function task:call-script { ## Call a script
130130
"$SUB_TASKFILE_DIR/some-script.sh"
131131
}

0 commit comments

Comments
 (0)