Skip to content

Commit

Permalink
docs: Add bullet points for notable VSCode setting options (#14059)
Browse files Browse the repository at this point in the history
Adds a couple of recommended setting options and a sample screenshot.
  • Loading branch information
Josmithr authored Feb 8, 2023
1 parent 331a7dd commit 150aee4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,9 @@ Then:
This repository uses [prettier](https://prettier.io/) as its code formatter.
Right now, this is implemented on a per-package basis, with a [shared base configuration](./common/build/build-common/prettier.config.cjs).

- To run `prettier` on your code, run `npm run format` from the appropriate package or release group, or run `npm run format:changed` from the root of the repo to format only files changed since the main branch. If your change is for the
next branch instead, you can run `npm run format:changed:next`.
- To run `prettier` on your code, run `npm run format` from the appropriate package or release group, or run
`npm run format:changed` from the root of the repo to format only files changed since the main branch.
If your change is for the next branch instead, you can run `npm run format:changed:next`.
- To run `prettier` with [fluid-build](./build-tools/packages/build-tools/README.md), you can specify "format" via the
script argument: `fluid-build -s format` or `npm run build:fast -- -s format`

Expand All @@ -215,6 +216,13 @@ It is not configured to do any formatting automatically, however.
This is intentional, to ensure that each developer can work formatting into their workflow as they see fit.
If you wish to configure your setup to format on save/paste/etc., please feel free to update your [user preferences](https://code.visualstudio.com/docs/getstarted/settings) to do so.

Notable setting options:

- `format on save`
- `format on paste`

<img src="https://user-images.githubusercontent.com/54606601/217620203-0cb07007-0aaa-4e57-bc83-973ed4a3f2d7.png" alt="User editor formatting setting options" style="height:400px;"/>

### Git Configuration

Run the following command in each of your repositories to ignore formatting changes in git blame commands: `git config --local blame.ignoreRevsFile .git-blame-ignore-revs`
Expand Down

0 comments on commit 150aee4

Please sign in to comment.