@cms-lab/core 1.2.5 → 1.2.6

package/dist/index.d.ts

@@ -160,10 +160,21 @@ type ScanSummary = {
     warnings: number;
     info: number;
 };
+type DiagnosticGroupSummary = {
+    key: string;
+    severity: DiagnosticSeverity;
+    code: string;
+    count: number;
+    label: string;
+    type?: string;
+    routePattern?: string;
+    examples: string[];
+};
 type ScanResult = {
     project: ProjectInfo;
     documents: CMSDocument[];
     diagnostics: Diagnostic[];
+    diagnosticGroups?: DiagnosticGroupSummary[];
     summary: ScanSummary;
 };
 type FetchLike = typeof fetch;
@@ -222,4 +233,4 @@ type ScanDocumentsOptions = {
 declare function scanDocuments(options: ScanDocumentsOptions): Promise<ScanResult>;
 declare function resolveSiteHealthUrl(site: CmsLabConfig["site"]): URL;
 
-export { type CMSDocument, type CMSDocumentStatus, type CheckGroup, CmsFetchError, type CmsFieldMappingConfig, type CmsLabConfig, CmsLabError, type CmsProviderConfig, ConfigLoadError, type ContentfulCmsProviderConfig, type ContentfulContentTypeConfig, type Diagnostic, type DiagnosticExplanation, type DiagnosticSeverity, type DirectusCmsProviderConfig, type DirectusCollectionConfig, type FetchLike, type LoadedCmsLabConfig, type PrismicCmsProviderConfig, type ProjectInfo, type RelationshipRule, type RequiredFieldRule, type RouteDefinition, type SanityCmsProviderConfig, type SanityContentTypeConfig, type ScanDocumentsOptions, type ScanFilters, type ScanResult, type ScanSummary, SiteUnreachableError, type StrapiCmsProviderConfig, type StrapiCollectionConfig, type StrapiLocaleConfig, type StrapiSingleTypeConfig, type WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, readCmsDataPath, resolveSiteHealthUrl, scanDocuments, strapiRelationSlug, strapiRelationValue, summarizeDiagnostics, validateConfig };
+export { type CMSDocument, type CMSDocumentStatus, type CheckGroup, CmsFetchError, type CmsFieldMappingConfig, type CmsLabConfig, CmsLabError, type CmsProviderConfig, ConfigLoadError, type ContentfulCmsProviderConfig, type ContentfulContentTypeConfig, type Diagnostic, type DiagnosticExplanation, type DiagnosticGroupSummary, type DiagnosticSeverity, type DirectusCmsProviderConfig, type DirectusCollectionConfig, type FetchLike, type LoadedCmsLabConfig, type PrismicCmsProviderConfig, type ProjectInfo, type RelationshipRule, type RequiredFieldRule, type RouteDefinition, type SanityCmsProviderConfig, type SanityContentTypeConfig, type ScanDocumentsOptions, type ScanFilters, type ScanResult, type ScanSummary, SiteUnreachableError, type StrapiCmsProviderConfig, type StrapiCollectionConfig, type StrapiLocaleConfig, type StrapiSingleTypeConfig, type WordPressCmsProviderConfig, type WordPressContentTypeConfig, createDiagnostic, defineConfig, explainDiagnostic, listDiagnosticExplanations, loadCmsLabConfig, readCmsDataPath, resolveSiteHealthUrl, scanDocuments, strapiRelationSlug, strapiRelationValue, summarizeDiagnostics, validateConfig };

package/dist/index.js

@@ -443,6 +443,11 @@ async function scanDocuments(options) {
     project: options.project,
     documents,
     diagnostics,
+    diagnosticGroups: summarizeDiagnosticGroups(
+      diagnostics,
+      options.config,
+      routeCandidates
+    ),
     summary: summarizeDiagnostics(diagnostics)
   };
 }
@@ -773,6 +778,80 @@ function checkRelationships(config, documents) {
 function relationshipRules(config) {
   return config.checks?.relationships ?? [];
 }
+function summarizeDiagnosticGroups(diagnostics, config, routeCandidates) {
+  const routePatternBySource = new Map(
+    routeCandidates.map((candidate) => [
+      sourceFor(config, candidate.document),
+      candidate.route.pattern
+    ])
+  );
+  const groups = /* @__PURE__ */ new Map();
+  for (const diagnostic of diagnostics) {
+    const type = typeFromSource(diagnostic.source);
+    const routePattern = routePatternForDiagnostic(
+      diagnostic,
+      type,
+      config,
+      routePatternBySource
+    );
+    const key = diagnosticGroupKey(diagnostic, type, routePattern);
+    const existing = groups.get(key);
+    const example = diagnosticExample(diagnostic);
+    if (existing) {
+      existing.count += 1;
+      if (example && !existing.examples.includes(example)) {
+        existing.examples.push(example);
+      }
+      existing.examples = existing.examples.slice(0, 3);
+      continue;
+    }
+    groups.set(key, {
+      key,
+      severity: diagnostic.severity,
+      code: diagnostic.code,
+      count: 1,
+      ...type ? { type } : {},
+      ...routePattern ? { routePattern } : {},
+      label: diagnosticGroupLabel(type, routePattern),
+      examples: example ? [example] : []
+    });
+  }
+  return [...groups.values()];
+}
+function routePatternForDiagnostic(diagnostic, type, config, routePatternBySource) {
+  if (!isRouteDiagnostic(diagnostic.code) && diagnostic.code !== "CMS-UID-MISSING") {
+    return void 0;
+  }
+  if (diagnostic.source) {
+    const routePattern = routePatternBySource.get(diagnostic.source);
+    if (routePattern) {
+      return routePattern;
+    }
+  }
+  return type ? config.routes.find((route) => route.type === type)?.pattern : void 0;
+}
+function isRouteDiagnostic(code) {
+  return code.startsWith("CMS-ROUTE");
+}
+function diagnosticGroupKey(diagnostic, type, routePattern) {
+  return [diagnostic.severity, diagnostic.code, type, routePattern].filter(Boolean).join(":");
+}
+function diagnosticGroupLabel(type, routePattern) {
+  if (type && routePattern) {
+    return `${type} ${routePattern}`;
+  }
+  return type ?? "project";
+}
+function diagnosticExample(diagnostic) {
+  return diagnostic.path ?? diagnostic.source ?? diagnostic.message;
+}
+function typeFromSource(source) {
+  if (!source) {
+    return void 0;
+  }
+  const match = /^[^:]+:([^#]+)#/.exec(source);
+  return match?.[1];
+}
 function hasRelationshipMatch(fromValues, toValues) {
   if (fromValues.length === 0 || toValues.length === 0) {
     return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms-lab/core",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "type": "module",
   "description": "Core config, scan, diagnostics, and checks for cms-lab.",
   "license": "MIT",