Merge pull request #123 from arethetypeswrong/dt-utils

Add `resolveImplementationPackageForTypesPackage` util and recognize tsup
arethetypeswrong · Dec 18, 2023 · ed1cd2a · ed1cd2a
2 parents 6c014d8 + 2ccf898
commit ed1cd2a
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 39 deletions.
diff --git a/.changeset/clever-ants-raise.md b/.changeset/clever-ants-raise.md
@@ -0,0 +1,5 @@
+---
+"@arethetypeswrong/core": patch
+---
+
+Add tsup to recognized build tools
diff --git a/.changeset/green-crews-dream.md b/.changeset/green-crews-dream.md
@@ -0,0 +1,5 @@
+---
+"@arethetypeswrong/core": patch
+---
+
+Add `resolveImplementationPackageForTypesPackage` util
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
@@ -9,6 +9,7 @@ $ attw @reduxjs__toolkit@2.0.0-beta.0.tgz -f table-flipped
 Build tools:
 - typescript@~4.9
 - @microsoft/api-extractor@^7.13.2
+- tsup@^6.7.0
 
 🎭 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/core/src/createPackage.ts b/packages/core/src/createPackage.ts
@@ -106,15 +106,10 @@ export async function createPackageFromNpm(
     throw new Error(parsed.error);
   }
   const packageName = parsed.data.name;
-  const specs =
+  const { tarballUrl, packageVersion } =
     parsed.data.versionKind === "none" && typeof definitelyTyped === "string"
-      ? [
-          parsePackageSpec(`${packageName}@${major(definitelyTyped)}.${minor(definitelyTyped)}`).data!,
-          parsePackageSpec(`${packageName}@${major(definitelyTyped)}`).data!,
-          parsePackageSpec(`${packageName}@latest`).data!,
-        ]
-      : [parsed.data];
-  const { tarballUrl, packageVersion } = await getNpmTarballUrl(specs, before);
+      ? await resolveImplementationPackageForTypesPackage(packageName, definitelyTyped, { before })
+      : await getNpmTarballUrl([parsed.data], before);
   const pkg = await createPackageFromTarballUrl(tarballUrl);
   if (!definitelyTyped || pkg.containsTypes()) {
     return pkg;
@@ -143,43 +138,62 @@ export async function createPackageFromNpm(
   return pkg;
 }
 
+export async function resolveImplementationPackageForTypesPackage(
+  typesPackageName: string,
+  typesPackageVersion: string,
+  options?: Pick<CreatePackageFromNpmOptions, "before">,
+): Promise<ResolvedPackageId> {
+  if (!typesPackageName.startsWith("@types/")) {
+    throw new Error(`'resolveImplementationPackageForTypesPackage' expects an @types package name and version`);
+  }
+  const packageName = ts.unmangleScopedPackageName(typesPackageName.slice("@types/".length));
+  return getNpmTarballUrl(
+    [
+      parsePackageSpec(`${packageName}@${major(typesPackageVersion)}.${minor(typesPackageVersion)}`).data!,
+      parsePackageSpec(`${packageName}@${major(typesPackageVersion)}`).data!,
+      parsePackageSpec(`${packageName}@latest`).data!,
+    ],
+    options?.before,
+  );
+}
+
 export async function resolveTypesPackageForPackage(
   packageName: string,
   packageVersion: string,
   before?: Date,
-): Promise<{ packageName: string; packageVersion: string; tarballUrl: string } | undefined> {
+): Promise<ResolvedPackageId | undefined> {
   const typesPackageName = ts.getTypesPackageName(packageName);
   try {
-    return {
-      packageName: typesPackageName,
-      ...(await getNpmTarballUrl(
-        [
-          {
-            name: typesPackageName,
-            versionKind: "range",
-            version: `${major(packageVersion)}.${minor(packageVersion)}`,
-          },
-          {
-            name: typesPackageName,
-            versionKind: "range",
-            version: `${major(packageVersion)}`,
-          },
-          {
-            name: typesPackageName,
-            versionKind: "tag",
-            version: "latest",
-          },
-        ],
-        before,
-      )),
-    };
+    return await getNpmTarballUrl(
+      [
+        {
+          name: typesPackageName,
+          versionKind: "range",
+          version: `${major(packageVersion)}.${minor(packageVersion)}`,
+        },
+        {
+          name: typesPackageName,
+          versionKind: "range",
+          version: `${major(packageVersion)}`,
+        },
+        {
+          name: typesPackageName,
+          versionKind: "tag",
+          version: "latest",
+        },
+      ],
+      before,
+    );
   } catch {}
 }
 
-async function getNpmTarballUrl(
-  packageSpecs: readonly ParsedPackageSpec[],
-  before?: Date,
-): Promise<{ tarballUrl: string; packageVersion: string }> {
+export interface ResolvedPackageId {
+  packageName: string;
+  packageVersion: string;
+  tarballUrl: string;
+}
+
+async function getNpmTarballUrl(packageSpecs: readonly ParsedPackageSpec[], before?: Date): Promise<ResolvedPackageId> {
   const fetchPackument = packageSpecs.some(
     (spec) => spec.versionKind === "range" || (spec.versionKind === "tag" && spec.version !== "latest"),
   );
@@ -227,7 +241,7 @@ async function getNpmTarballUrl(
     }
 
     if (packageVersion && tarballUrl) {
-      return { packageVersion, tarballUrl };
+      return { packageName: packageSpec.name, packageVersion, tarballUrl };
     }
   }
   throw new Error(`Failed to find a matching version for ${packageSpecs[0].name}`);

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -35,7 +35,8 @@ export type BuildTool =
   | "microbundle"
   | "@microsoft/api-extractor"
   | "tshy"
-  | "@rspack/cli";
+  | "@rspack/cli"
+  | "tsup";
 
 export interface Analysis {
   packageName: string;

diff --git a/packages/core/src/utils.ts b/packages/core/src/utils.ts
@@ -166,4 +166,5 @@ export const allBuildTools = Object.keys({
   "@microsoft/api-extractor": true,
   tshy: true,
   "@rspack/cli": true,
+  tsup: true,
 } satisfies Record<BuildTool, any>) as BuildTool[];
diff --git a/packages/core/test/snapshots/@reduxjs__toolkit@2.0.0-beta.0.tgz.json b/packages/core/test/snapshots/@reduxjs__toolkit@2.0.0-beta.0.tgz.json
@@ -6,7 +6,8 @@
   },
   "buildTools": {
     "typescript": "~4.9",
-    "@microsoft/api-extractor": "^7.13.2"
+    "@microsoft/api-extractor": "^7.13.2",
+    "tsup": "^6.7.0"
   },
   "entrypoints": {
     "./package.json": {