docs(eslint-plugin): add missing TSLint rules in the roadmap (typescript-eslint#238)

lukyth · j-f1 · commit c680cbcee719 · 2019-02-11T13:00:42.000-05:00
- Rules from TSLint version 5.12.0 onward haven't added, including:
  - `ban-ts-ignore`
  - `function-constructor`
  - `unnecessary-constructor`
  - `no-default-import`
  - `comment-type`
  - `increment-decrement`
  - `unnecessary-bind`
- `no-function-constructor-with-string-args` is now deprecated in favor of `function-constructor`
diff --git a/packages/eslint-plugin/ROADMAP.md b/packages/eslint-plugin/ROADMAP.md
@@ -13,6 +13,7 @@
 | TSLint rule                       |     | ESLint rule                                          |
 | --------------------------------- | :-: | ---------------------------------------------------- |
 | [`adjacent-overload-signatures`]  | ✅  | [`@typescript-eslint/adjacent-overload-signatures`]  |
+| [`ban-ts-ignore`]                 | 🛑  | N/A                                                  |
 | [`ban-types`]                     | ✅  | [`@typescript-eslint/ban-types`]                     |
 | [`member-access`]                 | ✅  | [`@typescript-eslint/explicit-member-accessibility`] |
 | [`member-ordering`]               | ✅  | [`@typescript-eslint/member-ordering`]               |
@@ -44,6 +45,7 @@
 | [`ban`]                              | 🌟  | [`no-restricted-properties`][no-restricted-properties]                |
 | [`curly`]                            | 🌟  | [`curly`][curly]                                                      |
 | [`forin`]                            | 🌟  | [`guard-for-in`][guard-for-in]                                        |
+| [`function-constructor`]             | 🌟  | [`no-new-func`][no-new-func]                                          |
 | [`import-blacklist`]                 | 🌟  | [`no-restricted-imports`][no-restricted-imports]                      |
 | [`label-position`]                   | 🌟  | [`no-unused-labels`][no-unused-labels] (similar)                      |
 | [`no-arg`]                           | 🌟  | [`no-caller`][no-caller] (also blocks `arguments.caller`)             |
@@ -93,6 +95,7 @@
 | [`switch-default`]                   | 🌟  | [`default-case`][default-case]                                        |
 | [`triple-equals`]                    | 🌟  | [`eqeqeq`][eqeqeq]                                                    |
 | [`typeof-compare`]                   | 🌟  | [`valid-typeof`][valid-typeof]                                        |
+| [`unnecessary-constructor`]          | 🌟  | [`no-useless-constructor`][no-useless-constructor]                    |
 | [`use-default-type-parameter`]       | 🛑  | N/A                                                                   |
 | [`use-isnan`]                        | 🌟  | [`use-isnan`][use-isnan]                                              |
 
@@ -112,6 +115,7 @@
 | [`max-file-line-count`]      | 🌟  | [`max-lines`][max-lines]                           |
 | [`max-line-length`]          | 🌟  | [`max-len`][max-len] or [Prettier]                 |
 | [`no-default-export`]        | 🔌  | [`import/no-default-export`]                       |
+| [`no-default-import`]        | 🛑  | N/A                                                |
 | [`no-duplicate-imports`]     | 🔌  | [`import/no-duplicates`]                           |
 | [`no-mergeable-namespace`]   | 🛑  | N/A                                                |
 | [`no-require-imports`]       | ✅  | [`@typescript-eslint/no-require-imports`]          |
@@ -135,11 +139,13 @@
 | [`callable-types`]                  | ✅  | [`@typescript-eslint/prefer-function-type`]                                         |
 | [`class-name`]                      | ✅  | [`@typescript-eslint/class-name-casing`]                                            |
 | [`comment-format`]                  | 🌟  | [`capitalized-comments`][capitalized-comments] & [`spaced-comment`][spaced-comment] |
+| [`comment-type`]                    | 🛑  | N/A                                                                                 |
 | [`completed-docs`]                  | 🔌  | [`eslint-plugin-jsdoc`][plugin:jsdoc]                                               |
 | [`encoding`]                        | 🛑  | N/A                                                                                 |
 | [`file-header`]                     | 🔌  | [`eslint-plugin-header`][plugin:header] or [`-file-header`][plugin:file-header]     |
 | [`file-name-casing`]                | 🔌  | [`unicorn/filename-case`]                                                           |
 | [`import-spacing`]                  | 🔌  | Use [Prettier]                                                                      |
+| [`increment-decrement`]             | 🌟  | [`no-plusplus`][no-plusplus]                                                        |
 | [`interface-name`]                  | ✅  | [`@typescript-eslint/interface-name-prefix`]                                        |
 | [`interface-over-type-literal`]     | ✅  | [`@typescript-eslint/prefer-interface`]                                             |
 | [`jsdoc-format`]                    | 🌓  | [`valid-jsdoc`][valid-jsdoc] or [`eslint-plugin-jsdoc`][plugin:jsdoc]               |
@@ -176,6 +182,7 @@
 | [`space-within-parens`]             | 🌟  | [`space-in-parens`][space-in-parens]                                                |
 | [`switch-final-break`]              | 🛑  | N/A                                                                                 |
 | [`type-literal-delimiter`]          | ✅  | [`@typescript-eslint/member-delimiter-style`]                                       |
+| [`unnecessary-bind`]                | 🌟  | [`no-extra-bind`][no-extra-bind]                                                    |
 | [`variable-name`]                   | 🌟  | <sup>[2]</sup>                                                                      |
 | [`whitespace`]                      | 🔌  | Use [Prettier]                                                                      |
 
@@ -185,7 +192,7 @@
 ## tslint-microsoft-contrib rules
 
 Rule listing is [here](https://github.com/Microsoft/tslint-microsoft-contrib#supported-rules).
-Deprecated rules are excluded (`missing-jsdoc`, `missing-optional-annotation`, `no-duplicate-case`, `no-duplicate-parameter-names`, `no-increment-decrement`, `no-empty-interfaces`, `no-missing-visibility-modifiers`, `no-multiple-var-decl`, `no-reserved-keywords`, `no-stateless-class`, `no-var-self`, `no-unnecessary-bind`, and `valid-typeof`). See the docs in the link above to find out what to use instead.
+Deprecated rules are excluded (`missing-jsdoc`, `missing-optional-annotation`, `no-duplicate-case`, `no-duplicate-parameter-names`, `no-function-constructor-with-string-args`, `no-increment-decrement`, `no-empty-interfaces`, `no-missing-visibility-modifiers`, `no-multiple-var-decl`, `no-reserved-keywords`, `no-stateless-class`, `no-var-self`, `no-unnecessary-bind`, and `valid-typeof`). See the docs in the link above to find out what to use instead.
 
 ### Testing
 
@@ -254,21 +261,20 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 
 ### Security
 
-| tslint-microsoft-contrib rule              |     | ESLint rule                                        |
-| ------------------------------------------ | :-: | -------------------------------------------------- |
-| `no-disable-auto-sanitization`             | 🛑  | N/A                                                |
-| `no-document-domain`                       | 🌓  | Use [`no-restricted-syntax`][no-restricted-syntax] |
-| `no-function-constructor-with-string-args` | 🌟  | [`no-new-func`][no-new-func]                       |
-| `no-http-string`                           | 🛑  | N/A                                                |
-| `no-inner-html`                            | 🛑  | N/A                                                |
-| `no-string-based-set-immediate`            | 🛑  | N/A                                                |
-| `no-string-based-set-interval`             | 🛑  | N/A                                                |
-| `no-string-based-set-timeout`              | 🛑  | N/A                                                |
-| `react-iframe-missing-sandbox`             | 🛑  | N/A                                                |
-| `react-no-dangerous-html`                  | 🔌  | [`react/no-danger`]                                |
-| `non-literal-fs-path`                      | 🔌  | [`security/detect-non-literal-fs-filename`]        |
-| `non-literal-require`                      | 🔌  | [`security/detect-non-literal-require`]            |
-| `possible-timing-attack`                   | 🔌  | [`security/detect-possible-timing-attacks`]        |
+| tslint-microsoft-contrib rule   |     | ESLint rule                                        |
+| ------------------------------- | :-: | -------------------------------------------------- |
+| `no-disable-auto-sanitization`  | 🛑  | N/A                                                |
+| `no-document-domain`            | 🌓  | Use [`no-restricted-syntax`][no-restricted-syntax] |
+| `no-http-string`                | 🛑  | N/A                                                |
+| `no-inner-html`                 | 🛑  | N/A                                                |
+| `no-string-based-set-immediate` | 🛑  | N/A                                                |
+| `no-string-based-set-interval`  | 🛑  | N/A                                                |
+| `no-string-based-set-timeout`   | 🛑  | N/A                                                |
+| `react-iframe-missing-sandbox`  | 🛑  | N/A                                                |
+| `react-no-dangerous-html`       | 🔌  | [`react/no-danger`]                                |
+| `non-literal-fs-path`           | 🔌  | [`security/detect-non-literal-fs-filename`]        |
+| `non-literal-require`           | 🔌  | [`security/detect-non-literal-require`]            |
+| `possible-timing-attack`        | 🔌  | [`security/detect-possible-timing-attacks`]        |
 
 ### Browser
 
@@ -317,6 +323,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 <!-- TSLint -->
 
 [`adjacent-overload-signatures`]: https://palantir.github.io/tslint/rules/adjacent-overload-signatures
+[`ban-ts-ignore`]: https://palantir.github.io/tslint/rules/ban-ts-ignore/
 [`ban-types`]: https://palantir.github.io/tslint/rules/ban-types
 [`member-access`]: https://palantir.github.io/tslint/rules/member-access
 [`member-ordering`]: https://palantir.github.io/tslint/rules/member-ordering
@@ -343,6 +350,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`ban`]: https://palantir.github.io/tslint/rules/ban
 [`curly`]: https://palantir.github.io/tslint/rules/curly
 [`forin`]: https://palantir.github.io/tslint/rules/forin
+[`function-constructor`]: https://palantir.github.io/tslint/rules/function-constructor
 [`import-blacklist`]: https://palantir.github.io/tslint/rules/import-blacklist
 [`label-position`]: https://palantir.github.io/tslint/rules/label-position
 [`no-arg`]: https://palantir.github.io/tslint/rules/no-arg
@@ -392,6 +400,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`switch-default`]: https://palantir.github.io/tslint/rules/switch-default
 [`triple-equals`]: https://palantir.github.io/tslint/rules/triple-equals
 [`typeof-compare`]: https://palantir.github.io/tslint/rules/typeof-compare
