Skip to content

Commit

Permalink
Rename npm run build to npm run check (#40)
Browse files Browse the repository at this point in the history
I'm adding TypeScript to other Parking Reform projects. They already use
`build` to build the actual web app, so it's confusing to have `build`
here refer to TypeScript compilation but not there.

Instead, `npm run check` is what the Internet recommends.
  • Loading branch information
Eric-Arellano authored Jul 1, 2023
1 parent a0079aa commit ef25425
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ jobs:
node-version: 18
- name: Install dependencies
run: npm ci
- name: Compile
run: npm run build
- name: Check TypeScript
run: npm run check
- name: Lint
run: npm run lint
- name: Test
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Run `npm install` before all these commands.
### Check type compilation

```bash
❯ npm run build
❯ npm run check
```

`npm start` and `npm test` will also compile your code.
`npm start` will also compile your code.

### Format code

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"name": "organization-dashboard",
"version": "0.1.0",
"scripts": {
"build": "tsc",
"prestart": "tsc",
"start": "node lib/src/index.js",
"check": "tsc --noEmit",
"test": "playwright test",
"fmt": "prettier --write .",
"fix": "prettier --write .; eslint --fix .",
Expand Down

0 comments on commit ef25425

Please sign in to comment.