@procore/hammer-lib-tsup 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @procore/hammer-lib-tsup
 
+## 0.7.0
+
+### Minor Changes
+
+- 59a4b08: Upgrades tsup, esbuild, and other dependencies.
+- 32ad5d2: Add validate command to libs-tsup
+
+### Patch Changes
+
+- 59a4b08: Upgrades `picocolors` to 1.1.1.
+- 5dd6e18: Fixes interface for `lib:validate` command.
+- Updated dependencies [59a4b08]
+- Updated dependencies [59a4b08]
+- Updated dependencies [5dd6e18]
+- Updated dependencies [32ad5d2]
+  - @procore/hammer-utils@0.2.0
+  - @procore/hammer-types@0.5.1
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -46,9 +46,25 @@ This project uses [`yarn`][yarn], and supports the following commands:
 - `lint:types`: uses [`TypeScript`][typescript] to validate types.
 - `test`: runs the unit test suite.
 - `test:ci`: run the unit test suite, reporting coverage.
+- `lib:build --analyze`: builds the library and generates metadata for bundle analysis.
 
+### Using `lib:build --analyze`
+
+When you run `hammer lib:build --analyze`, it generates the following output files:
+
+- `metafile-esm.json`: Metadata for the ESM (ECMAScript Module) output.
+- `metafile-cjs.json`: Metadata for the CJS (CommonJS) output.
+
+These files can be used to analyze the bundle, understand the size of individual modules, and identify optimizations.
+
+For more detailed information on how the metadata works, refer to the [Tsup Metafile Documentation][tsup-metafile].
+
+Additionally, you can use tools like [Bundle Buddy][bundle-buddy] to visualize the output and track down duplicate dependencies or optimize your bundle for better performance.
+
+[bundle-buddy]: https://www.bundle-buddy.com/esbuild
 [eslint]: https://eslint.org/
 [prettier]: https://prettier.io/
 [tsup]: https://tsup.egoist.dev/
+[tsup-metafile]: https://tsup.egoist.dev/#metafile
 [typescript]: https://www.typescriptlang.org/
 [yarn]: https://classic.yarnpkg.com/

package/dist/index.js

@@ -148,10 +148,138 @@ async function performBuild(buildOptions) {
 }
 
 // src/index.ts
+var import_hammer_utils2 = require("@procore/hammer-utils");
+
+// src/validate-package.ts
 var import_hammer_utils = require("@procore/hammer-utils");
