Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add jscs-dev.github.io links to rule names in docs #10771

Merged
merged 1 commit into from
Aug 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/array-bracket-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ If you don't want to enforce line breaks after opening and before closing array

## Compatibility

* **JSCS:** `validateNewlineAfterArrayElements`
* **JSCS:** [validateNewlineAfterArrayElements](https://jscs-dev.github.io/rule/validateNewlineAfterArrayElements)

## Related Rules

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/array-element-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ If you don't want to enforce linebreaks between array elements, don't enable thi

## Compatibility

* **JSCS:** `validateNewlineAfterArrayElements`
* **JSCS:** [validateNewlineAfterArrayElements](https://jscs-dev.github.io/rule/validateNewlineAfterArrayElements)

## Related Rules

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/capitalized-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,5 +245,5 @@ This rule can be disabled if you do not care about the grammatical style of comm

## Compatibility

* **JSCS**: `requireCapitalizedComments`
* **JSCS**: `disallowCapitalizedComments`
* **JSCS**: [requireCapitalizedComments](https://jscs-dev.github.io/rule/requireCapitalizedComments)
* **JSCS**: [disallowCapitalizedComments](https://jscs-dev.github.io/rule/disallowCapitalizedComments)
4 changes: 2 additions & 2 deletions docs/rules/func-call-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,5 @@ This rule can safely be turned off if your project does not care about enforcing

## Compatibility

- **JSCS**: `disallowSpacesInCallExpression`
- **JSCS**: `requireSpacesInCallExpression`
- **JSCS**: [disallowSpacesInCallExpression](https://jscs-dev.github.io/rule/disallowSpacesInCallExpression)
- **JSCS**: [requireSpacesInCallExpression](https://jscs-dev.github.io/rule/requireSpacesInCallExpression)
2 changes: 1 addition & 1 deletion docs/rules/func-name-matching.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@ Do not use this rule if you want to allow named functions to have different name

## Compatibility

* **JSCS**: `requireMatchingFunctionName`
* **JSCS**: [requireMatchingFunctionName](https://jscs-dev.github.io/rule/requireMatchingFunctionName)
4 changes: 2 additions & 2 deletions docs/rules/func-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,5 +107,5 @@ Foo.prototype.bar = function() {};

## Compatibility

* **JSCS**: `requireAnonymousFunctions`
* **JSCS**: `disallowAnonymousFunctions`
* **JSCS**: [requireAnonymousFunctions](https://jscs-dev.github.io/rule/requireAnonymousFunctions)
* **JSCS**: [disallowAnonymousFunctions](https://jscs-dev.github.io/rule/disallowAnonymousFunctions)
3 changes: 1 addition & 2 deletions docs/rules/indent-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,8 +526,7 @@ var foo = { bar: 1,
baz: 2 };
```


## Compatibility

* **JSHint**: `indent`
* **JSCS**: `validateIndentation`
* **JSCS**: [validateIndentation](https://jscs-dev.github.io/rule/validateIndentation)
2 changes: 1 addition & 1 deletion docs/rules/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -661,4 +661,4 @@ if (foo) {
## Compatibility

* **JSHint**: `indent`
* **JSCS**: `validateIndentation`
* **JSCS**: [validateIndentation](https://jscs-dev.github.io/rule/validateIndentation)
2 changes: 1 addition & 1 deletion docs/rules/line-comment-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ If you aren't concerned about having different line comment styles, then you can

## Compatibility

**JSCS**: `validateCommentPosition`
**JSCS**: [validateCommentPosition](https://jscs-dev.github.io/rule/validateCommentPosition)
2 changes: 1 addition & 1 deletion docs/rules/linebreak-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ If you aren't concerned about having different line endings within your code, th

## Compatibility

* **JSCS**: `validateLineBreaks`
* **JSCS**: [validateLineBreaks](https://jscs-dev.github.io/rule/validateLineBreaks)
4 changes: 2 additions & 2 deletions docs/rules/lines-around-directive.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,5 +318,5 @@ You can safely disable this rule if you do not have any strict conventions about

## Compatibility

* **JSCS**: `requirePaddingNewLinesAfterUseStrict`
* **JSCS**: `disallowPaddingNewLinesAfterUseStrict`
* **JSCS**: [requirePaddingNewLinesAfterUseStrict](https://jscs-dev.github.io/rule/requirePaddingNewLinesAfterUseStrict)
* **JSCS**: [disallowPaddingNewLinesAfterUseStrict](https://jscs-dev.github.io/rule/disallowPaddingNewLinesAfterUseStrict)
4 changes: 2 additions & 2 deletions docs/rules/lines-between-class-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ If you don't want to enforce empty lines between class members, you can disable

## Compatibility

* **JSCS**: `requirePaddingNewLinesAfterBlocks`
* **JSCS**: `disallowPaddingNewLinesAfterBlocks`
* [requirePaddingNewLinesAfterBlocks](https://jscs-dev.github.io/rule/requirePaddingNewLinesAfterBlocks)
* [disallowPaddingNewLinesAfterBlocks](https://jscs-dev.github.io/rule/disallowPaddingNewLinesAfterBlocks)
2 changes: 1 addition & 1 deletion docs/rules/max-lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ You can turn this rule off if you are not concerned with the number of lines in

## Compatibility

* **JSCS**: `maximumNumberOfLines`
* **JSCS**: [maximumNumberOfLines](https://jscs-dev.github.io/rule/maximumNumberOfLines)
2 changes: 1 addition & 1 deletion docs/rules/multiline-ternary.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,4 @@ You can safely disable this rule if you do not have any strict conventions about

## Compatibility

* **JSCS**: `requireMultiLineTernary`
* **JSCS**: [requireMultiLineTernary](https://jscs-dev.github.io/rule/requireMultiLineTernary)
2 changes: 1 addition & 1 deletion docs/rules/no-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ If you have established a standard where having tabs is fine.

## Compatibility

* **JSCS**: `disallowTabs`
* **JSCS**: [disallowTabs](https://jscs-dev.github.io/rule/disallowTabs)
2 changes: 1 addition & 1 deletion docs/rules/no-useless-rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ You can safely disable this rule if you do not care about redundantly renaming i

## Compatibility

* **JSCS**: `disallowIdenticalDestructuringNames`
* **JSCS**: [disallowIdenticalDestructuringNames](https://jscs-dev.github.io/rule/disallowIdenticalDestructuringNames)
2 changes: 1 addition & 1 deletion docs/rules/nonblock-statement-body-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ If you're not concerned about consistent locations of single-line statements, yo

## Further Reading

* JSCS: `requireNewlineBeforeSingleStatementsInIf`
* JSCS: [requireNewlineBeforeSingleStatementsInIf](https://jscs-dev.github.io/rule/requireNewlineBeforeSingleStatementsInIf)
4 changes: 2 additions & 2 deletions docs/rules/object-curly-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,8 @@ export { foo as f, bar } from 'foo-bar';

## Compatibility

* **JSCS**: `requirePaddingNewLinesInObjects`
* **JSCS**: `disallowPaddingNewLinesInObjects`
* **JSCS**: [requirePaddingNewLinesInObjects](https://jscs-dev.github.io/rule/requirePaddingNewLinesInObjects)
* **JSCS**: [disallowPaddingNewLinesInObjects](https://jscs-dev.github.io/rule/disallowPaddingNewLinesInObjects)

## When Not To Use It

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/object-property-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ You can turn this rule off if you want to decide, case-by-case, whether to place

## Compatibility

- **JSCS**: This rule provides partial compatibility with `requireObjectKeysOnNewLine`.
- **JSCS**: This rule provides partial compatibility with [requireObjectKeysOnNewLine](https://jscs-dev.github.io/rule/requireObjectKeysOnNewLine).

## Related Rules

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/one-var.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,5 +536,5 @@ function foo() {
## Compatibility

* **JSHint**: This rule maps to the `onevar` JSHint rule, but allows `let` and `const` to be configured separately.
* **JSCS**: This rule roughly maps to `disallowMultipleVarDecl`.
* **JSCS**: This rule option `separateRequires` roughly maps to `requireMultipleVarDecl`.
* **JSCS**: This rule roughly maps to [disallowMultipleVarDecl](https://jscs-dev.github.io/rule/disallowMultipleVarDecl).
* **JSCS**: This rule option `separateRequires` roughly maps to [requireMultipleVarDecl](https://jscs-dev.github.io/rule/requireMultipleVarDecl).
2 changes: 1 addition & 1 deletion docs/rules/prefer-numeric-literals.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ If you want to allow use of `parseInt()` or `Number.parseInt()` for binary, octa

## Compatibility

* **JSCS**: `requireNumericLiterals`
* **JSCS**: [requireNumericLiterals](https://jscs-dev.github.io/rule/requireNumericLiterals)
2 changes: 1 addition & 1 deletion docs/rules/sort-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ If you don't want to notify about properties' order, then it's safe to disable t

## Compatibility

* **JSCS:** `validateOrderInObjectKeys`
* **JSCS:** [validateOrderInObjectKeys](https://jscs-dev.github.io/rule/validateOrderInObjectKeys)