From 7c11bd66f2d0e5ea9d3943e6b8c66e6ddff50862 Mon Sep 17 00:00:00 2001
From: Brad Zacher <brad.zacher@gmail.com>
Date: Fri, 3 Apr 2020 17:47:29 -0700
Subject: [PATCH] feat(experimental-utils): add types for suggestions from
 CLIEngine (#1844)

---
 packages/experimental-utils/src/ts-eslint/Linter.ts | 8 ++++++++
 packages/experimental-utils/src/ts-eslint/Rule.ts   | 2 --
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/packages/experimental-utils/src/ts-eslint/Linter.ts b/packages/experimental-utils/src/ts-eslint/Linter.ts
index 0233f2f8408..5363059b14d 100644
--- a/packages/experimental-utils/src/ts-eslint/Linter.ts
+++ b/packages/experimental-utils/src/ts-eslint/Linter.ts
@@ -81,6 +81,12 @@ namespace Linter {
     reportUnusedDisableDirectives?: boolean;
   }
 
+  export interface LintSuggestion {
+    desc: string;
+    fix: RuleFix;
+    messageId?: string;
+  }
+
   export interface LintMessage {
     column: number;
     line: number;
@@ -88,11 +94,13 @@ namespace Linter {
     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
index 1f74150292e..8301947ee6b 100644
--- 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>