Update documentation #23
Merged
Conversation
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
ruiquelhas
force-pushed
the
support/update-documentation
branch
from
2f9769e
to
a4af197
Compare
| Seegno-flavored JSCS config. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| $ npm install jscs jscs-config-seegno --save-dev | ||
| $ npm install jscs jscs-preset-seegno should --save-dev |
There was a problem hiding this comment.
I would move the preset rename to another PR so we can rename the repo + package too.
ruiquelhas
force-pushed
the
support/update-documentation
branch
from
a4af197
to
78bf2f0
Compare
| The preset includes the following custom rules: | ||
|
|
||
| ### `disallowGeneratorsInDescribeFunctions` | ||
| Disallows the usage of generators for the `describe` grouping primitive that features in testing frameworks such as `mocha`. |
There was a problem hiding this comment.
Can you include a small paragraph on why this is critical to validate?
|
Looks good minor small comments. |
ruiquelhas
force-pushed
the
support/update-documentation
branch
from
78bf2f0
to
b6c4d9a
Compare
|
@ruimarinho I've added a small explanation for each rule. |
|
LGTM. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.