+[`unnecessary-constructor`]: https://palantir.github.io/tslint/rules/unnecessary-constructor
 [`use-default-type-parameter`]: https://palantir.github.io/tslint/rules/use-default-type-parameter
 [`use-isnan`]: https://palantir.github.io/tslint/rules/use-isnan
 [`cyclomatic-complexity`]: https://palantir.github.io/tslint/rules/cyclomatic-complexity
@@ -403,6 +412,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`max-file-line-count`]: https://palantir.github.io/tslint/rules/max-file-line-count
 [`max-line-length`]: https://palantir.github.io/tslint/rules/max-line-length
 [`no-default-export`]: https://palantir.github.io/tslint/rules/no-default-export
+[`no-default-import`]: https://palantir.github.io/tslint/rules/no-default-import
 [`no-duplicate-imports`]: https://palantir.github.io/tslint/rules/no-duplicate-imports
 [`no-mergeable-namespace`]: https://palantir.github.io/tslint/rules/no-mergeable-namespace
 [`no-require-imports`]: https://palantir.github.io/tslint/rules/no-require-imports
@@ -418,11 +428,13 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`callable-types`]: https://palantir.github.io/tslint/rules/callable-types
 [`class-name`]: https://palantir.github.io/tslint/rules/class-name
 [`comment-format`]: https://palantir.github.io/tslint/rules/comment-format
