You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,15 @@ updated.
10
10
11
11
## Code Format & Linting
12
12
13
-
Code format and lint checks are performed locally when committing to ensure the changes align with the configured rules of this repository. This happens with the help of the tools [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) and [lint-staged](https://github.com/okonet/lint-staged) which are automatically installed and configured on `npm install` (no further steps required).
13
+
Code format and lint checks are performed locally when committing to ensure the changes align with the configured rules of this repository. This happens with the help of the tools [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) and [lint-staged](https://github.com/okonet/lint-staged) which are automatically installed and configured on `pnpm install` (no further steps required).
14
14
15
15
In case of problems, a corresponding message is displayed in your terminal.
16
16
Please fix them and then run the commit command again.
17
17
18
18
## Test
19
19
20
-
Tests can be run with the command:
20
+
Tests can be executed with the following command:
21
21
22
22
```bash
23
-
npmtest
23
+
pnpmtest
24
24
```
25
-
26
-
## Release
27
-
28
-
Use [np](https://www.npmjs.com/package/np) to create a new release.
[](https://www.npmjs.com/package/concurrently)
@@ -25,7 +25,7 @@ Like `npm run watch-js & npm run watch-less` but better.
25
25
26
26
## Why
27
27
28
-
I like [task automation with npm](https://github.com/substack/blog/blob/master/npm_run.markdown)
28
+
I like [task automation with npm](https://web.archive.org/web/20220531064025/https://github.com/substack/blog/blob/master/npm_run.markdown)
29
29
but the usual way to run multiple commands concurrently is
30
30
`npm run watch-js & npm run watch-css`. That's fine but it's hard to keep
31
31
on track of different outputs. Also if one process fails, others still keep running
@@ -41,25 +41,24 @@ tired of opening terminals and made **concurrently**.
41
41
- With `--kill-others` switch, all commands are killed if one dies
42
42
- Spawns commands with [spawn-command](https://github.com/mmalecki/spawn-command)
43
43
44
-
## Install
44
+
## Installation
45
45
46
-
The tool is written in Node.js, but you can use it to run **any** commands.
47
-
48
-
```bash
49
-
npm install -g concurrently
50
-
```
46
+
**concurrently** can be installed in the global scope (if you'd like to have it available and use it on the whole system) or locally for a specific package (for example if you'd like to use it in the `scripts` section of your package):
<sub>\* It's recommended to add **concurrently** to `devDependencies` as it's usually used for developing purposes. Please adjust the command if this doesn't apply in your case.</sub>
57
54
58
55
## Usage
59
56
60
57
> **Note**
61
58
> The `concurrently` command is now also available under the shorthand alias `conc`.
62
59
60
+
The tool is written in Node.js, but you can use it to run **any** commands.
61
+
63
62
Remember to surround separate commands with quotes:
64
63
65
64
```bash
@@ -220,6 +219,8 @@ Killing other processes
220
219
-k, --kill-others Kill other processes if one exits or dies.[boolean]
221
220
--kill-others-on-fail Kill other processes if one exits with non zero
222
221
status code. [boolean]
222
+
--kill-signal Signal to send to other processes if one exits or dies.
223
+
(SIGTERM/SIGKILL, defaults to SIGTERM) [string]
223
224
224
225
Restarting
225
226
--restart-tries How many times a process that died should restart.
@@ -339,7 +340,7 @@ For more details, visit https://github.com/open-cli-tools/concurrently
339
340
Prefix colors specified per-command take precedence over this list.
340
341
-`prefixLength`: how many characters to show when prefixing with `command`. Default: `10`
341
342
-`raw`: whether raw mode should be used, meaning strictly process output will
342
-
be logged, without any prefixes, coloring or extra stuff.
343
+
be logged, without any prefixes, coloring or extra stuff. Can be overriden per command.
343
344
-`successCondition`: the condition to consider the run was successful.
344
345
If `first`, only the first process to exit will make up the success of the run; if `last`, the last process that exits will determine whether the run succeeds.
345
346
Anything else means all processes should exit successfully.
@@ -428,6 +429,6 @@ It contains the following properties:
428
429
So _null_ means the process didn't terminate normally. This will make **concurrently**
429
430
to return non-zero exit code too.
430
431
431
-
- Does this work with the npm-replacements [yarn](https://github.com/yarnpkg/yarn) or [pnpm](https://pnpm.js.org/)?
432
+
- Does this work with the npm-replacements [yarn](https://github.com/yarnpkg/yarn), [pnpm](https://pnpm.js.org/), or [Bun](https://bun.sh/)?
432
433
433
-
Yes! In all examples above, you may replace "`npm`" with "`yarn`"or "`pnpm`".
434
+
Yes! In all examples above, you may replace "`npm`" with "`yarn`", "`pnpm`", or "`bun`".
0 commit comments