Skip to content

Commit 37e3237

Browse files
CLI-31 Update CONTRIBUTING file to mention bun
1 parent 168f67e commit 37e3237

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@
88
## Setup
99

1010
```bash
11-
npm install
11+
bun install
1212
```
1313

1414
## Building
1515

1616
### TypeScript build (for npm distribution)
1717

1818
```bash
19-
npm run build
19+
bun run build
2020
```
2121

2222
Output goes to `dist/`.
2323

2424
### Self-contained binary (for releases)
2525

2626
```bash
27-
npm run build:binary
27+
bun run build:binary
2828
```
2929

3030
Produces `dist/sonarqube-cli` using Bun's single-file compiler. To install it locally:
3131

3232
```bash
33-
npm run setup
33+
bun run setup
3434
```
3535

3636
## Checks
@@ -39,35 +39,35 @@ Run these before opening a pull request:
3939

4040
```bash
4141
# Lint (ESLint + TypeScript-aware rules)
42-
npm run lint
42+
bun run lint
4343

4444
# Auto-fix safe lint issues
45-
npm run lint:fix
45+
bun run lint:fix
4646

4747
# TypeScript type checking
48-
npm run typecheck
48+
bun run typecheck
4949

5050
# Validate spec.yaml and command registration
51-
npm run validate
51+
bun run validate
5252
```
5353

5454
## Testing
5555

5656
```bash
5757
# Unit tests
58-
npm test
58+
bun test
5959

6060
# Unit tests with coverage
61-
npm run test:coverage
61+
bun run test:coverage
6262

6363
# Script tests (validates spec.yaml / command sync)
64-
npm run test:scripts
64+
bun run test:scripts
6565

6666
# Integration tests (require env vars — see below)
67-
npm run test:integration
67+
bun run test:integration
6868

6969
# All tests
70-
npm run test:all
70+
bun run test:all
7171
```
7272

7373
### Integration tests
@@ -89,16 +89,16 @@ Commands are generated from `spec.yaml` using Plop:
8989

9090
```bash
9191
# Add a new command interactively
92-
npm run gen:command
92+
bun run gen:command
9393

9494
# Regenerate docs from spec.yaml
95-
npm run gen:docs
95+
bun run gen:docs
9696

9797
# Sync index.ts command registrations
98-
npm run gen:sync
98+
bun run gen:sync
9999

100100
# Run full generation pipeline
101-
npm run gen:all
101+
bun run gen:all
102102
```
103103

104-
After editing `spec.yaml` directly, run `npm run validate` to check consistency.
104+
After editing `spec.yaml` directly, run `bun run validate` to check consistency.

0 commit comments

Comments
 (0)