🤖 Merge PR #58333 [eslint] Support async formatters by @fasttime

DefinitelyTyped · Jan 22, 2022 · ff28e2b · ff28e2b
1 parent 15738a6
commit ff28e2b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/types/eslint/eslint-tests.ts b/types/eslint/eslint-tests.ts
@@ -682,6 +682,9 @@ let formatterPromise: Promise<ESLint.Formatter>;
 formatterPromise = eslint.loadFormatter("codeframe");
 formatterPromise = eslint.loadFormatter();
 
+const customFormatter1: ESLint.Formatter = { format: () => "ok" };
+const customFormatter2: ESLint.Formatter = { format: () => Promise.resolve("ok") };
+
 let data: ESLint.LintResultData;
 const meta: Rule.RuleMetaData = {
     type: "suggestion",
@@ -702,9 +705,12 @@ data = { cwd: "/foo/bar", rulesMeta: { "no-extra-semi": meta } };
 
 const version: string = ESLint.version;
 
-resultsPromise.then(results => {
-    formatterPromise.then(formatter => formatter.format(results));
-    formatterPromise.then(formatter => formatter.format(results, data));
+(async () => {
+    const results = await resultsPromise;
+    const formatter = await formatterPromise;
+
+    const output1: string = await formatter.format(results);
+    const output2: string = await formatter.format(results, data);
 
     eslint.getRulesMetaForResults(results);
 
@@ -732,7 +738,7 @@ resultsPromise.then(results => {
             message.ruleId = "foo";
         }
     }
-});
+})();
 
 //#endregion
 

diff --git a/types/eslint/index.d.ts b/types/eslint/index.d.ts
@@ -884,7 +884,7 @@ export namespace ESLint {
     }
 
     interface Formatter {
-        format(results: LintResult[], data?: LintResultData): string;
+        format(results: LintResult[], data?: LintResultData): string | Promise<string>;
     }
 
     // Docs reference the type by this name