Skip to content

chore(scripts): align npm scripts and docs with Vue stack #3138

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.

Sign up for GitHub

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
PierreBrisorgueil merged 1 commit into from
Feb 21, 2026
Merged

chore(scripts): align npm scripts and docs with Vue stack #3138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@

## Canonical commands

- Dev: `npm start`
- Dev: `npm start` (alias: `npm run dev`)
- Debug: `npm run debug`
- Tests: `npm test` (watch: `npm run test:watch`)
- Tests: `npm test` / `npm run test:unit` (one-shot) or `npm run test:watch` (watch)
- Coverage: `npm run test:coverage`
- Lint: `npm run lint`
- Lint fix: `npm run lint:fix`
- Format: `npm run format`
- Seed: `npm run seed:dev`
- Commit: `npm run commit`
- Release (CI): `npm run release:auto`

## Available prompts

Expand Down
30 changes: 18 additions & 12 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,24 @@ The `.claude/` folder contains embedded settings, skills, and agents that are av

## Canonical commands

| Command | Script | Description |
| ------------- | ------------------------ | ---------------------------------------------- |
| **Dev** | `npm start` | Start dev server at `http://localhost:3000/` |
| **Debug** | `npm run debug` | Start with nodemon and inspector |
| **Test** | `npm test` | Run all tests |
| **Watch** | `npm run test:watch` | Run tests in watch mode |
| **Coverage** | `npm run test:coverage` | Generate test coverage |
| **Lint** | `npm run lint` | Check code quality |
| **Lint fix** | `npm run lint:fix` | Auto-fix linting issues |
| **Seed** | `npm run seed:dev` | Seed development database |
| **Commit** | `npm run commit` | Commit with commitizen |
| **Docker** | `docker-compose up` | Start with docker-compose |
| Command | Script | Description |
| ---------------- | ------------------------ | ---------------------------------------------- |
| **Dev** | `npm start` | Start dev server at `http://localhost:3000/` |
| **Dev (alias)** | `npm run dev` | Alias for `npm start` |
| **Debug** | `npm run debug` | Start with nodemon and inspector |
| **Prod** | `npm run prod` | Start in production mode |
| **Test** | `npm test` | Run all tests (one-shot) |
| **Unit test** | `npm run test:unit` | Run unit tests once (alias of `npm test`) |
| **Watch** | `npm run test:watch` | Run tests in watch mode |
| **Coverage** | `npm run test:coverage` | Generate test coverage |
| **Lint** | `npm run lint` | Check code quality |
| **Lint fix** | `npm run lint:fix` | Auto-fix linting issues |
| **Format** | `npm run format` | Format with Prettier |
| **Seed** | `npm run seed:dev` | Seed development database |
| **Commit** | `npm run commit` | Commit with commitizen |
| **Release** | `npm run release` | Manual release (standard-version) |
| **Release (CI)** | `npm run release:auto` | Semantic release for CI |
| **Docker** | `docker-compose up` | Start with docker-compose |

## Preflight

Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ npm install
### Development

```bash
npm start
npm start # or: npm run dev
```

Runs the server at `http://localhost:3000/`. For auto-reload during development, use `npm run debug` (nodemon).
Expand All @@ -80,7 +80,8 @@ npm run prod
### Testing

```bash
npm test # Run all tests
npm test # Run all tests (one-shot)
npm run test:unit # Run unit tests once (alias of npm test)
npm run test:watch # Run tests in watch mode
npm run test:coverage # Generate coverage report
```
Expand All @@ -92,6 +93,7 @@ Tests are organized per module in `modules/*/tests/`
```bash
npm run lint # Check code quality (read-only)
npm run lint:fix # Auto-fix code quality issues
npm run format # Format code with Prettier
```

### Database Seeding
Expand Down
3 changes: 3 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@
},
"scripts": {
"start": "node server.js",
"dev": "npm run start",
"debug": "nodemon --inspect server.js",
"prod": "cross-env NODE_ENV=production node server.js --name=node",
"test": "cross-env NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --runInBand",
"test:unit": "cross-env NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --runInBand",
"test:watch": "cross-env NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --watch --runInBand",
"test:coverage": "cross-env NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --coverage --runInBand",
"lint": "eslint ./modules ./lib ./config ./scripts",
Expand All @@ -38,6 +40,7 @@
"seed:mongodrop": "node scripts/seed.js drop",
"generate:sllCerts": "scripts/generate-ssl-certs.sh",
"lint:fix": "eslint --fix ./modules ./lib ./config ./scripts",
"format": "prettier --write .",
"snyk-protect": "snyk protect",
"commit": "npx cz",
"release": "standard-version",
Expand Down