feat(experimental-utils): add types for suggestions from CLIEngine (typescript-eslint#1844)

bradzacher · web-flow · commit 7c11bd66f2d0 · 2020-04-03T17:47:29.000-07:00
diff --git a/packages/experimental-utils/src/ts-eslint/Linter.ts b/packages/experimental-utils/src/ts-eslint/Linter.ts
@@ -81,18 +81,26 @@ namespace Linter {
     reportUnusedDisableDirectives?: boolean;
   }
 
+  export interface LintSuggestion {
+    desc: string;
+    fix: RuleFix;
+    messageId?: string;
+  }
+
   export interface LintMessage {
     column: number;
     line: number;
     endColumn?: number;
     endLine?: number;
     ruleId: string | null;
     message: string;
+    messageId?: string;
     nodeType: string;
     fatal?: true;
     severity: Severity;
     fix?: RuleFix;
     source: string | null;
+    suggestions?: LintSuggestion[];
   }
 
   export interface FixOptions extends LintOptions {
diff --git a/packages/experimental-utils/src/ts-eslint/Rule.ts b/packages/experimental-utils/src/ts-eslint/Rule.ts
@@ -129,8 +129,6 @@ interface ReportDescriptorBase<TMessageIds extends string> {
    */
   messageId: TMessageIds;
   // we disallow this because it's much better to use messageIds for reusable errors that are easily testable
-  // message?: string;
-  // suggestions instead have this property that works the same, but again it's much better to use messageIds
   // desc?: string;
 }
 interface ReportDescriptorWithSuggestion<TMessageIds extends string>

Original file line number	Diff line number	Diff line change
`@@ -129,8 +129,6 @@ interface ReportDescriptorBase<TMessageIds extends string> {`
`129`	`129`	`*/`
`130`	`130`	`messageId: TMessageIds;`
`131`	`131`	`// we disallow this because it's much better to use messageIds for reusable errors that are easily testable`
`132`		`- // message?: string;`
`133`		`- // suggestions instead have this property that works the same, but again it's much better to use messageIds`
`134`	`132`	`// desc?: string;`
`135`	`133`	`}`
`136`	`134`	`interface ReportDescriptorWithSuggestion<TMessageIds extends string>`