Skip to content

docs: adjust package managers CLI instructions for both Win and Unix based systems (#4381) #4382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,19 @@ Install `@commitlint/cli` and a `@commitlint/config-*` / `commitlint-config-*` o
::: code-group

```sh [npm]
npm install --save-dev @commitlint/{cli,config-conventional}
npm install -D @commitlint/cli @commitlint/config-conventional
```

```sh [yarn]
yarn add --dev @commitlint/{cli,config-conventional}
```

```sh [npm (Windows)]
npm install --save-dev @commitlint/config-conventional @commitlint/cli
yarn add -D @commitlint/cli @commitlint/config-conventional
```

```sh [pnpm]
pnpm add --save-dev @commitlint/{cli,config-conventional}
pnpm add -D @commitlint/cli @commitlint/config-conventional
```

```sh [deno]
deno add --dev npm:@commitlint/cli npm:@commitlint/config-conventional
deno add -D npm:@commitlint/cli npm:@commitlint/config-conventional
```

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/use-prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
3. Install and configure if needed

```sh
npm install --save-dev @commitlint/{cli,config-conventional,prompt-cli}
npm install --save-dev @commitlint/cli @commitlint/config-conventional @commitlint/prompt-cli

echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
```
Expand Down
14 changes: 8 additions & 6 deletions docs/reference/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@ These examples show common usages of how commitlint can be configured.
::: code-group

```jsonc [package.json]
{
// ...
commitlint: {
"commitlint": {
"rules": {
"references-empty": [2, "never"]
"references-empty": [2, "never"],
},
"parserPreset": {
"parserOpts": {
"issuePrefixes": ["PROJ-"]
}
}
}
"issuePrefixes": ["PROJ-"],
},
},
},
// ...
}
```