+var import_picocolors3 = __toESM(require("picocolors"));
+var import_node_fs = __toESM(require("fs"));
+var errorIsNotExisted = (name) => `The property ${import_picocolors3.default.yellow(name)} doesn't exist in the package.json.`;
+var errorFileIsNotExisted = (name) => `The file from ${import_picocolors3.default.yellow(name)} property doesn't exist in the dist folder.
+`;
+var areDeepFileExist = (value) => {
+  let isValid = true;
+  if (Array.isArray(value) && isValid) {
+    isValid = value.every(import_node_fs.default.existsSync);
+  }
+  if (typeof value === "object" && !Array.isArray(value) && value !== null && isValid) {
+    isValid = Object.values(value).every(
+      (file) => areDeepFileExist(file)
+    );
+  }
+  if (typeof value === "string" && isValid) {
+    isValid = import_node_fs.default.existsSync(value);
+  }
+  return isValid;
+};
+var validatePackage = async (rootDir) => {
+  const pkg = await (0, import_hammer_utils.readRootPackageJson)(rootDir);
+  let isValid = true;
+  if (!pkg.type) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#type";
+    process.stderr.write(errorIsNotExisted("type"));
+    process.stdout.write(
+      `Please specify it as ${import_picocolors3.default.bold('"module" (recommended)')} or read ${import_picocolors3.default.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (!pkg.exports) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#exports";
+    const exampleStructure = {
+      exports: {
+        ".": {
+          import: {
+            types: "./dist/modern/index.d.ts",
+            default: "./dist/modern/index.js"
+          },
+          require: {
+            types: "./dist/modern/index.d.cts",
+            default: "./dist/modern/index.cjs"
+          }
+        },
+        "./package.json": "./package.json"
+      }
+    };
+    process.stderr.write(errorIsNotExisted("exports"));
+    process.stdout.write(
+      `Please specify it as ${import_picocolors3.default.bold(JSON.stringify(exampleStructure, null, 2))} or read ${import_picocolors3.default.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (pkg.exports && !areDeepFileExist(pkg.exports)) {
+    process.stderr.write(errorFileIsNotExisted("exports"));
+    isValid = false;
+  }
+  if (!pkg.main) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#main";
+    process.stderr.write(errorIsNotExisted("main"));
+    process.stdout.write(
+      `Please point it on your main file. You can read more in ${import_picocolors3.default.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (pkg.main && !import_node_fs.default.existsSync(pkg.main)) {
+    process.stderr.write(errorFileIsNotExisted("main"));
+    isValid = false;
+  }
+  if (!pkg.module) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#package-entry-points";
+    process.stderr.write(errorIsNotExisted("module"));
+    process.stdout.write(`You can read more in ${import_picocolors3.default.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.module && !import_node_fs.default.existsSync(pkg.module)) {
+    process.stderr.write(errorFileIsNotExisted("module"));
+    isValid = false;
+  }
+  if (!pkg.types) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#community-conditions-definitions";
+    process.stderr.write(errorIsNotExisted("types"));
+    process.stdout.write(`You can read more in ${import_picocolors3.default.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.types && !areDeepFileExist(pkg.types)) {
+    process.stderr.write(errorFileIsNotExisted("types"));
+    isValid = false;
+  }
+  if (!pkg.files) {
+    const docUrl = "https://classic.yarnpkg.com/lang/en/docs/package-json/#toc-files";
+    process.stderr.write(
+      `${errorIsNotExisted("files")}
+The optional ${import_picocolors3.default.yellow("files")} field is an array of file patterns that describes the entries to be included when your package is installed as a dependency.
+`
+    );
+    process.stdout.write(`You can read more in ${import_picocolors3.default.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.files && !areDeepFileExist(pkg.files)) {
+    process.stderr.write(errorFileIsNotExisted("files"));
+    isValid = false;
+  }
+  if (!pkg.sideEffects) {
+    process.stderr.write(
+      `${errorIsNotExisted("sideEffects")}
+This field helps bundlers make assumptions about packages that improve tree shaking, or pruning files that aren't used and don't have any global side effects.
+`
+    );
+    isValid = false;
+  }
+  if (isValid) {
+    process.stdout.write(import_picocolors3.default.green(`Validation finished succesfully.
+`));
+  }
+};
+
+// src/index.ts
 var { init, build, clean, inspect, start, validate } = {
   init: async function init2(rootDir, config, options) {
-    await (0, import_hammer_utils.updatePackageJsonFromTemplate)(rootDir, options.force);
+    await (0, import_hammer_utils2.updatePackageJsonFromTemplate)(rootDir, options.force);
   },
   build: async function build2(rootDir, config, options) {
     const pluginOptions = { ...options, config };
@@ -176,7 +304,9 @@ ${highlightedConfig}
     const buildOptions = await createBuildOptions(base_configs_default, pluginOptions);
     await performBuild(buildOptions);
   },
-  validate: async function validate2() {
+  validate: async function validate2(rootDir, config) {
+    await this.build(rootDir, config, { analyze: false });
+    await validatePackage(rootDir);
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import process2 from "process";
+import process2 from "node:process";
 
 // src/base-configs.ts
 import { postcssModules, sassPlugin } from "esbuild-sass-plugin";
@@ -68,7 +68,7 @@ function toHighlightedString(input) {
 
 // src/clean-output.ts
 import { resolve } from "pathe";
-import { rm } from "fs/promises";
+import { rm } from "node:fs/promises";
 import c from "picocolors";
 async function cleanOutput(rootDir, buildOptions) {
   for (const buildOption of buildOptions) {
@@ -110,6 +110,134 @@ async function performBuild(buildOptions) {
 
 // src/index.ts
 import { updatePackageJsonFromTemplate } from "@procore/hammer-utils";
+
+// src/validate-package.ts
+import { readRootPackageJson } from "@procore/hammer-utils";
+import c3 from "picocolors";
+import fs from "node:fs";
+var errorIsNotExisted = (name) => `The property ${c3.yellow(name)} doesn't exist in the package.json.`;
+var errorFileIsNotExisted = (name) => `The file from ${c3.yellow(name)} property doesn't exist in the dist folder.
+`;
+var areDeepFileExist = (value) => {
+  let isValid = true;
+  if (Array.isArray(value) && isValid) {
+    isValid = value.every(fs.existsSync);
+  }
+  if (typeof value === "object" && !Array.isArray(value) && value !== null && isValid) {
+    isValid = Object.values(value).every(
+      (file) => areDeepFileExist(file)
+    );
+  }
+  if (typeof value === "string" && isValid) {
+    isValid = fs.existsSync(value);
+  }
+  return isValid;
+};
+var validatePackage = async (rootDir) => {
+  const pkg = await readRootPackageJson(rootDir);
+  let isValid = true;
+  if (!pkg.type) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#type";
+    process.stderr.write(errorIsNotExisted("type"));
+    process.stdout.write(
+      `Please specify it as ${c3.bold('"module" (recommended)')} or read ${c3.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (!pkg.exports) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#exports";
+    const exampleStructure = {
+      exports: {
+        ".": {
+          import: {
+            types: "./dist/modern/index.d.ts",
+            default: "./dist/modern/index.js"
+          },
+          require: {
+            types: "./dist/modern/index.d.cts",
+            default: "./dist/modern/index.cjs"
+          }
+        },
+        "./package.json": "./package.json"
+      }
+    };
+    process.stderr.write(errorIsNotExisted("exports"));
+    process.stdout.write(
+      `Please specify it as ${c3.bold(JSON.stringify(exampleStructure, null, 2))} or read ${c3.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (pkg.exports && !areDeepFileExist(pkg.exports)) {
+    process.stderr.write(errorFileIsNotExisted("exports"));
+    isValid = false;
+  }
+  if (!pkg.main) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#main";
+    process.stderr.write(errorIsNotExisted("main"));
+    process.stdout.write(
+      `Please point it on your main file. You can read more in ${c3.bold(docUrl)}.
+`
+    );
+    isValid = false;
+  }
+  if (pkg.main && !fs.existsSync(pkg.main)) {
+    process.stderr.write(errorFileIsNotExisted("main"));
+    isValid = false;
+  }
+  if (!pkg.module) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#package-entry-points";
+    process.stderr.write(errorIsNotExisted("module"));
+    process.stdout.write(`You can read more in ${c3.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.module && !fs.existsSync(pkg.module)) {
+    process.stderr.write(errorFileIsNotExisted("module"));
+    isValid = false;
+  }
+  if (!pkg.types) {
+    const docUrl = "https://nodejs.org/docs/latest/api/packages.html#community-conditions-definitions";
+    process.stderr.write(errorIsNotExisted("types"));
+    process.stdout.write(`You can read more in ${c3.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.types && !areDeepFileExist(pkg.types)) {
+    process.stderr.write(errorFileIsNotExisted("types"));
+    isValid = false;
+  }
+  if (!pkg.files) {
+    const docUrl = "https://classic.yarnpkg.com/lang/en/docs/package-json/#toc-files";
+    process.stderr.write(
+      `${errorIsNotExisted("files")}
+The optional ${c3.yellow("files")} field is an array of file patterns that describes the entries to be included when your package is installed as a dependency.
+`
+    );
+    process.stdout.write(`You can read more in ${c3.bold(docUrl)}.
+`);
+    isValid = false;
+  }
+  if (pkg.files && !areDeepFileExist(pkg.files)) {
+    process.stderr.write(errorFileIsNotExisted("files"));
+    isValid = false;
+  }
+  if (!pkg.sideEffects) {
+    process.stderr.write(
+      `${errorIsNotExisted("sideEffects")}
+This field helps bundlers make assumptions about packages that improve tree shaking, or pruning files that aren't used and don't have any global side effects.
+`
+    );
+    isValid = false;
+  }
+  if (isValid) {
+    process.stdout.write(c3.green(`Validation finished succesfully.
+`));
+  }
+};
+
+// src/index.ts
 var { init, build, clean, inspect, start, validate } = {
   init: async function init2(rootDir, config, options) {
     await updatePackageJsonFromTemplate(rootDir, options.force);
@@ -137,7 +265,9 @@ ${highlightedConfig}
     const buildOptions = await createBuildOptions(base_configs_default, pluginOptions);
     await performBuild(buildOptions);
   },
-  validate: async function validate2() {
+  validate: async function validate2(rootDir, config) {
+    await this.build(rootDir, config, { analyze: false });
+    await validatePackage(rootDir);
   }
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@procore/hammer-lib-tsup",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Hammer library builder, tsup-style",
   "author": "Procore Technologies, Inc",
   "homepage": "https://github.com/procore/hammer/packages/lib-tsup",
@@ -51,29 +51,29 @@
     }
   },
   "dependencies": {
-    "@procore/hammer-types": "^0.5.0",
-    "@procore/hammer-utils": "^0.1.0",
+    "@procore/hammer-types": "^0.5.1",
+    "@procore/hammer-utils": "^0.2.0",
     "cli-highlight": "^2.1.11",
-    "esbuild": "^0.23.1",
+    "esbuild": "^0.24.0",
     "esbuild-sass-plugin": "^3.3.1",
     "pathe": "^1.1.2",
-    "picocolors": "^1.0.1",
-    "sass-embedded": "^1.77.5",
-    "tsup": "^8.3.0"
+    "picocolors": "^1.1.1",
+    "sass-embedded": "^1.81.0",
+    "tsup": "^8.3.5"
   },
   "devDependencies": {
     "@procore/eslint-config": "^15.2.1",
     "@procore/hammer-test-utils": "^0.0.1",
     "@procore/prettier-config": "^1.1.1",
     "@procore/typescript-config": "^2.0.0",
-    "@types/node": "^20.16.10",
-    "@vitest/coverage-v8": "^2.1.1",
-    "del-cli": "^5.1.0",
-    "eslint": "^8.57.0",
-    "postcss": "^8.4.39",
+    "@types/node": "^20.17.6",
+    "@vitest/coverage-v8": "^2.1.5",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.15.0",
+    "postcss": "^8.4.49",
     "prettier": "^3.3.3",
     "strip-ansi": "^7.1.0",
-    "typescript": "^5.5.4",
-    "vitest": "^2.1.1"
+    "typescript": "~5.5.4",
+    "vitest": "^2.1.5"
   }
 }