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(eslint-plugin): replace white-spaces with <br> tag #198

Merged
merged 1 commit into from Feb 3, 2019
Merged
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
24 changes: 12 additions & 12 deletions packages/eslint-plugin/ROADMAP.md
@@ -1,9 +1,9 @@
# Roadmap

✅ (28) = done
🌟 (79) = in ESLint core
🔌 (33) = in another plugin
🌓 (16) = implementations differ or ESLint version is missing functionality
✅ (28) = done<br>
🌟 (79) = in ESLint core<br>
🔌 (33) = in another plugin<br>
🌓 (16) = implementations differ or ESLint version is missing functionality<br>
🛑 (70) = unimplemented

## TSLint rules
Expand Down Expand Up @@ -96,7 +96,7 @@
| [`use-default-type-parameter`] | 🛑 | N/A |
| [`use-isnan`] | 🌟 | [`use-isnan`][use-isnan] |

<sup>[1]</sup> The ESLint rule also supports silencing with an extra set of parens (`if ((foo = bar)) {}`)
<sup>[1]</sup> The ESLint rule also supports silencing with an extra set of parens (`if ((foo = bar)) {}`)<br>
<sup>[2]</sup> Missing private class member support. [`@typescript-eslint/no-unused-vars`] adds support for some TS-specific features.

### Maintainability
Expand All @@ -120,7 +120,7 @@
| [`prefer-readonly`] | 🛑 | N/A |
| [`trailing-comma`] | 🌓 | [`comma-dangle`][comma-dangle] or [Prettier] |

<sup>[1]</sup> Only warns when importing deprecated symbols
<sup>[1]</sup> Only warns when importing deprecated symbols<br>
<sup>[2]</sup> Missing support for blank-line-delimited sections

### Style
Expand Down Expand Up @@ -179,7 +179,7 @@
| [`variable-name`] | 🌟 | <sup>[2]</sup> |
| [`whitespace`] | 🔌 | Use [Prettier] |

<sup>[1]</sup> Recommended config: `["error", { blankLine: "always", prev: "*", next: "return" }]`
<sup>[1]</sup> Recommended config: `["error", { blankLine: "always", prev: "*", next: "return" }]`<br>
<sup>[2]</sup> [`camelcase`][camelcase], [`no-underscore-dangle`][no-underscore-dangle], [`id-blacklist`][id-blacklist], and/or [`id-match`][id-match]

## tslint-microsoft-contrib rules
Expand Down Expand Up @@ -245,10 +245,10 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
| `use-named-parameter` | 🛑 | N/A |
| `use-simple-attributes` | 🛑 | N/A |

<sup>[1]</sup> Enforces blank lines both at the beginning and end of a block
<sup>[2]</sup> Recommended config: `["error", "ForInStatement"]`
<sup>[3]</sup> Recommended config: `["error", "declaration", { "allowArrowFunctions": true }]`
<sup>[4]</sup> Recommended config: `["error", { "terms": ["BUG", "HACK", "FIXME", "LATER", "LATER2", "TODO"], "location": "anywhere" }]`
<sup>[1]</sup> Enforces blank lines both at the beginning and end of a block<br>
<sup>[2]</sup> Recommended config: `["error", "ForInStatement"]`<br>
<sup>[3]</sup> Recommended config: `["error", "declaration", { "allowArrowFunctions": true }]`<br>
<sup>[4]</sup> Recommended config: `["error", { "terms": ["BUG", "HACK", "FIXME", "LATER", "LATER2", "TODO"], "location": "anywhere" }]`<br>
<sup>[5]</sup> Does not check class fields.

[insecure-random]: https://github.com/desktop/desktop/blob/master/eslint-rules/insecure-random.js
Expand Down Expand Up @@ -310,7 +310,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
| `react-a11y-titles` | 🛑 | N/A |
| `react-anchor-blank-noopener` | 🛑 | N/A |

<sup>[1]</sup> TSLint rule is more strict
<sup>[1]</sup> TSLint rule is more strict<br>
<sup>[2]</sup> ESLint rule only reports for click handlers

[prettier]: https://prettier.io
Expand Down