Skip to content

Commit

Permalink
docs: correct yarn option to --dev (#867)
Browse files Browse the repository at this point in the history
`--save-dev` doesn't exist in yarn it's `--dev`
  • Loading branch information
edouard-lopez authored May 18, 2022
1 parent eb1cec9 commit 7718fb3
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ npm install --save-dev @pact-foundation/pact@latest
Yarn

```sh
yarn add --save-dev @pact-foundation/pact@latest
yarn add --dev @pact-foundation/pact@latest
```

- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Ensure you install the package as `devDependencies` by using [`--save-dev`][npm-devdep]/[`--dev`][yarn-devdep] ;
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.

### Do Not Track
Expand Down Expand Up @@ -964,10 +964,10 @@ npm install --save-dev @pact-foundation/pact-web @pact-foundation/pact-node
Yarn

```sh
yarn add --save-dev @pact-foundation/pact-web @pact-foundation/pact-node
yarn add --dev @pact-foundation/pact-web @pact-foundation/pact-node
```

- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Ensure you install the package as `devDependencies` by using [`--save-dev`][npm-devdep]/[`--dev`][yarn-devdep] ;
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.
- If you're not using Karma, you can start and stop the mock server using [Pact Node](https://github.com/pact-foundation/pact-node) or something like [Grunt Pact](https://github.com/pact-foundation/grunt-pact).

Expand Down Expand Up @@ -1050,10 +1050,10 @@ npm install --save-dev @pact-foundation/pact@beta
Yarn
```sh
yarn add --save-dev @pact-foundation/pact@beta
yarn add --dev @pact-foundation/pact@beta
```
- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Ensure you install the package as `devDependencies` by using [`--save-dev`][npm-devdep]/[`--dev`][yarn-devdep] ;
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.
- For examples on how to use it, see [examples/v3/e2e](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/e2e) and [examples/v3/todo-consumer](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/todo-consumer) in the `v3.0.0` branch.
Expand Down Expand Up @@ -1474,3 +1474,5 @@ or chat to us at
[spec]: https://github.com/pact-foundation/pact-specification
[changelog]: https://github.com/pact-foundation/pact-js/blob/master/CHANGELOG.md
[pactflow]: https://pactflow.io
[npm-devdep]: https://docs.npmjs.com/cli/v8/commands/npm-install
[yarn-devdep]: https://classic.yarnpkg.com/en/docs/cli/add#toc-yarn-add-dev-d

0 comments on commit 7718fb3

Please sign in to comment.