+[`comment-type`]: https://palantir.github.io/tslint/rules/comment-type
 [`completed-docs`]: https://palantir.github.io/tslint/rules/completed-docs
 [`encoding`]: https://palantir.github.io/tslint/rules/encoding
 [`file-header`]: https://palantir.github.io/tslint/rules/file-header
 [`file-name-casing`]: https://palantir.github.io/tslint/rules/file-name-casing
 [`import-spacing`]: https://palantir.github.io/tslint/rules/import-spacing
+[`increment-decrement`]: https://palantir.github.io/tslint/rules/increment-decrement
 [`interface-name`]: https://palantir.github.io/tslint/rules/interface-name
 [`interface-over-type-literal`]: https://palantir.github.io/tslint/rules/interface-over-type-literal
 [`jsdoc-format`]: https://palantir.github.io/tslint/rules/jsdoc-format
@@ -459,6 +471,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`space-within-parens`]: https://palantir.github.io/tslint/rules/space-within-parens
 [`switch-final-break`]: https://palantir.github.io/tslint/rules/switch-final-break
 [`type-literal-delimiter`]: https://palantir.github.io/tslint/rules/type-literal-delimiter
+[`unnecessary-bind`]: https://palantir.github.io/tslint/rules/unnecessary-bind
 [`variable-name`]: https://palantir.github.io/tslint/rules/variable-name
 [`whitespace`]: https://palantir.github.io/tslint/rules/whitespace
 
