Fix type export filtering, update messages

andrewbranch · andrewbranch · commit 24adb9ec5f53 · 2024-08-27T09:30:38.000-07:00
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -74,8 +74,8 @@ particularly ESM-related module resolution issues.`,
   .option("--exclude-entrypoints <entrypoints...>", "Specify entrypoints to exclude from checking.")
   .option(
     "--entrypoints-legacy",
-    'In packages without the `exports` field, every file is an entry point. Specifying this option ' +
-    'only takes effect when no entrypoints are automatically detected, or explicitly provided with other options.'
+    "In packages without the `exports` field, every file is an entry point. Specifying this option " +
+      "only takes effect when no entrypoints are automatically detected, or explicitly provided with other options.",
   )
   .addOption(
     new Option("--ignore-rules <rules...>", "Specify rules to ignore").choices(Object.values(problemFlags)).default([]),
@@ -213,7 +213,7 @@ particularly ESM-related module resolution issues.`,
         result.problems = groupProblemsByKind(analysis.problems);
       }
 
-      console.log(JSON.stringify(result));
+      console.log(JSON.stringify(result, undefined, 2));
 
       if (deleteTgz) {
         await unlink(deleteTgz);
diff --git a/packages/cli/src/render/typed.ts b/packages/cli/src/render/typed.ts
@@ -48,7 +48,9 @@ export async function typed(
     const defaultSummary = marked(!emoji ? " No problems found" : " No problems found 🌟");
     const summaryTexts = Object.keys(grouped).map((kind) => {
       const info = problemKindInfo[kind as core.ProblemKind];
-      const description = marked(`${info.description} ${info.docsUrl}`);
+      const description = marked(
+        `${info.description}${info.details ? ` Use \`--json\` to see ${info.details}.` : ""} ${info.docsUrl}`,
+      );
       return `${emoji ? `${info.emoji} ` : ""}${description}`;
     });
 
diff --git a/packages/cli/test/snapshots/@apollo__client-3.7.16.tgz.md b/packages/cli/test/snapshots/@apollo__client-3.7.16.tgz.md
@@ -12,7 +12,7 @@ Build tools:
 
 👺 Import resolved to an ESM type declaration file, but a CommonJS JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseESM.md
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 
 ┌─────────────────────────────────────────┬────────┬──────────────────────────────┬──────────────────────────────┬─────────┐
diff --git a/packages/cli/test/snapshots/@ice__app@3.2.6.tgz.md b/packages/cli/test/snapshots/@ice__app@3.2.6.tgz.md
@@ -12,7 +12,7 @@ Build tools:
 
 ⚠️ A require call resolved to an ESM JavaScript file, which is an error in Node and some bundlers. CommonJS consumers will need to use a dynamic import. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSResolvesToESM.md
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 💀 Import failed to resolve to type declarations or JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md
 
diff --git a/packages/cli/test/snapshots/@reduxjs__toolkit@2.0.0-beta.0.tgz.md b/packages/cli/test/snapshots/@reduxjs__toolkit@2.0.0-beta.0.tgz.md
@@ -13,7 +13,7 @@ Build tools:
 
 🎭 Import resolved to a CommonJS type declaration file, but an ESM JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 
 ┌─────────────────────────────────┬───────────┬──────────────────────────────┬──────────────────────────────┬──────────────────────────────┐
diff --git a/packages/cli/test/snapshots/postcss@8.4.21.tgz.md b/packages/cli/test/snapshots/postcss@8.4.21.tgz.md
@@ -14,6 +14,8 @@ postcss v8.4.21
 
 ❌ Import resolved to JavaScript files, but no type declarations were found. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md
 
+🕵️ TypeScript allows ESM named imports of the properties of this CommonJS module, but they will crash at runtime because they don’t exist or can’t be statically detected by Node.js in the JavaScript file. Use --json to see the list of exports TypeScript can see but Node.js cannot. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md
+
 
 ┌──────────────────────────────────┬───────────────────────┬───────────────────────┬────────────────────────────┬────────────────────────────┐
 │                                  │ node10                │ node16 (from CJS)     │ node16 (from ESM)          │ bundler                    │
@@ -50,6 +52,7 @@ postcss v8.4.21
 │ "postcss/lib/parser"             │ ❌ No types           │ ❌ No types           │ ❌ No types                │ ❌ No types                │
 ├──────────────────────────────────┼───────────────────────┼───────────────────────┼────────────────────────────┼────────────────────────────┤
 │ "postcss/lib/postcss"            │ ❓ Missing `export =` │ ❓ Missing `export =` │ ❓ Missing `export =`      │ ❓ Missing `export =`      │
+│                                  │                       │                       │ 🕵️ Named exports           │                            │
 ├──────────────────────────────────┼───────────────────────┼───────────────────────┼────────────────────────────┼────────────────────────────┤
 │ "postcss/lib/previous-map"       │ ❓ Missing `export =` │ ❓ Missing `export =` │ ❓ Missing `export =`      │ ❓ Missing `export =`      │
 ├──────────────────────────────────┼───────────────────────┼───────────────────────┼────────────────────────────┼────────────────────────────┤
diff --git a/packages/cli/test/snapshots/vue@3.3.4.tgz --entrypoints . jsx-runtime.md b/packages/cli/test/snapshots/vue@3.3.4.tgz --entrypoints . jsx-runtime.md
@@ -6,7 +6,7 @@ $ attw vue@3.3.4.tgz --entrypoints . jsx-runtime
 
 vue v3.3.4
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 🎭 Import resolved to a CommonJS type declaration file, but an ESM JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md
 
diff --git a/packages/cli/test/snapshots/vue@3.3.4.tgz --entrypoints vue.md b/packages/cli/test/snapshots/vue@3.3.4.tgz --entrypoints vue.md
@@ -6,7 +6,7 @@ $ attw vue@3.3.4.tgz --entrypoints vue
 
 vue v3.3.4
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 
 ┌───────────────────┬──────────────────────────────┐
diff --git a/packages/cli/test/snapshots/vue@3.3.4.tgz --exclude-entrypoints macros -f ascii.md b/packages/cli/test/snapshots/vue@3.3.4.tgz --exclude-entrypoints macros -f ascii.md
@@ -6,7 +6,7 @@ $ attw vue@3.3.4.tgz --exclude-entrypoints macros -f ascii
 
 vue v3.3.4
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 🎭 Import resolved to a CommonJS type declaration file, but an ESM JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md
 
diff --git a/packages/cli/test/snapshots/vue@3.3.4.tgz --include-entrypoints foo -f ascii.md b/packages/cli/test/snapshots/vue@3.3.4.tgz --include-entrypoints foo -f ascii.md
@@ -6,12 +6,14 @@ $ attw vue@3.3.4.tgz --include-entrypoints foo -f ascii
 
 vue v3.3.4
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 🎭 Import resolved to a CommonJS type declaration file, but an ESM JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md
 
 💀 Import failed to resolve to type declarations or JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md
 
+🕵️ TypeScript allows ESM named imports of the properties of this CommonJS module, but they will crash at runtime because they don’t exist or can’t be statically detected by Node.js in the JavaScript file. Use --json to see the list of exports TypeScript can see but Node.js cannot. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md
+
 
 "vue"
 
@@ -89,7 +91,7 @@ bundler: 🟢 (JSON)
 
 node10: 🟢 
 node16 (from CJS): 🟢 (CJS)
-node16 (from ESM): 🟢 (CJS)
+node16 (from ESM): 🕵️ Named exports
 bundler: 🟢 
 
 ***********************************
diff --git a/packages/cli/test/snapshots/vue@3.3.4.tgz.md b/packages/cli/test/snapshots/vue@3.3.4.tgz.md
@@ -6,12 +6,14 @@ $ attw vue@3.3.4.tgz -f table-flipped
 
 vue v3.3.4
 
-🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
+🥴 Import found in a type declaration file failed to resolve. Either this indicates that runtime resolution errors will occur, or (more likely) the types misrepresent the contents of the JavaScript files. Use --json to see the imports that failed to resolve. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/InternalResolutionError.md
 
 🎭 Import resolved to a CommonJS type declaration file, but an ESM JavaScript file. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md
 
 💀 Import failed to resolve to type declarations or JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md
 
+🕵️ TypeScript allows ESM named imports of the properties of this CommonJS module, but they will crash at runtime because they don’t exist or can’t be statically detected by Node.js in the JavaScript file. Use --json to see the list of exports TypeScript can see but Node.js cannot. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NamedExports.md
+
 
 ┌───────────────────────┬──────────────────────┬───────────────────┬──────────────────────────────┬────────────┐
 │                       │ node10               │ node16 (from CJS) │ node16 (from ESM)            │ bundler    │
@@ -32,7 +34,7 @@ vue v3.3.4
 ├───────────────────────┼──────────────────────┼───────────────────┼──────────────────────────────┼────────────┤
 │ "vue/package.json"    │ 🟢 (JSON)            │ 🟢 (JSON)         │ 🟢 (JSON)                    │ 🟢 (JSON)  │
 ├───────────────────────┼──────────────────────┼───────────────────┼──────────────────────────────┼────────────┤
-│ "vue/macros"          │ 🟢                   │ 🟢 (CJS)          │ 🟢 (CJS)                     │ 🟢         │
+│ "vue/macros"          │ 🟢                   │ 🟢 (CJS)          │ 🕵️ Named exports             │ 🟢         │
 ├───────────────────────┼──────────────────────┼───────────────────┼──────────────────────────────┼────────────┤
 │ "vue/macros-global"   │ 🟢                   │ 🟢 (CJS)          │ 🟢 (CJS)                     │ 🟢         │
 ├───────────────────────┼──────────────────────┼───────────────────┼──────────────────────────────┼────────────┤
diff --git a/packages/core/src/internal/checks/namedExports.ts b/packages/core/src/internal/checks/namedExports.ts
diff --git a/packages/core/src/problems.ts b/packages/core/src/problems.ts
diff --git a/packages/core/test/snapshots/postcss@8.4.21.tgz.json b/packages/core/test/snapshots/postcss@8.4.21.tgz.json
diff --git a/packages/core/test/snapshots/vue@3.3.4.tgz.json b/packages/core/test/snapshots/vue@3.3.4.tgz.json
diff --git a/packages/web/src/views/ProblemList.ts b/packages/web/src/views/ProblemList.ts
