From 334b7195d97919c8d91639434a35e36e78b7597f Mon Sep 17 00:00:00 2001 From: Sam Reid Date: Tue, 3 Dec 2024 19:42:43 -0700 Subject: [PATCH] Rename grunt check => grunt type-check, see https://github.com/phetsims/perennial/issues/404 --- doc/new-dev-onboarding.md | 2 +- doc/typescript-quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/new-dev-onboarding.md b/doc/new-dev-onboarding.md index 7149ce65..3ec377b1 100644 --- a/doc/new-dev-onboarding.md +++ b/doc/new-dev-onboarding.md @@ -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) diff --git a/doc/typescript-quick-start.md b/doc/typescript-quick-start.md index 92d1ff9a..bb061578 100644 --- a/doc/typescript-quick-start.md +++ b/doc/typescript-quick-start.md @@ -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