feat(turbo-utils): convert package to dual ESM/CommonJS build

This commit converts turbo-utils from a TypeScript-only package to a dual
ESM/CommonJS package with proper build outputs, addressing compatibility
requirements across different module systems.

Key changes:
- Package.json: Added "type": "module" and dual export configuration with
  separate entry points for ESM, CommonJS, and TypeScript declarations
- Build system: Implemented three-stage build process (ESM, CJS, types) with
  corresponding TypeScript configurations
- Import statements: Updated all relative imports to include .js extensions
  for ESM compatibility
- Module handling: Fixed imports for packages like tar, fast-glob, and
  picocolors to work with ESM
- Jest configuration: Added module name mapping to handle .js extension
  resolution in tests
- TypeScript configs: Created separate tsconfig files for ESM (tsconfig.json),
  CommonJS (tsconfig.cjs.json), and type declarations (tsconfig.types.json)

Build outputs:
- dist/esm/: ES module build for modern environments
- dist/cjs/: CommonJS build for Node.js compatibility
- dist/types/: TypeScript declaration files

The package now supports both import and require syntax while maintaining
backward compatibility through the dual export system.

update

Author: tknickman

packages/eslint-plugin-turbo/lib/utils/calculate-inputs.ts

@@ -2,9 +2,8 @@ import crypto from "node:crypto";
 import fs from "node:fs";
 import path from "node:path";
 import type { WorkspaceConfig } from "@turbo/utils";
-import { getWorkspaceConfigs } from "@turbo/utils";
+import { getWorkspaceConfigs, forEachTaskDef } from "@turbo/utils";
 import type { PipelineV1, RootSchemaV1, RootSchemaV2 } from "@turbo/types";
-import { forEachTaskDef } from "@turbo/utils/src/getTurboConfigs";
 import { dotEnv } from "./dotenv-processing";
 import { wildcardTests } from "./wildcard-processing";
 

packages/turbo-utils/.eslintrc.js renamed to packages/turbo-utils/.eslintrc.cjs

@@ -7,6 +7,9 @@ const config = {
   transformIgnorePatterns: ["/node_modules/(?!(ansi-regex)/)"],
   verbose: process.env.RUNNER_DEBUG === "1",
   silent: process.env.RUNNER_DEBUG !== "1",
+  moduleNameMapper: {
+    "^(\\./.+)\\.js$": "$1",
+  },
 } as const satisfies Config;
 
 export default config;

packages/turbo-utils/jest.config.ts

@@ -15,10 +15,24 @@
   "bugs": {
     "url": "https://github.com/vercel/turborepo/issues"
   },
