Skip to content

Commit 01ae1bf

Browse files
committed
Add missing part + fix mentions of lintScript and prettyScript
1 parent 70a760e commit 01ae1bf

2 files changed

Lines changed: 18 additions & 9 deletions

File tree

docs/manual/fknode-yaml.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ commitMessage: "Automated maintenance commit by FuckingNode"
106106

107107
### updaterOverride
108108

109-
Overrides the default command for the updating dependencies with the provided runtime script command. Works the same way as [lintCmd](#lintscript) or [prettyCmd](#prettyscript), we simply made the name more verbose because in most cases you don't need (and should not) mess around with it.
109+
Overrides the default command for the updating dependencies with the provided runtime script command. Works the same way as [lintScript](#lintscript) or [prettyScript](#prettyscript), we simply made the name more verbose because in most cases you don't need (and should not) mess around with it.
110110

111111
- **Type**: `string`
112112
- **Example**:
@@ -212,11 +212,20 @@ It's something like this:
212212
{ msft: ~Write-Host 'Hi from Windows!', posix: ~echo 'Hi from Linux/macOS!' }
213213
```
214214

215-
Info:
215+
All commands run in order and block each other. Also, colons are not required. Single and double colons are accepted. `~foo` is equal to `~"foo"` and `~'foo'`.
216216

217-
- All commands run in order and block each other.
218-
- Colons are not required. Single and double colons are accepted. `~foo` is equal to `~"foo"` and `~'foo'`.
219-
- Cmd output is not live, meaning if a command writes to the stdout step by step, you won't see that until it ends execution.
217+
By default, output for each Cmd is not live; this is, invisible until the command ends execution. However, sometimes you might not want that, for example for a live server which "never terminates" and you might want to interact with (to refresh it, for example).
218+
219+
If you want a command to be interactive, you may manually specify it as a _detached cmd_, by using the special `;;` prefix (between the Cmd key and the actual command).
220+
221+
For example:
222+
223+
```yaml
224+
launchCmd:
225+
- $;;some-script
226+
```
227+
228+
This will "detach" the script, allowing to interact with it. ++ctrl+c++-ing out of it will end the detached process and continue the sequence if any Cmd (detached or not) exists after it.
220229

221230
You can use CmdSets for the following project settings:
222231

docs/manual/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ When linting, we will automatically run your linter. By default, we use ESLint -
156156

157157
More precisely, `--lint` runs `eslint --fix .` on each of your projects, unless overridden.
158158

159-
To override it, create a script in your `package.json` scripts object that runs your preferred linter, then copy the name of the script and paste it as the value for the `lintCmd` key on your `fknode.yaml`.
159+
To override it, create a script in your `package.json` scripts object that runs your preferred linter, then copy the name of the script and paste it as the value for the `lintScript` key on your `fknode.yaml`.
160160

161161
For example:
162162

@@ -167,7 +167,7 @@ scripts: {
167167
```
168168

169169
```yaml title="fknode.yaml" linenums="1"
170-
lintCmd: "linter"
170+
lintScript: "linter"
171171
```
172172
173173
### Prettifying your code
@@ -176,7 +176,7 @@ When prettying, we will automatically run your prettifier. By default, we use Pr
176176
177177
More precisely, `--pretty` runs `prettier --w .` on each of your projects, unless overridden.
178178

179-
To override it, do the same as with the linter but setting the `prettyCmd` key instead.
179+
To override it, do the same as with the linter but setting the `prettyScript` key instead.
180180

181181
For example:
182182

@@ -187,7 +187,7 @@ scripts: {
187187
```
188188

189189
```yaml title="fknode.yaml" linenums="2"
190-
prettyCmd: "prettifier"
190+
prettyScript: "prettifier"
191191
```
192192

193193
### Destroying your files

0 commit comments

Comments
 (0)