refactor(ts-estree): improve definition of parameters (typescript-eslint#209)

armano2 · web-flow · commit c1abae9cbe05 · 2019-02-05T01:38:55.000+01:00
- add missing tests for decorators
diff --git a/packages/parser/tests/lib/__snapshots__/typescript.ts.snap b/packages/parser/tests/lib/__snapshots__/typescript.ts.snap
diff --git a/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-array-pattern-decorator.src.ts b/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-array-pattern-decorator.src.ts
@@ -0,0 +1,3 @@
+class Foo {
+  bar(@special(true) [ bar ]: any) {}
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-object-pattern-decorator.src.ts b/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-object-pattern-decorator.src.ts
@@ -0,0 +1,3 @@
+class Foo {
+  bar(@special(true) { bar }: any) {}
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-rest-element-decorator.src.ts b/packages/shared-fixtures/fixtures/typescript/decorators/parameter-decorators/parameter-rest-element-decorator.src.ts
@@ -0,0 +1,3 @@
+class Foo {
+  bar(@special(true) ...foo: any) {}
+}
diff --git a/packages/shared-fixtures/fixtures/typescript/errorRecovery/decorator-on-function.src.ts b/packages/shared-fixtures/fixtures/typescript/errorRecovery/decorator-on-function.src.ts
@@ -0,0 +1,2 @@
+@dec
+function b(){}
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -282,18 +282,19 @@ export class Converter {
    */
   private convertParameters(
     parameters: ts.NodeArray<ts.ParameterDeclaration>
-  ): (es.TSParameterProperty | es.RestElement | es.AssignmentPattern)[] {
+  ): es.Parameter[] {
     if (!parameters || !parameters.length) {
       return [];
     }
     return parameters.map(param => {
-      const convertedParam = this.convertChild(param);
-      if (!param.decorators || !param.decorators.length) {
-        return convertedParam;
+      const convertedParam = this.convertChild(param) as es.Parameter;
+
+      if (param.decorators && param.decorators.length) {
+        convertedParam.decorators = param.decorators.map(el =>
+          this.convertChild(el)
+        );
       }
-      return Object.assign(convertedParam, {
-        decorators: param.decorators.map(el => this.convertChild(el))
-      });
+      return convertedParam;
     });
   }
 
diff --git a/packages/typescript-estree/src/typedefs.ts b/packages/typescript-estree/src/typedefs.ts
@@ -351,7 +351,13 @@ export type ObjectLiteralElementLike =
   | RestElement
   | SpreadElement
   | TSAbstractMethodDefinition;
-export type Parameter = AssignmentPattern | RestElement | TSParameterProperty;
+export type Parameter =
+  | AssignmentPattern
+  | RestElement
+  | ArrayPattern
+  | ObjectPattern
+  | Identifier
+  | TSParameterProperty;
 export type PrimaryExpression =
   | ArrayExpression
   | ArrayPattern
@@ -541,6 +547,7 @@ export interface ArrayPattern extends BaseNode {
   elements: Expression[];
   typeAnnotation?: TSTypeAnnotation;
   optional?: boolean;
+  decorators?: Decorator[];
 }
 
 export interface ArrowFunctionExpression extends BaseNode {
@@ -565,6 +572,7 @@ export interface AssignmentPattern extends BaseNode {
   right?: Expression;
   typeAnnotation?: TSTypeAnnotation;
   optional?: boolean;
+  decorators?: Decorator[];
 }
 
 export interface AwaitExpression extends BaseNode {
@@ -715,6 +723,7 @@ export interface Identifier extends BaseNode {
   name: string;
   typeAnnotation?: TSTypeAnnotation;
   optional?: boolean;
+  decorators?: Decorator[];
 }
 
 export interface IfStatement extends BaseNode {
@@ -875,6 +884,7 @@ export interface ObjectPattern extends BaseNode {
   properties: ObjectLiteralElementLike[];
   typeAnnotation?: TSTypeAnnotation;
   optional?: boolean;
+  decorators?: Decorator[];
 }
 
 export interface Program extends BaseNode {
@@ -901,6 +911,7 @@ export interface RestElement extends BaseNode {
   typeAnnotation?: TSTypeAnnotation;
   optional?: boolean;
   value?: AssignmentPattern;
+  decorators?: Decorator[];
 }
 
 export interface ReturnStatement extends BaseNode {
@@ -1218,6 +1229,7 @@ export interface TSParameterProperty extends BaseNode {
   static?: boolean;
   export?: boolean;
   parameter: AssignmentPattern | BindingName | RestElement;
+  decorators?: Decorator[];
 }
 
 export interface TSParenthesizedType extends BaseNode {
diff --git a/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts b/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts
@@ -396,7 +396,15 @@ tester.addFixturePatternConfig('typescript/decorators/method-decorators', {
   fileType: 'ts'
 });
 tester.addFixturePatternConfig('typescript/decorators/parameter-decorators', {
-  fileType: 'ts'
+  fileType: 'ts',
+  ignore: [
+    /**
+     * babel does not support decorators on array and rest parameters
+     * TODO: report this to babel
+     */
+    'parameter-array-pattern-decorator',
+    'parameter-rest-element-decorator'
+  ]
 });
 tester.addFixturePatternConfig('typescript/decorators/property-decorators', {
   fileType: 'ts'
diff --git a/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.ts.snap
@@ -2236,6 +2236,8 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/method-decorators/method-decorator-static-member.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-array-pattern-decorator.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-decorator-constructor.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-decorator-decorator-instance-member.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
@@ -2246,6 +2248,10 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-decorator-static-member.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-object-pattern-decorator.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/parameter-decorators/parameter-rest-element-decorator.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/property-decorators/property-decorator-factory-instance-member.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/decorators/property-decorators/property-decorator-factory-static-member.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
@@ -2299,6 +2305,15 @@ Object {
 }
 `;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/errorRecovery/decorator-on-function.src 1`] = `
+Object {
+  "column": 0,
+  "index": 0,
+  "lineNumber": 1,
+  "message": "Decorators are not valid here.",
+}
+`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/errorRecovery/decorator-on-interface-declaration.src 1`] = `
 Object {
   "column": 0,
diff --git a/packages/typescript-estree/tests/lib/__snapshots__/typescript.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/typescript.ts.snap

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+class Foo {`
	`2`	`+ bar(@special(true) [ bar ]: any) {}`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+class Foo {`
	`2`	`+ bar(@special(true) { bar }: any) {}`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+class Foo {`
	`2`	`+ bar(@special(true) ...foo: any) {}`
	`3`	`+}`