@mintlify/cli 4.0.1740 → 4.0.1742

package/src/validate/output.tsx

@@ -4,6 +4,11 @@ import { Box, Text } from 'ink';
 import type { Report } from './report.js';
 import type { Diagnostic } from './types.js';
 
+const preview = (value: string) => {
+  const text = JSON.stringify(value);
+  return text.length > 60 ? `${text.slice(0, 57)}..."` : text;
+};
+
 const location = ({ line, column }: Pick<Diagnostic, 'line' | 'column'>) =>
   line ? `${line}${column ? `:${column}` : ''}` : '';
 
@@ -27,6 +32,14 @@ const DiagnosticLine = ({ diagnostic }: { diagnostic: Diagnostic }) => {
 const plural = (count: number, word: string) => `${count} ${word}${count === 1 ? '' : 's'}`;
 
 export const logReport = (report: Report) => {
+  for (const change of report.fixed ?? []) {
+    addLog(
+      <SuccessLog
+        message={`fixed ${change.file}${change.line ? `:${change.line}` : ''} ${change.rule}: ${preview(change.before)} → ${preview(change.after)}`}
+      />
+    );
+  }
+
   const byFile = new Map<string, Diagnostic[]>();
   for (const diagnostic of report.diagnostics) {
     byFile.get(diagnostic.file)?.push(diagnostic) ?? byFile.set(diagnostic.file, [diagnostic]);
@@ -42,6 +55,11 @@ export const logReport = (report: Report) => {
     );
   }
 
+  const fixable = report.diagnostics.filter(({ fix }) => fix).length;
+  if (fixable > 0 && !report.fixed) {
+    addLog(<InfoLog message={`\`--fix\` would fix ${plural(fixable, 'issue')}.`} />);
+  }
+
   const { build } = report;
   if (build.ran && build.passed) addLog(<SuccessLog message="build passed" />);
   else if (build.ran && report.passed)

package/src/validate/report.ts

@@ -1,4 +1,4 @@
-import type { Diagnostic } from './types.js';
+import type { Change, Diagnostic } from './types.js';
 
 export type BuildStatus =
   | { ran: true; passed: boolean }
@@ -9,9 +9,15 @@ export type Report = {
   summary: { errors: number; warnings: number; byRule: Record<string, number> };
   diagnostics: Diagnostic[];
   build: BuildStatus;
+  /** With --fix: the edits that were applied. */
+  fixed?: Change[];
 };
 
-export const toReport = (diagnostics: Diagnostic[], build: BuildStatus): Report => {
+export const toReport = (
+  diagnostics: Diagnostic[],
+  build: BuildStatus,
+  fixed?: Change[]
+): Report => {
   const byRule: Record<string, number> = {};
   for (const { rule } of diagnostics) byRule[rule] = (byRule[rule] ?? 0) + 1;
   const errors = diagnostics.filter(({ severity }) => severity === 'error').length;
@@ -29,5 +35,6 @@ export const toReport = (diagnostics: Diagnostic[], build: BuildStatus): Report
       ...(fix && { fix }),
     })),
     build,
+    ...(fixed && { fixed }),
   };
 };

package/src/validate/types.ts

@@ -11,6 +11,16 @@ export type Edit = { start: number; end: number; text: string };
 
 export type FileEdit = Edit & { file: string };
 
+/** A fix --fix applied: where it was and the text it replaced. */
+export type Change = {
+  rule: string;
+  file: string;
+  line?: number;
+  column?: number;
+  before: string;
+  after: string;
+};
+
 export type Diagnostic = {
   rule: string;
   group: Group;