-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Theodor Vararu
committed
Aug 9, 2016
1 parent
5012bf2
commit 06a75d8
Showing
2 changed files
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Linting | ||
|
||
The prototype kit uses [standardjs](http://standardjs.com/), an opinionated JavaScript linter. All JavaScript files follow its conventions, and it runs on CI to ensure that new pull requests are in line with them. | ||
|
||
## Running standard manually | ||
|
||
To check the whole codebase, run: | ||
|
||
```bash | ||
npm run lint | ||
``` | ||
|
||
## Running standard in your editor | ||
|
||
Easier than running standard manually is to install it as a plugin in your editor. There are [guides for most of the popular editors](http://standardjs.com/index.html#text-editor-plugins). This way, it will run automatically while you work, catching errors as they happen on a per-file basis. | ||
|
||
## Do I need to respect this? | ||
|
||
If you want to submit a pull request to the prototype kit, your code will need to pass the linter. | ||
|
||
If you're just using the prototype kit in a separate project, then no, you aren't forced to use standard, or any other linter for that matter. Just create new files as you would normally. |