From 4cfdbe13f8e1fa23ad8d5dcc0570d28a285aab8d Mon Sep 17 00:00:00 2001 From: abbycross Date: Fri, 26 Apr 2024 12:00:39 -0400 Subject: [PATCH 1/4] Specify command to run Prettier --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1e751a2d366..aae666fe72b 100644 --- a/README.md +++ b/README.md @@ -314,6 +314,10 @@ If you're working on our support code in `scripts/`, run `npm run fmt` to automa To check that formatting is valid without actually making changes, run `npm run check:fmt` or `npm run check`. +## Prettier errors + +If you get an error that tells you to `run Prettier to fix`, the command to do so is `npx prettier --write` or `npm run fmt` as mentioned in the [Format TypeScript files](#format-typescript-files) section. To run Prettier on a single file, you can do so with `npx prettier --write filename.md`. + ## Regenerate an existing API docs version This is useful when we make improvements to the API generation script. From 5ea7c8f5c9ec5141fcb2c15f2e31613387c26adf Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Fri, 26 Apr 2024 14:30:11 -0400 Subject: [PATCH 2/4] code review --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aae666fe72b..676c3b17f25 100644 --- a/README.md +++ b/README.md @@ -310,7 +310,9 @@ CI will check on every PR that any changed files render correctly. We also run a ## Format TypeScript files -If you're working on our support code in `scripts/`, run `npm run fmt` to automatically format the files. +## Format README and TypeScript files + +Run `npm run fmt` to automatically format the README, `.github` folder, and `scripts/` folder. You should run this command if you get the error in CI `run Prettier to fix`. To check that formatting is valid without actually making changes, run `npm run check:fmt` or `npm run check`. From 5681c71f2db8db9b68cbfc252c9fec29c680c55c Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Fri, 26 Apr 2024 14:31:45 -0400 Subject: [PATCH 3/4] delete extra header --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 676c3b17f25..d9a1c2b5c80 100644 --- a/README.md +++ b/README.md @@ -308,8 +308,6 @@ You can also check that API docs and translations render by using any of these a CI will check on every PR that any changed files render correctly. We also run a weekly cron job to check that every page renders correctly. -## Format TypeScript files - ## Format README and TypeScript files Run `npm run fmt` to automatically format the README, `.github` folder, and `scripts/` folder. You should run this command if you get the error in CI `run Prettier to fix`. From 8c76e845734fec3ee6a32236d4a1c5c112c81b80 Mon Sep 17 00:00:00 2001 From: abbycross Date: Fri, 26 Apr 2024 14:32:56 -0400 Subject: [PATCH 4/4] Update README.md Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index d9a1c2b5c80..5f8f8efee93 100644 --- a/README.md +++ b/README.md @@ -314,10 +314,6 @@ Run `npm run fmt` to automatically format the README, `.github` folder, and `scr To check that formatting is valid without actually making changes, run `npm run check:fmt` or `npm run check`. -## Prettier errors - -If you get an error that tells you to `run Prettier to fix`, the command to do so is `npx prettier --write` or `npm run fmt` as mentioned in the [Format TypeScript files](#format-typescript-files) section. To run Prettier on a single file, you can do so with `npx prettier --write filename.md`. - ## Regenerate an existing API docs version This is useful when we make improvements to the API generation script.