jscs-bem
Plugin for jscs
with bem
code style preset.
What is it?
A preset library for jscs
(code-style linter) with examples and bem
-specific code-style checks.
Presets inside
bem
— used inbem-core
v3+ code base andbem-components
v2+;canonical-bem
— used inbem-core
v2 andbem-components
below v2.
Usage
To use it you need fresh jscs
, and simple .jscsrc
file in your project root.
Run in your project root to quick start:
npm i jscs jscs-bem --save-devecho '{ plugins: ["jscs-bem"], preset: "bem" }' > .jscsrc
Contribution
- File an issue with properly described suggestion or problem;
- Decide which presets or rules your issue affects;
- Create a feature-branch with an issue number (
issues/<issue_number>
). E.g. for an issue 42 it will looks likeissues/42
; - Commit changes with a proper message, e.g.:
<preset>: <short description> <full description if needed> Fixes #<issue_number>Ref #<referenced issue/pr>
- Push and make a pull-request from your feature-branch.
- Link your pull request with an issue number any way you like (if you forget to do it in commit message). A comment will work perfectly.
- Wait for your pull request and the issue to be closed ;-)
Licence
Code and documentation copyright 2015 YANDEX LLC. Code released under the Mozilla Public License 2.0.