Diagnostic path log relative to current working dir

.chronus/changes/diag-path-relative-2024-9-21-16-52-22.md

@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: feature
+packages:
+  - "@typespec/compiler"
+---
+
+CLI logs diagnostic source path relative to the CWD.

packages/compiler/src/core/cli/utils.ts

@@ -54,8 +54,9 @@
 }
 
 export function createCLICompilerHost(options: CliHostArgs): CliCompilerHost {
-  const logSink = createConsoleSink({ pretty: options.pretty });
+  const logSink = createConsoleSink({ pretty: options.pretty, pathRelativeTo: process.cwd() });
   const logger = createLogger({ sink: logSink, level: options.debug ? "trace" : "warning" });
+  console.log("Abc");
   return { ...NodeHost, logSink, logger, debug: options.debug ?? false };
 }
 

packages/compiler/src/core/diagnostics.ts

@@ -41,7 +41,12 @@ export function logDiagnostics(diagnostics: readonly Diagnostic[], logger: LogSi
   }
 }
 
-export function formatDiagnostic(diagnostic: Diagnostic) {
+export interface FormatDiagnosticOptions {
+  readonly pretty?: boolean;
+  readonly pathRelativeTo?: string;
+}
+
+export function formatDiagnostic(diagnostic: Diagnostic, options: FormatDiagnosticOptions = {}) {
   return formatLog(
     {
       code: diagnostic.code,
@@ -50,7 +55,7 @@ export function formatDiagnostic(diagnostic: Diagnostic) {
       url: diagnostic.url,
       sourceLocation: getSourceLocation(diagnostic.target, { locateId: true }),
     },
-    { pretty: false },
+    { pretty: options?.pretty ?? false, pathRelativeTo: options?.pathRelativeTo },
   );
 }
 

packages/compiler/src/core/logger/console-sink.ts

@@ -1,10 +1,12 @@
 import { codeFrameColumns } from "@babel/code-frame";
+import { relative } from "path/posix";
 import pc from "picocolors";
 import { Formatter } from "picocolors/types.js";
 import { LogLevel, LogSink, ProcessedLog, SourceLocation } from "../types.js";
 import { supportsHyperlink } from "./support-hyperlinks.js";
 
 export interface FormatLogOptions {
+  pathRelativeTo?: string;
   pretty?: boolean;
 }
 
@@ -60,8 +62,11 @@ function formatLevel(options: FormatLogOptions, level: LogLevel) {
 
 function formatSourceLocation(options: FormatLogOptions, location: SourceLocation) {
   const postition = getLineAndColumn(location);
-  const path = color(options, location.file.path, pc.cyan);
+  const prePath = options.pathRelativeTo
+    ? relative(process.cwd(), location.file.path)
+    : location.file.path;
 
+  const path = color(options, prePath, pc.cyan);
   const line = color(options, postition.start.line.toString(), pc.yellow);
   const column = color(options, postition.start.column.toString(), pc.yellow);
   return `${path}:${line}:${column}`;

packages/compiler/src/testing/expect.ts

@@ -14,7 +14,7 @@ export function expectDiagnosticEmpty(diagnostics: readonly Diagnostic[]) {
 }
 
 function formatDiagnostics(diagnostics: readonly Diagnostic[]) {
-  return diagnostics.map(formatDiagnostic).join("\n");
+  return diagnostics.map((x) => formatDiagnostic(x)).join("\n");
 }
 /**
  * Condition to match

packages/compiler/test/parser.test.ts

@@ -1423,7 +1423,7 @@ function parseEach(cases: (string | [string, Callback])[], options?: ParseOption
 
       logVerboseTestOutput("\n=== Diagnostics ===");
       if (astNode.parseDiagnostics.length > 0) {
-        const diagnostics = astNode.parseDiagnostics.map(formatDiagnostic).join("\n");
+        const diagnostics = astNode.parseDiagnostics.map((x) => formatDiagnostic(x)).join("\n");
         assert.strictEqual(
           hasParseError(astNode),
           astNode.parseDiagnostics.some((e) => e.severity === "error"),

packages/http-server-javascript/src/common/scalar.ts

@@ -94,7 +94,7 @@ function createScalarsMap(program: Program): Map<Scalar, string> {
 
   for (const [[type, diagnostics]] of entries) {
     if (!type) {
-      const diagnosticString = diagnostics.map(formatDiagnostic).join("\n");
+      const diagnosticString = diagnostics.map((x) => formatDiagnostic(x)).join("\n");
       throw new Error(`failed to construct TypeSpec -> JavaScript scalar map: ${diagnosticString}`);
     } else if (type.kind !== "Scalar") {
       throw new Error(

packages/protobuf/src/transform/index.ts

@@ -380,7 +380,7 @@ function tspToProto(program: Program, emitterOptions: ProtobufEmitterOptions): P
 
     if (!emptyType) {
       throw new Error(
-        `Could not resolve the empty type: ${diagnostics.map(formatDiagnostic).join("\n")}`,
+        `Could not resolve the empty type: ${diagnostics.map((x) => formatDiagnostic(x)).join("\n")}`,
       );
     }
 
@@ -609,7 +609,7 @@ function tspToProto(program: Program, emitterOptions: ProtobufEmitterOptions): P
 
       for (const [[type, diagnostics]] of entries) {
         if (!type) {
-          const diagnosticString = diagnostics.map(formatDiagnostic).join("\n");
+          const diagnosticString = diagnostics.map((x) => formatDiagnostic(x)).join("\n");
           throw new Error(
             `Failed to construct TypeSpec -> Protobuf scalar map. Unexpected failure to resolve TypeSpec scalar: ${diagnosticString}`,
           );

packages/protobuf/test/scenarios.test.ts

@@ -168,7 +168,7 @@ async function doEmit(
         .filter(([name]) => name.startsWith(baseOutputPath))
         .map(([name, value]) => [name.replace(baseOutputPath, ""), value]),
     ),
-    diagnostics: diagnostics.map(formatDiagnostic),
+    diagnostics: diagnostics.map((x) => formatDiagnostic(x)),
   };
 }