Skip to content

Commit

Permalink
Rename grunt check => grunt type-check, see phetsims/perennial#404
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Dec 4, 2024
1 parent 3a35252 commit 334b719
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/new-dev-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ When you begin working in TypeScript files, you might hear a lot about tsc (Type
- `tsc -b` runs a type checker that will output type errors in our code. This type checking is already included in
pre-commit hooks, but many developers enjoy having a tool where they can check for type errors outside of pre-commit
hooks.
- The recommended method for running `tsc -b` at PhET is with `grunt check`. Documentation for that can be found in the
- The recommended method for running `tsc -b` at PhET is with `grunt type-check`. Documentation for that can be found in the
process. Many devs also use this as a webstorm tool, see doc for `--absolute` for supporting that.
- The [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/intro.html) is a great resource for diving into
TypeScript. You can also find PhET specific TypeScript Conventions in the [Reference Documents](#reference-docs)
Expand Down
2 changes: 1 addition & 1 deletion doc/typescript-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ known problems, etc.
1. Clone missing repos by running `perennial/bin/clone-missing-repos.sh`. This ensures that you have everything.
2. Pull all repos by running `perennial/bin/pull-all.sh`. This ensures that you have the latest version of everything.
3. `npm install` in chipper. This ensures that you have the TypeScript compiler, which is called `tsc`. You can use
`grunt check` in your simulation repo to run type-checking as you develop.
`grunt type-check` in your simulation repo to run type-checking as you develop.
5. Mark chipper/dist/ as excluded from your IDE. You can create that directory eagerly now, or wait until chipper/dist/
is created by a compilation step below. Compiled code will be written to chipper/dist/.
6. Update your IDE to use the code style file from `phet-info/ide/idea/phet-idea-codestyle.xml`. You may need to
Expand Down

0 comments on commit 334b719

Please sign in to comment.