Merge pull request #82 from arethetypeswrong/build-tools

Report build tools detected in package.json

Author: andrewbranch

.changeset/moody-dancers-nail.md

@@ -0,0 +1,5 @@
+---
+"@arethetypeswrong/cli": minor
+---
+
+Report relevant build tools detected in package.json `devDependencies`

.changeset/thin-moles-sort.md

@@ -0,0 +1,5 @@
+---
+"@arethetypeswrong/core": minor
+---
+
+Add `buildTools` property to `Analysis` (a pick of `devDependencies`)

packages/cli/src/render/typed.ts

@@ -21,6 +21,23 @@ export async function typed(analysis: core.Analysis, opts: Opts) {
     headerIds: false,
   });
 
+  console.log(`${analysis.packageName} v${analysis.packageVersion}`);
+  if (analysis.types.kind === "@types") {
+    console.log(`${analysis.types.packageName} v${analysis.types.packageVersion}`);
+  }
+  console.log();
+  if (Object.keys(analysis.buildTools).length) {
+    console.log("Build tools:");
+    console.log(
+      Object.entries(analysis.buildTools)
+        .map(([tool, version]) => {
+          return `- ${tool}@${version}`;
+        })
+        .join("\n")
+    );
+    console.log();
+  }
+
   if (opts.ignoreRules && opts.ignoreRules.length) {
     console.log(
       chalk.gray(
@@ -31,12 +48,6 @@ export async function typed(analysis: core.Analysis, opts: Opts) {
     );
   }
 
-  console.log(`${analysis.packageName} v${analysis.packageVersion}`);
-  if (analysis.types.kind === "@types") {
-    console.log(`${analysis.types.packageName} v${analysis.types.packageVersion}`);
-  }
-  console.log();
-
   if (opts.summary) {
     const defaultSummary = marked(!opts.emoji ? " No problems found" : " No problems found 🌟");
     const summaryTexts = Object.keys(grouped).map((kind) => {

packages/cli/test/snapshots/@apollo__client-3.7.16.tgz.md

@@ -6,6 +6,10 @@ $ attw @apollo__client-3.7.16.tgz -f table-flipped
 
 @apollo/client v3.7.16
 
+Build tools:
+- [email protected]
+- [email protected]
+
 👺 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
 
 ⚠️ 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

packages/cli/test/snapshots/@[email protected]

@@ -6,6 +6,10 @@ $ attw @[email protected] -f table-flipped
 
 @ice/app v3.2.6
 
+Build tools:
+- webpack@^5.86.0
+- esbuild@^0.17.16
+
 ⚠️ 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 failed to resolve to type declarations or JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md

packages/cli/test/snapshots/@[email protected]

@@ -6,6 +6,10 @@ $ attw @[email protected] -f table-flipped
 
 @reduxjs/toolkit v2.0.0-beta.0
 
+Build tools:
+- typescript@~4.9
+- @microsoft/api-extractor@^7.13.2
+
 🎭 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

packages/cli/test/snapshots/[email protected]

@@ -6,6 +6,11 @@ $ attw [email protected] -f table-flipped
 
 ajv v8.12.0
 
+Build tools:
+- typescript@^4.8.0
+- rollup@^2.44.0
+- @rollup/plugin-typescript@^10.0.1
+
  No problems found 🌟
 
 

packages/cli/test/snapshots/[email protected]

@@ -6,6 +6,10 @@ $ attw [email protected] -f table-flipped
 
 axios v1.4.0
 
+Build tools:
+- typescript@^4.8.4
+- rollup@^2.67.0
+
 ❓ Wildcard subpaths cannot yet be analyzed by this tool. https://github.com/arethetypeswrong/arethetypeswrong.github.io/issues/40
 
 💀 Import failed to resolve to type declarations or JavaScript files. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md

packages/cli/test/snapshots/[email protected] -f table.md

@@ -6,6 +6,9 @@ $ attw [email protected] -f table
 
 commander v10.0.1
 
+Build tools:
+- typescript@^4.9.4
+
 🎭 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 resolved to JavaScript files, but no type declarations were found. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/UntypedResolution.md

packages/cli/test/snapshots/[email protected]

@@ -6,6 +6,9 @@ $ attw [email protected] -f table-flipped
 
 node-html-parser v6.1.5
 
+Build tools:
+- typescript@latest
+
 🤨 CommonJS module simulates a default export with exports.default and exports.__esModule, but does not also set module.exports for compatibility with Node. Node, and some bundlers under certain conditions (https://andrewbranch.github.io/interop-test/#synthesizing-default-exports-for-cjs-modules), do not respect the __esModule marker, so accessing the intended default export will require a .default property access on the default import. https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/CJSOnlyExportsDefault.md