feat(eslint-plugin): update types to allow parameter type inferrence (#272)

mohsen1 · bradzacher · commit 80bd72c96944 · 2019-02-18T15:33:41.000-08:00
By adding a all of the possible members with specific RuleFunction type
this is allowing rule authors to write rules without specifying
parameter types in their token methods

Also updates all of the existing rules to not specify type of node when
it is inferred
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -147,7 +147,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSArrayType(node: TSESTree.TSArrayType) {
+      TSArrayType(node) {
         if (
           option === 'array' ||
           (option === 'array-simple' && isSimpleType(node.elementType))
diff --git a/packages/eslint-plugin/src/rules/camelcase.ts b/packages/eslint-plugin/src/rules/camelcase.ts
@@ -89,7 +89,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      Identifier(node: TSESTree.Identifier) {
+      Identifier(node) {
         /*
          * Leading and trailing underscores are commonly used to flag
          * private/protected identifiers, strip them
diff --git a/packages/eslint-plugin/src/rules/generic-type-naming.ts b/packages/eslint-plugin/src/rules/generic-type-naming.ts
@@ -2,7 +2,6 @@
  * @fileoverview Enforces naming of generic type variables.
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 type Options = [string?];
@@ -34,7 +33,7 @@ export default util.createRule<Options, MessageIds>({
     const regex = new RegExp(rule!);
 
     return {
-      TSTypeParameter(node: TSESTree.TSTypeParameter) {
+      TSTypeParameter(node) {
         const name = node.name.name;
 
         if (name && !regex.test(name)) {
diff --git a/packages/eslint-plugin/src/rules/interface-name-prefix.ts b/packages/eslint-plugin/src/rules/interface-name-prefix.ts
@@ -3,7 +3,6 @@
  * @author Danny Fritz
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 type Options = ['never' | 'always'];
@@ -45,7 +44,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSInterfaceDeclaration(node: TSESTree.TSInterfaceDeclaration): void {
+      TSInterfaceDeclaration(node): void {
         if (never) {
           if (isPrefixedWithI(node.id.name)) {
             context.report({
diff --git a/packages/eslint-plugin/src/rules/member-ordering.ts b/packages/eslint-plugin/src/rules/member-ordering.ts
@@ -353,28 +353,28 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      ClassDeclaration(node: TSESTree.ClassDeclaration) {
+      ClassDeclaration(node) {
         validateMembers(
           node.body.body,
           options.classes || options.default!,
           true
         );
       },
-      ClassExpression(node: TSESTree.ClassExpression) {
+      ClassExpression(node) {
         validateMembers(
           node.body.body,
           options.classExpressions || options.default!,
           true
         );
       },
-      TSInterfaceDeclaration(node: TSESTree.TSInterfaceDeclaration) {
+      TSInterfaceDeclaration(node) {
         validateMembers(
           node.body.body,
           options.interfaces || options.default!,
           false
         );
       },
-      TSTypeLiteral(node: TSESTree.TSTypeLiteral) {
+      TSTypeLiteral(node) {
         validateMembers(
           node.members,
           options.typeLiterals || options.default!,
diff --git a/packages/eslint-plugin/src/rules/no-angle-bracket-type-assertion.ts b/packages/eslint-plugin/src/rules/no-angle-bracket-type-assertion.ts
@@ -3,7 +3,6 @@
  * @author Patricio Trevino
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 export default util.createRule({
@@ -27,7 +26,7 @@ export default util.createRule({
   create(context) {
     const sourceCode = context.getSourceCode();
     return {
-      TSTypeAssertion(node: TSESTree.TSTypeAssertion) {
+      TSTypeAssertion(node) {
         context.report({
           node,
           messageId: 'preferAs',
diff --git a/packages/eslint-plugin/src/rules/no-empty-interface.ts b/packages/eslint-plugin/src/rules/no-empty-interface.ts
@@ -3,7 +3,6 @@
  * @author Patricio Trevino
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 type Options = [
@@ -47,7 +46,7 @@ export default util.createRule<Options, MessageIds>({
   ],
   create(context, [{ allowSingleExtends }]) {
     return {
-      TSInterfaceDeclaration(node: TSESTree.TSInterfaceDeclaration) {
+      TSInterfaceDeclaration(node) {
         if (node.body.body.length !== 0) {
           // interface contains members --> Nothing to report
           return;
diff --git a/packages/eslint-plugin/src/rules/no-extraneous-class.ts b/packages/eslint-plugin/src/rules/no-extraneous-class.ts
@@ -57,7 +57,7 @@ export default util.createRule<Options, MessageIds>({
   ],
   create(context, [{ allowConstructorOnly, allowEmpty, allowStaticOnly }]) {
     return {
-      ClassBody(node: TSESTree.ClassBody) {
+      ClassBody(node) {
         const parent = node.parent as
           | TSESTree.ClassDeclaration
           | TSESTree.ClassExpression
diff --git a/packages/eslint-plugin/src/rules/no-for-in-array.ts b/packages/eslint-plugin/src/rules/no-for-in-array.ts
@@ -3,7 +3,6 @@
  * @author Benjamin Lichtman
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import ts from 'typescript';
 import * as util from '../util';
 
@@ -26,7 +25,7 @@ export default util.createRule({
   defaultOptions: [],
   create(context) {
     return {
-      ForInStatement(node: TSESTree.ForInStatement) {
+      ForInStatement(node) {
         const parserServices = util.getParserServices(context);
         const checker = parserServices.program.getTypeChecker();
         const originalNode = parserServices.esTreeNodeToTSNodeMap.get<
diff --git a/packages/eslint-plugin/src/rules/no-non-null-assertion.ts b/packages/eslint-plugin/src/rules/no-non-null-assertion.ts
@@ -3,7 +3,6 @@
  * @author Macklin Underdown
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 export default util.createRule({
@@ -25,7 +24,7 @@ export default util.createRule({
   defaultOptions: [],
   create(context) {
     return {
-      TSNonNullExpression(node: TSESTree.TSNonNullExpression) {
+      TSNonNullExpression(node) {
         context.report({
           node,
           messageId: 'noNonNull'
diff --git a/packages/eslint-plugin/src/rules/no-parameter-properties.ts b/packages/eslint-plugin/src/rules/no-parameter-properties.ts
@@ -84,7 +84,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSParameterProperty(node: TSESTree.TSParameterProperty) {
+      TSParameterProperty(node) {
         const modifiers = getModifiers(node);
 
         if (allows.indexOf(modifiers) === -1) {
diff --git a/packages/eslint-plugin/src/rules/no-require-imports.ts b/packages/eslint-plugin/src/rules/no-require-imports.ts
@@ -30,7 +30,7 @@ export default util.createRule({
           messageId: 'noRequireImports'
         });
       },
-      TSExternalModuleReference(node: TSESTree.TSExternalModuleReference) {
+      TSExternalModuleReference(node) {
         context.report({
           node,
           messageId: 'noRequireImports'
diff --git a/packages/eslint-plugin/src/rules/no-triple-slash-reference.ts b/packages/eslint-plugin/src/rules/no-triple-slash-reference.ts
@@ -3,7 +3,6 @@
  * @author Danny Fritz
  */
 
-import { TSESTree } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 export default util.createRule({
@@ -27,7 +26,7 @@ export default util.createRule({
     const sourceCode = context.getSourceCode();
 
     return {
-      Program(program: TSESTree.Program): void {
+      Program(program): void {
         const commentsBefore = sourceCode.getCommentsBefore(program);
 
         commentsBefore.forEach(comment => {
diff --git a/packages/eslint-plugin/src/rules/no-type-alias.ts b/packages/eslint-plugin/src/rules/no-type-alias.ts
@@ -290,7 +290,7 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSTypeAliasDeclaration(node: TSESTree.TSTypeAliasDeclaration) {
+      TSTypeAliasDeclaration(node) {
         if (isComposition(node.typeAnnotation)) {
           validateCompositions(node.typeAnnotation);
         } else {
diff --git a/packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts b/packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts
@@ -158,13 +158,13 @@ export default util.createRule<Options, MessageIds>({
     const checker = parserServices.program.getTypeChecker();
 
     return {
-      TSNonNullExpression(node: TSESTree.TSNonNullExpression) {
+      TSNonNullExpression(node) {
         checkNonNullAssertion(node, checker);
       },
-      TSTypeAssertion(node: TSESTree.TSTypeAssertion) {
+      TSTypeAssertion(node) {
         verifyCast(node, checker);
       },
-      TSAsExpression(node: TSESTree.TSAsExpression) {
+      TSAsExpression(node) {
         verifyCast(node, checker);
       }
     };
diff --git a/packages/eslint-plugin/src/rules/no-useless-constructor.ts b/packages/eslint-plugin/src/rules/no-useless-constructor.ts
@@ -61,7 +61,7 @@ export default util.createRule<Options, MessageIds>({
   create(context) {
     const rules = baseRule.create(context);
     return {
-      MethodDefinition(node: TSESTree.MethodDefinition) {
+      MethodDefinition(node) {
         if (
           node.value &&
           node.value.type === AST_NODE_TYPES.FunctionExpression &&
diff --git a/packages/eslint-plugin/src/rules/no-var-requires.ts b/packages/eslint-plugin/src/rules/no-var-requires.ts
@@ -3,7 +3,7 @@
  * @author Macklin Underdown
  */
 
-import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/typescript-estree';
+import { AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
 type Options = [];
@@ -28,7 +28,7 @@ export default util.createRule<Options, MessageIds>({
   defaultOptions: [],
   create(context) {
     return {
-      CallExpression(node: TSESTree.CallExpression) {
+      CallExpression(node) {
         if (
           node.callee.type === AST_NODE_TYPES.Identifier &&
           node.callee.name === 'require' &&
diff --git a/packages/eslint-plugin/src/rules/prefer-function-type.ts b/packages/eslint-plugin/src/rules/prefer-function-type.ts
@@ -147,7 +147,7 @@ export default util.createRule({
     }
 
     return {
-      TSInterfaceDeclaration(node: TSESTree.TSInterfaceDeclaration) {
+      TSInterfaceDeclaration(node) {
         if (!hasOneSupertype(node) && node.body.body.length === 1) {
           checkMember(node.body.body[0], node);
         }
diff --git a/packages/eslint-plugin/src/rules/prefer-namespace-keyword.ts b/packages/eslint-plugin/src/rules/prefer-namespace-keyword.ts
@@ -6,8 +6,7 @@
 
 import {
   AST_NODE_TYPES,
-  AST_TOKEN_TYPES,
-  TSESTree
+  AST_TOKEN_TYPES
 } from '@typescript-eslint/typescript-estree';
 import * as util from '../util';
 
@@ -34,7 +33,7 @@ export default util.createRule({
     const sourceCode = context.getSourceCode();
 
     return {
-      TSModuleDeclaration(node: TSESTree.TSModuleDeclaration) {
+      TSModuleDeclaration(node) {
         // Do nothing if the name is a string.
         if (!node.id || node.id.type === AST_NODE_TYPES.Literal) {
           return;
diff --git a/packages/eslint-plugin/src/rules/type-annotation-spacing.ts b/packages/eslint-plugin/src/rules/type-annotation-spacing.ts
@@ -192,12 +192,12 @@ export default util.createRule<Options, MessageIds>({
     }
 
     return {
-      TSMappedType(node: TSESTree.TSMappedType) {
+      TSMappedType(node) {
         if (node.typeAnnotation) {
           checkTypeAnnotationSpacing(node.typeAnnotation);
         }
       },
-      TSTypeAnnotation(node: TSESTree.TSTypeAnnotation) {
+      TSTypeAnnotation(node) {
         checkTypeAnnotationSpacing(node.typeAnnotation);
       }
     };
diff --git a/packages/eslint-plugin/typings/ts-eslint.d.ts b/packages/eslint-plugin/typings/ts-eslint.d.ts

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ export default util.createRule<Options, MessageIds>({`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`return {`
`150`		`- TSArrayType(node: TSESTree.TSArrayType) {`
	`150`	`+ TSArrayType(node) {`
`151`	`151`	`if (`
`152`	`152`	`option === 'array' \|\|`
`153`	`153`	`(option === 'array-simple' && isSimpleType(node.elementType))`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ export default util.createRule<Options, MessageIds>({`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`return {`
`92`		`- Identifier(node: TSESTree.Identifier) {`
	`92`	`+ Identifier(node) {`
`93`	`93`	`/*`
`94`	`94`	`* Leading and trailing underscores are commonly used to flag`
`95`	`95`	`* private/protected identifiers, strip them`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ export default util.createRule<Options, MessageIds>({`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`return {`
`87`		`- TSParameterProperty(node: TSESTree.TSParameterProperty) {`
	`87`	`+ TSParameterProperty(node) {`
`88`	`88`	`const modifiers = getModifiers(node);`
`89`	`89`
`90`	`90`	`if (allows.indexOf(modifiers) === -1) {`
Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ export default util.createRule<Options, MessageIds>({`
`290`	`290`	`}`
`291`	`291`
`292`	`292`	`return {`
`293`		`- TSTypeAliasDeclaration(node: TSESTree.TSTypeAliasDeclaration) {`
	`293`	`+ TSTypeAliasDeclaration(node) {`
`294`	`294`	`if (isComposition(node.typeAnnotation)) {`
`295`	`295`	`validateCompositions(node.typeAnnotation);`
`296`	`296`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -192,12 +192,12 @@ export default util.createRule<Options, MessageIds>({`
`192`	`192`	`}`
`193`	`193`
`194`	`194`	`return {`
`195`		`- TSMappedType(node: TSESTree.TSMappedType) {`
	`195`	`+ TSMappedType(node) {`
`196`	`196`	`if (node.typeAnnotation) {`
`197`	`197`	`checkTypeAnnotationSpacing(node.typeAnnotation);`
`198`	`198`	`}`
`199`	`199`	`},`
`200`		`- TSTypeAnnotation(node: TSESTree.TSTypeAnnotation) {`
	`200`	`+ TSTypeAnnotation(node) {`
`201`	`201`	`checkTypeAnnotationSpacing(node.typeAnnotation);`
`202`	`202`	`}`
`203`	`203`	`};`