Type only packages (#144)

* types only build for single package

* format

* monorepo fixture with types only

* refactor build cmd for efficiency

* correct package.json for types only

* test c in simple-monorepo

* skip exports integrity check for types-only

* changeset

Author: enisdenjo

.changeset/tricky-poems-juggle.md

@@ -0,0 +1,5 @@
+---
+"bob-the-bundler": patch
+---
+
+Correct package.json for types-only packages

src/commands/build.ts

@@ -223,53 +223,69 @@ async function build({
     return;
   }
 
-  validatePackageJson(pkg, config?.commonjs ?? true);
-
-  // remove <project>/dist
-  await fse.remove(distPath);
-
-  // Copy type definitions
-  await fse.ensureDir(join(distPath, "typings"));
-
   const declarations = await globby("**/*.d.ts", {
     cwd: getBuildPath("esm"),
     absolute: false,
     ignore: filesToExcludeFromDist,
   });
 
-  await Promise.all(
-    declarations.map((filePath) =>
-      limit(() =>
-        fse.copy(
-          join(getBuildPath("esm"), filePath),
-          join(distPath, "typings", filePath)
-        )
-      )
-    )
-  );
-
-  // Move ESM to dist/esm
-  await fse.ensureDir(join(distPath, "esm"));
-
   const esmFiles = await globby("**/*.js", {
     cwd: getBuildPath("esm"),
     absolute: false,
     ignore: filesToExcludeFromDist,
   });
 
+  // Check whether al esm files are empty, if not - probably a types only build
+  let emptyEsmFiles = true;
+  for (const file of esmFiles) {
+    const src = await fse.readFile(join(getBuildPath("esm"), file));
+    if (src.toString().trim() !== "export {};") {
+      emptyEsmFiles = false;
+      break;
+    }
+  }
+
+  // Empty ESM files with existing declarations is a types-only package
+  const typesOnly = emptyEsmFiles && declarations.length > 0;
+
+  validatePackageJson(pkg, {
+    typesOnly,
+    includesCommonJS: config?.commonjs ?? true,
+  });
+
+  // remove <project>/dist
+  await fse.remove(distPath);
+
+  // Copy type definitions
+  await fse.ensureDir(join(distPath, "typings"));
   await Promise.all(
-    esmFiles.map((filePath) =>
+    declarations.map((filePath) =>
       limit(() =>
         fse.copy(
           join(getBuildPath("esm"), filePath),
-          join(distPath, "esm", filePath)
+          join(distPath, "typings", filePath)
         )
       )
     )
   );
 
-  if (config?.commonjs === undefined) {
-    // Transpile ESM to CJS and move CJS to dist/cjs
+  // If ESM files are not empty, copy them to dist/esm
+  if (!emptyEsmFiles) {
+    await fse.ensureDir(join(distPath, "esm"));
+    await Promise.all(
+      esmFiles.map((filePath) =>
+        limit(() =>
+          fse.copy(
+            join(getBuildPath("esm"), filePath),
+            join(distPath, "esm", filePath)
+          )
+        )
+      )
+    );
+  }
+
+  if (!emptyEsmFiles && config?.commonjs === undefined) {
+    // Transpile ESM to CJS and move CJS to dist/cjs only if there's something to transpile
     await fse.ensureDir(join(distPath, "cjs"));
 
     const cjsFiles = await globby("**/*.js", {
@@ -323,8 +339,9 @@ async function build({
   // move the package.json to dist
   await fse.writeFile(
     join(distPath, "package.json"),
-    JSON.stringify(rewritePackageJson(pkg), null, 2)
+    JSON.stringify(rewritePackageJson(pkg, typesOnly), null, 2)
   );
+
   // move README.md and LICENSE and other specified files
   await copyToDist(
     cwd,
@@ -350,7 +367,7 @@ async function build({
   reporter.success(`Built ${pkg.name}`);
 }
 
-function rewritePackageJson(pkg: Record<string, any>) {
+function rewritePackageJson(pkg: Record<string, any>, typesOnly: boolean) {
   const newPkg: Record<string, any> = {};
   const fields = [
     "name",
@@ -382,19 +399,26 @@ function rewritePackageJson(pkg: Record<string, any>) {
 
   const distDirStr = `${DIST_DIR}/`;
 
-  newPkg.main = newPkg.main.replace(distDirStr, "");
-  newPkg.module = newPkg.module.replace(distDirStr, "");
+  if (typesOnly) {
+    newPkg.main = "";
+    delete newPkg.module;
+    delete newPkg.type;
+  } else {
+    newPkg.main = newPkg.main.replace(distDirStr, "");
+    newPkg.module = newPkg.module.replace(distDirStr, "");
+  }
   newPkg.typings = newPkg.typings.replace(distDirStr, "");
   newPkg.typescript = {
     definition: newPkg.typescript.definition.replace(distDirStr, ""),
   };
 
-  if (!pkg.exports) {
-    newPkg.exports = presetFields.exports;
+  if (!typesOnly) {
+    if (!pkg.exports) {
+      newPkg.exports = presetFields.exports;
+    }
+    newPkg.exports = rewriteExports(pkg.exports, DIST_DIR);
   }
 
-  newPkg.exports = rewriteExports(pkg.exports, DIST_DIR);
-
   if (pkg.bin) {
     newPkg.bin = {};
 
@@ -406,7 +430,13 @@ function rewritePackageJson(pkg: Record<string, any>) {
   return newPkg;
 }
 
-export function validatePackageJson(pkg: any, includesCommonJS: boolean) {
+export function validatePackageJson(
+  pkg: any,
+  opts: {
+    typesOnly: boolean;
+    includesCommonJS: boolean;
+  }
+) {
   function expect(key: string, expected: unknown) {
     const received = get(pkg, key);
 
@@ -418,13 +448,23 @@ export function validatePackageJson(pkg: any, includesCommonJS: boolean) {
     );
   }
 
+  // Type only packages have simpler rules (following the style of https://github.com/DefinitelyTyped/DefinitelyTyped packages)
+  if (opts.typesOnly) {
+    expect("main", "");
+    expect("module", undefined);
+    expect("typings", presetFields.typings);
+    expect("typescript.definition", presetFields.typescript.definition);
+    expect("exports", undefined);
+    return;
+  }
+
   // If the package has NO binary we need to check the exports map.
   // a package should either
   // 1. have a bin property
   // 2. have a exports property
   // 3. have an exports and bin property
   if (Object.keys(pkg.bin ?? {}).length > 0) {
-    if (includesCommonJS === true) {
+    if (opts.includesCommonJS === true) {
       expect("main", presetFields.main);
       expect("module", presetFields.module);
       expect("typings", presetFields.typings);
@@ -442,7 +482,7 @@ export function validatePackageJson(pkg: any, includesCommonJS: boolean) {
     pkg.typings !== undefined ||
     pkg.typescript !== undefined
   ) {
-    if (includesCommonJS === true) {
+    if (opts.includesCommonJS === true) {
       // if there is no bin property, we NEED to check the exports.
       expect("main", presetFields.main);
       expect("module", presetFields.module);

src/commands/check.ts

@@ -88,6 +88,17 @@ export const checkCommand = createCommand<{}, {}>((api) => {
             const distPackageJSONPath = path.join(cwd, "dist", "package.json");
             const distPackageJSON = await fse.readJSON(distPackageJSONPath);
 
+            // a tell for a types-only build is the lack of main import and presence of typings
+            if (
+              distPackageJSON.main === "" &&
+              (distPackageJSON.typings || "").endsWith("d.ts")
+            ) {
+              api.reporter.warn(
+                `Skip check for '${packageJSON.name}' because it's a types-only package.`
+              );
+              return;
+            }
+
             try {
               await checkExportsMapIntegrity({
                 cwd: path.join(cwd, "dist"),

test/__fixtures__/simple-monorepo/packages/c/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "c",
+  "main": "",
+  "typings": "dist/typings/index.d.ts",
+  "typescript": {
+    "definition": "dist/typings/index.d.ts"
+  },
+  "buildOptions": {
+    "input": "./src/index.ts"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  }
+}

test/__fixtures__/simple-monorepo/packages/c/src/index.ts

@@ -0,0 +1,3 @@
+export type SomeType = "type";
+
+export interface SomeInterface {}

test/__fixtures__/simple-types-only/README.md

@@ -0,0 +1 @@
+Hi types!

test/__fixtures__/simple-types-only/foo.json

@@ -0,0 +1 @@
+{ "hi": 1 }

test/__fixtures__/simple-types-only/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "simple-types-only",
+  "main": "",
+  "typings": "dist/typings/index.d.ts",
+  "typescript": {
+    "definition": "dist/typings/index.d.ts"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  },
+  "type": "module",
+  "bob": {
+    "build": {
+      "copy": [
+        "foo.json",
+        "src/style.css"
+      ]
+    },
+    "check": {
+      "skip": [
+        "./file-that-throws"
+      ]
+    }
+  }
+}

test/__fixtures__/simple-types-only/src/index.ts

@@ -0,0 +1,3 @@
+export type SomeType = "type";
+
+export interface SomeInterface {}

test/__fixtures__/simple-types-only/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "dist"
+  }
+}