-  "module": "src/index.ts",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
   "scripts": {
+    "build": "pnpm build:esm && pnpm build:cjs && pnpm build:types && pnpm post-build",
+    "post-build": "echo '{ \"type\": \"commonjs\" }' > dist/cjs/package.json",
+    "build:esm": "tsc -p tsconfig.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
     "test": "jest",
     "lint": "eslint src/",
     "check-types": "tsc --noEmit",

packages/turbo-utils/package.json

@@ -2,18 +2,18 @@ import path from "node:path";
 import retry from "async-retry";
 import picocolors from "picocolors";
 import fs from "fs-extra";
-import * as logger from "./logger";
+import * as logger from "./logger.js";
 import {
   downloadAndExtractExample,
   downloadAndExtractRepo,
   getRepoInfo,
   existsInRepo,
   hasRepo,
   type RepoInfo,
-} from "./examples";
-import { isWriteable } from "./isWriteable";
-import { isFolderEmpty } from "./isFolderEmpty";
-import type { PackageJson } from "./types";
+} from "./examples.js";
+import { isWriteable } from "./isWriteable.js";
+import { isFolderEmpty } from "./isFolderEmpty.js";
+import type { PackageJson } from "./types.js";
 
 function isErrorLike(err: unknown): err is { message: string } {
   return (

packages/turbo-utils/src/createProject.ts

@@ -3,9 +3,11 @@ import { promisify } from "node:util";
 import { join } from "node:path";
 import { tmpdir } from "node:os";
 import { createWriteStream, promises as fs } from "node:fs";
-import { x as extract } from "tar";
+import tar from "tar";
 import got from "got";
 
+const { x: extract } = tar;
+
 const pipeline = promisify(Stream.pipeline);
 
 export interface RepoInfo {

packages/turbo-utils/src/examples.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import yaml from "js-yaml";
-import { sync } from "fast-glob";
+import glob from "fast-glob";
 import JSON5 from "json5";
 import type {
   BaseSchemaV1,
@@ -10,9 +10,11 @@ import type {
   BaseSchemaV2,
   PipelineV2,
 } from "@turbo/types";
-import * as logger from "./logger";
-import { getTurboRoot } from "./getTurboRoot";
-import type { PackageJson, PNPMWorkspaceConfig } from "./types";
+import * as logger from "./logger.js";
+import { getTurboRoot } from "./getTurboRoot.js";
+import type { PackageJson, PNPMWorkspaceConfig } from "./types.js";
+
+const { sync } = glob;
 
 const ROOT_GLOB = "{turbo.json,turbo.jsonc}";
 const ROOT_WORKSPACE_GLOB = "package.json";
@@ -115,7 +117,7 @@ export function getTurboConfigs(cwd?: string, opts?: Options): TurboConfigs {
   if (turboRoot) {
     const workspaceGlobs = getWorkspaceGlobs(turboRoot);
     const workspaceConfigGlobs = workspaceGlobs.map(
-      (glob) => `${glob}/${ROOT_GLOB}`
+      (workspaceGlob) => `${workspaceGlob}/${ROOT_GLOB}`
     );
 
     const configPaths = sync([ROOT_GLOB, ...workspaceConfigGlobs], {
@@ -200,7 +202,7 @@ export function getWorkspaceConfigs(
   if (turboRoot) {
     const workspaceGlobs = getWorkspaceGlobs(turboRoot);
     const workspaceConfigGlobs = workspaceGlobs.map(
-      (glob) => `${glob}/package.json`
+      (workspaceGlob) => `${workspaceGlob}/package.json`
     );
 
     const configPaths = sync([ROOT_WORKSPACE_GLOB, ...workspaceConfigGlobs], {

packages/turbo-utils/src/getTurboConfigs.ts

@@ -1,14 +1,13 @@
 import type { Schema } from "@turbo/types";
 import { findRootSync } from "@manypkg/find-root";
 import json5 from "json5";
-import { searchUp } from "./searchUp";
+import { searchUp } from "./searchUp.js";
 
 interface Options {
   cache?: boolean;
 }
 
 function contentCheck(content: string): boolean {
-  // eslint-disable-next-line import/no-named-as-default-member -- json5 exports different objects depending on if you're using esm or cjs (https://github.com/json5/json5/issues/240)
   const result: Schema | undefined = json5.parse(content);
   return !(result && "extends" in result);
 }

packages/turbo-utils/src/getTurboRoot.ts

@@ -1,36 +1,36 @@
 // utils
-export { getTurboRoot } from "./getTurboRoot";
+export { getTurboRoot } from "./getTurboRoot.js";
 export {
   getTurboConfigs,
   getWorkspaceConfigs,
   forEachTaskDef,
-} from "./getTurboConfigs";
-export { searchUp } from "./searchUp";
+} from "./getTurboConfigs.js";
+export { searchUp } from "./searchUp.js";
 export {
   getAvailablePackageManagers,
   getPackageManagersBinPaths,
-} from "./managers";
-export { isFolderEmpty } from "./isFolderEmpty";
-export { validateDirectory } from "./validateDirectory";
+} from "./managers.js";
+export { isFolderEmpty } from "./isFolderEmpty.js";
+export { validateDirectory } from "./validateDirectory.js";
 export {
   isUrlOk,
   getRepoInfo,
   hasRepo,
   existsInRepo,
   downloadAndExtractRepo,
   downloadAndExtractExample,
-} from "./examples";
-export { isWriteable } from "./isWriteable";
-export { createProject, DownloadError } from "./createProject";
-export { convertCase } from "./convertCase";
+} from "./examples.js";
+export { isWriteable } from "./isWriteable.js";
+export { createProject, DownloadError } from "./createProject.js";
+export { convertCase } from "./convertCase.js";
 
-export * as logger from "./logger";
+export * as logger from "./logger.js";
 
 // types
-export type { RepoInfo } from "./examples";
+export type { RepoInfo } from "./examples.js";
 export type {
   TurboConfig,
   TurboConfigs,
   WorkspaceConfig,
-} from "./getTurboConfigs";
-export * from "./types";
+} from "./getTurboConfigs.js";
+export * from "./types.js";

packages/turbo-utils/src/index.ts

@@ -1,13 +1,9 @@
-import {
-  reset,
-  bold as pcBold,
-  underline as pcUnderline,
-  gray,
-  dim,
-} from "picocolors";
+import pc from "picocolors";
 import ora from "ora";
 import gradient from "gradient-string";
 
+const { reset, bold: pcBold, underline: pcUnderline, gray, dim } = pc;
+
 const BLUE = "#0099F7";
 const RED = "#F11712";
 const YELLOW = "#FFFF00";