Skip to content

Commit d29331b

Browse files
jcabanneschristophechevalier
authored andcommitted
docs: add missing code quality commands in README
1 parent 7ed8973 commit d29331b

1 file changed

Lines changed: 21 additions & 10 deletions

File tree

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,18 @@ This project uses ESLint, Prettier, and TypeScript to ensure consistent code qua
6767
### Run all checks
6868

6969
```sh
70-
# Run linting, tests, build, and type checking for all projects
71-
pnpm exec nx run-many -t lint test build typecheck
70+
# Run all checks (typecheck, lint, format, test)
71+
pnpm validate
72+
```
73+
74+
### Format
75+
76+
```sh
77+
# Automatically format the codebase
78+
pnpm format
79+
80+
# Check formatting without modifying files
81+
pnpm format:check
7282
```
7383

7484
### Linting
@@ -77,28 +87,22 @@ pnpm exec nx run-many -t lint test build typecheck
7787
# Lint all projects
7888
pnpm lint
7989

80-
# Lint a specific project
81-
pnpm catalog-ui:lint
90+
# Auto-fix ESLint issues
91+
pnpm lint:fix
8292
```
8393

8494
### Type Checking
8595

8696
```sh
8797
# Type check all projects
8898
pnpm typecheck
89-
90-
# Type check a specific project
91-
pnpm catalog-ui:typecheck
9299
```
93100

94101
### Testing
95102

96103
```sh
97104
# Run tests for all projects
98105
pnpm test
99-
100-
# Run tests for a specific project
101-
pnpm catalog-ui:test
102106
```
103107

104108
## Nx Commands
@@ -117,6 +121,13 @@ pnpm exec nx affected -t build test lint
117121
pnpm exec nx show projects --affected
118122
```
119123

124+
### Editor Setup
125+
126+
The project includes `.vscode/settings.json` which enables:
127+
128+
- Auto-format on save
129+
- ESLint auto-fix on save
130+
120131
## CI/CD
121132

122133
The project uses GitHub Actions for continuous integration. See [`.github/workflows/ci.yml`](.github/workflows/ci.yml) for details.

0 commit comments

Comments
 (0)