@@ -471,6 +484,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [no-restricted-syntax]: https://eslint.org/docs/rules/no-restricted-syntax
 [curly]: https://eslint.org/docs/rules/curly
 [guard-for-in]: https://eslint.org/docs/rules/guard-for-in
+[no-new-func]: https://eslint.org/docs/rules/no-new-func
 [no-restricted-imports]: https://eslint.org/docs/rules/no-restricted-imports
 [no-unused-labels]: https://eslint.org/docs/rules/no-unused-labels
 [no-caller]: https://eslint.org/docs/rules/no-caller
@@ -502,6 +516,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [default-case]: https://eslint.org/docs/rules/default-case
 [eqeqeq]: https://eslint.org/docs/rules/eqeqeq
 [valid-typeof]: https://eslint.org/docs/rules/valid-typeof
+[no-useless-constructor]: https://eslint.org/docs/rules/no-useless-constructor
 [use-isnan]: https://eslint.org/docs/rules/use-isnan
 [complexity]: https://eslint.org/docs/rules/complexity
 [eol-last]: https://eslint.org/docs/rules/eol-last
@@ -517,6 +532,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [yoda]: https://eslint.org/docs/rules/yoda
 [capitalized-comments]: https://eslint.org/docs/rules/capitalized-comments
 [spaced-comment]: https://eslint.org/docs/rules/spaced-comment
+[no-plusplus]: https://eslint.org/docs/rules/no-plusplus
 [valid-jsdoc]: https://eslint.org/docs/rules/valid-jsdoc
 [padding-line-between-statements]: https://eslint.org/docs/rules/padding-line-between-statements
 [newline-per-chained-call]: https://eslint.org/docs/rules/newline-per-chained-call
@@ -534,6 +550,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [semi]: https://eslint.org/docs/rules/semi
 [space-after-function-paren]: https://eslint.org/docs/rules/space-before-function-paren
 [space-in-parens]: https://eslint.org/docs/rules/space-in-parens
+[no-extra-bind]: https://eslint.org/docs/rules/no-extra-bind
 [camelcase]: https://eslint.org/docs/rules/camelcase
 [no-underscore-dangle]: https://eslint.org/docs/rules/no-underscore-dangle
 [id-blacklist]: https://eslint.org/docs/rules/id-blacklist
