@contentful/experience-design-system-cli 2.11.4-dev-build-8f1adf3.0 → 2.11.4-dev-build-8cd3b18.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.11.4-dev-build-8f1adf3.0",
+  "version": "2.11.4-dev-build-8cd3b18.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",

package/dist/src/analyze/extract/svelte.js

@@ -3,7 +3,7 @@ import { readFile } from 'node:fs/promises';
 import { existsSync, statSync } from 'node:fs';
 import os from 'node:os';
 import { parse as parseSvelte } from 'svelte/compiler';
-import { Project, Node } from 'ts-morph';
+import { Project, Node, ScriptTarget, ModuleKind, ts } from 'ts-morph';
 import { computeExtractionScore, deriveNeedsReview } from './scoring.js';
 const SVELTE_EXTRACT_CONCURRENCY = Number(process.env['EDS_EXTRACT_CONCURRENCY'] ?? 0) || os.cpus().length;
 export async function extractSvelteComponents(filePaths, onProgress) {
@@ -71,6 +71,7 @@ async function extractFromSvelteFile(filePath, source) {
     let props = [];
     let propNamesTreatedAsSnippet = new Set();
     let snippetSlotsFromProps = [];
+    const extractionReasons = [];
     if (propsCall) {
         const result = await extractPropsFromCall({
             propsCall,
@@ -84,6 +85,8 @@ async function extractFromSvelteFile(filePath, source) {
         propNamesTreatedAsSnippet = result.snippetNames;
         snippetSlotsFromProps = result.snippetSlots;
         warnings.push(...result.warnings);
+        if (result.additionalReasons)
+            extractionReasons.push(...result.additionalReasons);
     }
     else if (instance) {
         // No $props() call. We've already ruled out v4 above; this means $props was used
@@ -107,11 +110,17 @@ async function extractFromSvelteFile(filePath, source) {
         props,
         slots,
     };
-    // Score & flag review.
-    const score = computeExtractionScore(component);
+    // Score & flag review. Forward extraction-time reasons (e.g. props-type-unresolved)
+    // so they count toward the confidence score AND surface in reviewReasons.
+    const score = computeExtractionScore(component, {
+        additionalIssueCount: extractionReasons.length,
+        additionalReasons: extractionReasons,
+    });
     component.extractionConfidence = score.confidence;
     component.reviewReasons = score.reasons;
-    component.needsReview = deriveNeedsReview(score.confidence);
+    // A type-resolution failure is a strong signal something is wrong; force
+    // human review even when other heuristics keep confidence above the threshold.
+    component.needsReview = deriveNeedsReview(score.confidence) || extractionReasons.includes('props-type-unresolved');
     // Validation issues (EMPTY_COMPONENT_NAME / EMPTY_PROP_NAME / PROP_SLOT_NAME_COLLISION /
     // DUPLICATE_COMPONENT_NAME / EMPTY_COMPONENT / EMPTY_SLOT_NAME) are populated
     // centrally by validateExtractedComponents() in analyze/command.ts after all
@@ -220,19 +229,83 @@ async function extractPropsFromCall(ctx) {
     const typeMembers = annotation
         ? await resolveTypeMembers(annotation, ctx.instance, ctx.moduleScript, ctx.filePath, ctx.source)
         : null;
+    // Detect "we tried to resolve a real type and got nothing back" — distinct from
+    // the user genuinely typing an empty literal. Surface as both a warning (CLI
+    // stderr / analyze report) and a review reason (TUI / downstream gating).
+    const unresolved = classifyUnresolved(annotation, typeMembers, ctx.instance, ctx.moduleScript);
+    const additionalReasons = [];
+    if (unresolved) {
+        const refLabel = describeAnnotationForUser(annotation);
+        const heritageNote = unresolved === 'partial-heritage' ? ' (heritage clauses extending unreachable types)' : '';
+        warnings.push(`${ctx.filePath}: declared Props type ${refLabel} resolved to ${unresolved === 'empty' ? '0' : 'only Snippet-typed'} properties${heritageNote} — possible cross-package extends or unreachable type. ` +
+            `See https://github.com/contentful/experience-design-system-sdk-public/pull/44 for context and partner workarounds.`);
+        additionalReasons.push('props-type-unresolved');
+    }
     if (idType === 'ObjectPattern') {
-        return extractFromDestructure(ctx.propsCall, ctx, typeMembers, warnings);
+        return extractFromDestructure(ctx.propsCall, ctx, typeMembers, warnings, additionalReasons);
     }
     if (idType === 'Identifier') {
         // const props: Props = $props(); — no destructure, no defaults, no per-name binding.
-        if (typeMembers) {
-            return extractFromTypeMembersOnly(typeMembers, ctx.snippetLocals, warnings);
+        if (typeMembers && typeMembers.length > 0) {
+            return { ...extractFromTypeMembersOnly(typeMembers), warnings, additionalReasons };
+        }
+        if (!unresolved) {
+            warnings.push(`${ctx.filePath}: $props() called without destructuring; cannot extract individual props`);
         }
-        warnings.push(`${ctx.filePath}: $props() called without destructuring; cannot extract individual props`);
-        return { props: [], snippetNames: new Set(), snippetSlots: [], warnings };
+        return { props: [], snippetNames: new Set(), snippetSlots: [], warnings, additionalReasons };
     }
     warnings.push(`${ctx.filePath}: unrecognized $props() binding pattern (${idType})`);
-    return { props: [], snippetNames: new Set(), snippetSlots: [], warnings };
+    return { props: [], snippetNames: new Set(), snippetSlots: [], warnings, additionalReasons };
+}
+/**
+ * Classify whether the user's declared Props type failed to resolve usefully.
+ *
+ * - `'empty'`: the resolver returned no members for a non-trivial annotation.
+ * - `'partial-heritage'`: the source declaration has heritage clauses (extends /
+ *   intersection in module-script) but the resolver only surfaced Snippet-typed
+ *   members — strong signal that one or more parents pointed at unreachable
+ *   types (e.g. cross-package node_modules) and were silently dropped.
+ * - `null`: nothing to surface — either the user genuinely typed an empty
+ *   literal, omitted the annotation, or the resolver returned regular props.
+ */
+function classifyUnresolved(annotation, members, instance, moduleScript) {
+    if (!annotation)
+        return null;
+    if (annotation.type === 'TSTypeLiteral') {
+        const litMembers = annotation['members'] ?? [];
+        if (litMembers.length === 0)
+            return null; // user genuinely typed `{}`
+    }
+    if (members === null || members.length === 0)
+        return 'empty';
+    // Partial-heritage signal: declaration has extends and every surviving member
+    // is Snippet-typed. Real prop interfaces almost never declare every prop as a
+    // Snippet, so this is a strong "something fell off the resolution edge" hint.
+    if (annotation.type === 'TSTypeReference') {
+        const refName = annotation['typeName']?.['name'] ?? null;
+        if (refName) {
+            const decl = findLocalTypeDeclaration(instance, refName, moduleScript);
+            if (decl && declarationHasHeritage(decl) && members.every((m) => m.isSnippet)) {
+                return 'partial-heritage';
+            }
+        }
+    }
+    return null;
+}
+function describeAnnotationForUser(annotation) {
+    if (!annotation)
+        return '<unknown>';
+    if (annotation.type === 'TSTypeReference') {
+        const name = annotation['typeName']?.['name'] ?? null;
+        return name ? `'${name}'` : '<unnamed reference>';
+    }
+    if (annotation.type === 'TSIntersectionType')
+        return '<intersection>';
+    if (annotation.type === 'TSUnionType')
+        return '<union>';
+    if (annotation.type === 'TSTypeLiteral')
+        return '<inline literal>';
+    return `<${annotation.type}>`;
 }
 async function resolveTypeMembers(annotation, instance, moduleScript, filePath, source) {
     // Snippet imports may live in either script block; collect from both.
@@ -290,7 +363,13 @@ async function resolveViaTypeChecker(annotation, instance, moduleScript, filePat
     const instanceText = sliceScriptContent(source, instance);
     const synthetic = [moduleText, instanceText, `type __SveltePropsT__ = ${annotationText};`].filter(Boolean).join('\n');
     const project = new Project({
-        compilerOptions: { strict: false, target: 99, module: 99, allowJs: true, jsx: 1 },
+        compilerOptions: {
+            strict: false,
+            target: ScriptTarget.ESNext,
+            module: ModuleKind.ESNext,
+            allowJs: true,
+            jsx: ts.JsxEmit.Preserve,
+        },
         useInMemoryFileSystem: false,
         skipAddingFilesFromTsConfig: true,
     });
@@ -563,7 +642,7 @@ function extractJsdocText(comments) {
 // ---------------------------------------------------------------------------
 // Extraction: ObjectPattern destructure + type-members
 // ---------------------------------------------------------------------------
-function extractFromDestructure(propsCall, ctx, typeMembers, warnings) {
+function extractFromDestructure(propsCall, ctx, typeMembers, warnings, additionalReasons) {
     const id = propsCall['id'];
     const properties = id['properties'] ?? [];
     const typeByName = new Map();
@@ -627,9 +706,10 @@ function extractFromDestructure(propsCall, ctx, typeMembers, warnings) {
         snippetNames,
         snippetSlots,
         warnings,
+        ...(additionalReasons && additionalReasons.length > 0 ? { additionalReasons } : {}),
     };
 }
-function extractFromTypeMembersOnly(typeMembers, _snippetLocals, _warnings) {
+function extractFromTypeMembersOnly(typeMembers) {
     const props = [];
     const snippetNames = new Set();
     const snippetSlots = [];
@@ -759,13 +839,22 @@ function resolveLocalScriptModule(importingFilePath, specifier) {
 }
 function readMembersFromExternalFile(filePath, exportName) {
     const project = new Project({
-        compilerOptions: { strict: false, target: 99, module: 99, allowJs: true },
+        compilerOptions: {
+            strict: false,
+            target: ScriptTarget.ESNext,
+            module: ModuleKind.ESNext,
+            allowJs: true,
+        },
         useInMemoryFileSystem: false,
         skipAddingFilesFromTsConfig: true,
     });
     const sf = project.addSourceFileAtPathIfExists(filePath);
     if (!sf)
         return null;
+    // Collect Snippet locals from the resolved file's own imports so that
+    // aliased imports (`import { Snippet as LocalSnippet } from 'svelte'`) are
+    // honored. Mirrors collectSnippetImportLocals() but adapted to ts-morph.
+    const snippetLocals = collectSnippetLocalsFromSourceFile(sf);
     // Use getExportedDeclarations() so re-export chains (`export { ... } from './x'`,
     // `export * from './x'`, named or namespace) resolve transparently. ts-morph
     // follows them recursively and returns the underlying declaration.
@@ -775,18 +864,39 @@ function readMembersFromExternalFile(filePath, exportName) {
         return null;
     for (const decl of decls) {
         if (Node.isInterfaceDeclaration(decl)) {
-            return readInterfaceMembers(decl);
+            // The declaration may live in a different source file than `sf` if the
+            // export chain walked across files; pull snippet locals from that file
+            // so aliased imports are recognized.
+            const declSf = decl.getSourceFile();
+            const declLocals = declSf === sf ? snippetLocals : collectSnippetLocalsFromSourceFile(declSf);
+            return readInterfaceMembers(decl, declLocals);
         }
         if (Node.isTypeAliasDeclaration(decl)) {
             const typeNode = decl.getTypeNode();
             if (typeNode && Node.isTypeLiteral(typeNode)) {
-                return readTypeLiteralMembers(typeNode);
+                const declSf = decl.getSourceFile();
+                const declLocals = declSf === sf ? snippetLocals : collectSnippetLocalsFromSourceFile(declSf);
+                return readTypeLiteralMembers(typeNode, declLocals);
             }
         }
     }
     return null;
 }
-function readInterfaceMembers(iface) {
+function collectSnippetLocalsFromSourceFile(sf) {
+    const locals = new Set();
+    for (const importDecl of sf.getImportDeclarations()) {
+        if (importDecl.getModuleSpecifierValue() !== 'svelte')
+            continue;
+        for (const named of importDecl.getNamedImports()) {
+            if (named.getName() === 'Snippet') {
+                const aliasNode = named.getAliasNode();
+                locals.add(aliasNode ? aliasNode.getText() : named.getName());
+            }
+        }
+    }
+    return locals;
+}
+function readInterfaceMembers(iface, snippetLocals) {
     return iface.getProperties().map((prop) => {
         const typeNode = prop.getTypeNode();
         const typeText = typeNode ? typeNode.getText() : prop.getType().getText(prop);
@@ -797,7 +907,7 @@ function readInterfaceMembers(iface) {
             name: prop.getName(),
             optional: prop.hasQuestionToken(),
             typeText,
-            isSnippet: typeText === 'Snippet' || /^Snippet</.test(typeText),
+            isSnippet: isSnippetTypeText(typeText, snippetLocals),
             ...(allowed ? { allowedValues: allowed } : {}),
             ...(description ? { description } : {}),
             line: prop.getStartLineNumber(),
@@ -805,7 +915,7 @@ function readInterfaceMembers(iface) {
         };
     });
 }
-function readTypeLiteralMembers(typeNode) {
+function readTypeLiteralMembers(typeNode, snippetLocals) {
     return typeNode.getMembers().flatMap((m) => {
         if (!Node.isPropertySignature(m))
             return [];
@@ -819,7 +929,7 @@ function readTypeLiteralMembers(typeNode) {
                 name: m.getName(),
                 optional: m.hasQuestionToken(),
                 typeText,
-                isSnippet: typeText === 'Snippet' || /^Snippet</.test(typeText),
+                isSnippet: isSnippetTypeText(typeText, snippetLocals),
                 ...(allowed ? { allowedValues: allowed } : {}),
                 ...(description ? { description } : {}),
                 line: m.getStartLineNumber(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.11.4-dev-build-8f1adf3.0",
+  "version": "2.11.4-dev-build-8cd3b18.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",
@@ -37,7 +37,7 @@
     "svelte": "^5.56.4",
     "ts-morph": "^27.0.2",
     "typescript": "^5.9.3",
-    "@contentful/experience-design-system-types": "2.11.4-dev-build-8f1adf3.0"
+    "@contentful/experience-design-system-types": "2.11.4-dev-build-8cd3b18.0"
   },
   "devDependencies": {
     "@tsconfig/node24": "^24.0.3",