Formatting

[goosewobbler]

Using prettier, lint-staged and husky to remove formatting nits from all PRs going forward. This does not include linting, saving that for another PR.

Prettier options: https://prettier.io/docs/en/options.html

Changes

• lint-staged runs on husky pre-commit, which runs the format script, which runs prettier on TS, JS, MD, YML, JSON files.
• formatting can be run and checked manually with npm run format and npm run format:check
• unit tests run on husky pre-push - so no more PRs with broken tests, and zero tolerance for flaky tests

Prettier settings

See .prettierrc.json

In-editor formatting

Prettier VSCode formatter - not required for development but I usually have this configured to format on save:
https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

TODO:

• update package-lock.json
• make hook files executable
• ensure hooks work
• deflake tests - if necessary: 2166fd6 (#913)

[mholtzman]

wyt about excluding these types of files (perhaps .config.json) or some such? I kind of like the readability of the previous style, especially for configuration files where compacting things into one line isn't really important

[goosewobbler]

I'm honestly more inclined to let Prettier do its thing everywhere - managing exemptions would be more work

[mholtzman]

I noticed this in the husky setup docs but does this need to be run every time a new repo is checked out or just once and then we have the husky hooks checked into source control?

[goosewobbler]

I'm guessing every time, otherwise it wouldn't exist?

[goosewobbler]

Closing in favour of #1211