Linting & formatting

This project uses Typescript Eslint, and Prettier to catch errors and avoid bike-shedding by enforcing a common code style.

Languages

There are a few different contexts in which the linters run.

# Lint all files without auto-fixing
yarn lint

1
2

# Lint all files, fixing many violations automatically
yarn lint:fix

1
2

See package.json to update.

Staged files are automatically linted and tested before each commit. See lint-staged.config.js to update.

In supported editors, all files will be linted and show under the linter errors section.

This boilerplate ships with opinionated defaults, but you can edit each tools configuration in the following config files:

So many configuration files! Why not move more of this to package.json?

Moving all possible configs to package.json can make it really packed, so that quickly navigating to a specific config becomes difficult.
When split out into their own file, many tools provide the option of exporting a config from JS. I do this wherever possible, because dynamic configurations are simply more powerful, able to respond to environment variables and much more.