feat(check-types), introduce --json flag (#9614)

Author: davidfirst

scopes/typescript/ts-server/format-diagnostics.ts

@@ -1,6 +1,6 @@
 import { DiagnosticMessageChain, server } from 'typescript';
 
-type Diagnostic = server.protocol.Diagnostic;
+export type Diagnostic = server.protocol.Diagnostic;
 
 /**
  * mostly taken from ts repo, src/compiler/program.ts "formatDiagnosticsWithColorAndContext" method.

scopes/typescript/ts-server/ts-server-client.ts

@@ -9,20 +9,27 @@ import { findPathToModule } from './modules-resolver';
 import { ProcessBasedTsServer } from './process-based-tsserver';
 import { CommandTypes, EventName } from './tsp-command-types';
 import { getTsserverExecutable } from './utils';
-import { formatDiagnostic } from './format-diagnostics';
+import { formatDiagnostic, Diagnostic } from './format-diagnostics';
 
 export type TsserverClientOpts = {
   verbose?: boolean; // print tsserver events to the console.
   tsServerPath?: string; // if not provided, it'll use findTsserverPath() strategies.
   checkTypes?: CheckTypes; // whether errors/warnings are monitored and printed to the console.
   printTypeErrors?: boolean; // whether print typescript errors to the console.
+  aggregateDiagnosticData?: boolean; // whether to aggregate diagnostic data instead of printing them to the console.
 };
 
+export type DiagnosticData = {
+  file: string;
+  diagnostic: Diagnostic;
+  formatted: string;
+}
+
 export class TsserverClient {
   private tsServer: ProcessBasedTsServer | null;
   public lastDiagnostics: ts.server.protocol.DiagnosticEventBody[] = [];
   private serverRunning = false;
-
+  public diagnosticData: DiagnosticData[] = [];
   constructor(
     /**
      * absolute root path of the project.
@@ -306,12 +313,24 @@ export class TsserverClient {
   }
 
   private publishDiagnostic(message: ts.server.protocol.DiagnosticEvent) {
-    if (!message.body?.diagnostics.length || !this.options.printTypeErrors) {
+    if (!message.body?.diagnostics.length || (!this.options.printTypeErrors && !this.options.aggregateDiagnosticData)) {
       return;
     }
     this.lastDiagnostics.push(message.body);
     const file = path.relative(this.projectPath, message.body.file);
-    message.body.diagnostics.forEach((diag) => this.logger.console(formatDiagnostic(diag, file)));
+    message.body.diagnostics.forEach((diag) => {
+      const formatted = formatDiagnostic(diag, file);
+      if (this.options.printTypeErrors) {
+        this.logger.console(formatted);
+      }
+      if (this.options.aggregateDiagnosticData) {
+        this.diagnosticData.push({
+          file,
+          diagnostic: diag,
+          formatted,
+        });
+      }
+    });
   }
 
   /**

scopes/typescript/typescript/cmds/check-types.cmd.ts

@@ -14,6 +14,7 @@ export class CheckTypesCmd implements Command {
   options = [
     ['a', 'all', 'check-types for all components, not only modified and new'],
     ['', 'strict', 'in case issues found, exit with code 1'],
+    ['j', 'json', 'return the output in json format'],
   ] as CommandOptions;
 
   constructor(
@@ -46,4 +47,26 @@ export class CheckTypesCmd implements Command {
       data: chalk.green(`${msg}. no errors were found.`),
     };
   }
+
+  async json([pattern]: [string], { all = false, strict = false }: { all: boolean; strict: boolean }) {
+    if (!this.workspace) throw new OutsideWorkspaceError();
+    const components = await this.workspace.getComponentsByUserInput(all, pattern);
+    const files = this.typescript.getSupportedFilesForTsserver(components);
+    await this.typescript.initTsserverClientFromWorkspace({ aggregateDiagnosticData: true }, files);
+    const tsserver = this.typescript.getTsserverClient();
+    if (!tsserver) throw new Error(`unable to start tsserver`);
+    await tsserver.getDiagnostic(files);
+    const diagData = tsserver.diagnosticData;
+    tsserver.killTsServer();
+    if (tsserver.lastDiagnostics.length) {
+      return {
+        code: strict ? 1 : 0,
+        data: diagData,
+      };
+    }
+    return {
+      code: 0,
+      data: diagData,
+    };
+  }
 }