github-desktop/docs/contributing/linting.md
evelyn masso 7e4053581d newline
2018-11-21 10:22:47 -08:00

1.2 KiB

Linting

What is linting, anyways?

Tooling

Our linting tooling uses a combination of

Most (if not all) editors have integrations for these tools so that they will report errors and fix formatting in realtime. See tooling for how to set these integrations up while developing for desktop.

Running Checks

Use

$ yarn lint

in your local repository to run all linting checks. Each tool will report their errors on the command line.

Fixing Issues

Some issues found by linters can be automatically fixed. Use

$ yarn lint:fix

to automatically fix them. If any issues remain, you'll have to fix them manually (and the output will tell you that).

Continuous Integration (CI)

Each of our CI services also runs linting checks on open pull requests in the GitHub Desktop repository. Pull requests must pass CI to before we accept them, so don't forget to lint locally.