chore(eslint-plugin): deprecate no-unused-public-signature

It is being superseded by explicit-module-boundary-types.
typescript-eslint · Dec 22, 2019 · 21a581a · 21a581a
1 parent 65a75b0
commit 21a581a
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 4 deletions.
diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
@@ -141,7 +141,6 @@ Pro Tip: For larger codebases you may want to consider splitting our linting int
 | [`@typescript-eslint/no-unnecessary-qualifier`](./docs/rules/no-unnecessary-qualifier.md)                 | Warns when a namespace qualifier is unnecessary                                                                                                     |                    | :wrench: | :thought_balloon: |
 | [`@typescript-eslint/no-unnecessary-type-arguments`](./docs/rules/no-unnecessary-type-arguments.md)       | Warns if an explicitly specified type argument is the default for that type parameter                                                               |                    | :wrench: | :thought_balloon: |
 | [`@typescript-eslint/no-unnecessary-type-assertion`](./docs/rules/no-unnecessary-type-assertion.md)       | Warns if a type assertion does not change the type of an expression                                                                                 | :heavy_check_mark: | :wrench: | :thought_balloon: |
-| [`@typescript-eslint/no-untyped-public-signature`](./docs/rules/no-untyped-public-signature.md)           | Requires that all public method arguments and return type will be explicitly typed                                                                  |                    |          |                   |
 | [`@typescript-eslint/no-unused-expressions`](./docs/rules/no-unused-expressions.md)                       | Disallow unused expressions                                                                                                                         |                    |          |                   |
 | [`@typescript-eslint/no-unused-vars`](./docs/rules/no-unused-vars.md)                                     | Disallow unused variables                                                                                                                           | :heavy_check_mark: |          |                   |
 | [`@typescript-eslint/no-unused-vars-experimental`](./docs/rules/no-unused-vars-experimental.md)           | Disallow unused variables and arguments.                                                                                                            |                    |          | :thought_balloon: |

diff --git a/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md b/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md
@@ -1,4 +1,4 @@
-# Require explicit return type on exported functions and exported classes` public class methods (explicit-module-boundary-types)
+# Require explicit return type on exported functions' and exporte classes' public class methods (explicit-module-boundary-types)
 
 Explicit types for function return values makes it clear to any calling code what is the module boundary's output.
 

diff --git a/packages/eslint-plugin/src/configs/all.json b/packages/eslint-plugin/src/configs/all.json
@@ -56,7 +56,6 @@
     "@typescript-eslint/no-unnecessary-qualifier": "error",
     "@typescript-eslint/no-unnecessary-type-arguments": "error",
     "@typescript-eslint/no-unnecessary-type-assertion": "error",
-    "@typescript-eslint/no-untyped-public-signature": "error",
     "no-unused-expressions": "off",
     "@typescript-eslint/no-unused-expressions": "error",
     "no-unused-vars": "off",

diff --git a/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts b/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts
@@ -21,7 +21,7 @@ export default util.createRule<Options, MessageIds>({
     type: 'problem',
     docs: {
       description:
-        'Require explicit return types on exported functions and exported classes` public class methods',
+        "Require explicit return types on exported functions' and exported classes' public class methods",
       category: 'Stylistic Issues',
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/no-untyped-public-signature.ts b/packages/eslint-plugin/src/rules/no-untyped-public-signature.ts
@@ -11,6 +11,8 @@ type Options = [{ ignoredMethods: string[] }];
 export default util.createRule<Options, MessageIds>({
   name: 'no-unused-public-signature',
   meta: {
+    deprecated: true,
+    replacedBy: ['explicit-module-boundary-types'],
     docs: {
       description:
         'Requires that all public method arguments and return type will be explicitly typed',