add size-limit and size-limit-action to measure sizes of individual exports/examples

Author: EskiMojo14

.github/workflows/size.yml

@@ -0,0 +1,20 @@
+name: size
+on:
+  pull_request:
+    branches:
+      - main
+permissions:
+  pull-requests: write
+jobs:
+  size:
+    runs-on: ubuntu-latest
+    env:
+      CI_JOB_NUMBER: 1
+    steps:
+      - uses: actions/checkout@v4
+      - uses: EskiMojo14/size-limit-action@v2
+        with:
+          directory: library
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          package_manager: pnpm
+          size_margin: non-zero

library/.size-limit.ts

@@ -0,0 +1,69 @@
+import dedent from 'dedent';
+import type { Check, SizeLimitConfig } from 'size-limit';
+import * as v from './src';
+
+const paths = ['dist/index.js', 'dist/index.cjs'];
+
+const checks = paths.map(
+  (path): Check => ({
+    name: `Full bundle (${path.includes('.cjs') ? 'CJS' : 'ESM'})`,
+    path,
+    import: '*',
+  })
+);
+
+const importNames = new Set(Object.keys(v));
+
+/**
+ * Build a config for an individual export's size.
+ * @param {string} importName Name of the export.
+ * @returns {Check} The config.
+ */
+function individualExportConfig(importName: string): Check {
+  return {
+    name: `\`v.${importName}\``,
+    // only check ESM individual exports
+    path: paths[0],
+    import: `{ ${importName} }`,
+  };
+}
+
+for (const importName of importNames) {
+  // if it's a reserved name or internal, skip it
+  if (importNames.has(importName + '_') || importName.startsWith('_')) continue;
+  checks.push(individualExportConfig(importName));
+}
+
+// a v.<name>( call
+const vRegex = /v\.(\w+)\(/g;
+
+/**
+ * Build a config for a TypeScript example's size.
+ * @param {TemplateStringsArray} strings Template strings.
+ * @param {...unknown} values Template values.
+ * @returns {Check} The config.
+ */
+function ts(strings: TemplateStringsArray, ...values: unknown[]): Check {
+  const dedented = dedent(strings, ...values);
+  const usedImports = Array.from(dedented.matchAll(vRegex)).map((m) => m[1]);
+  const uniqueImports = Array.from(new Set(usedImports)).map((importName) =>
+    importNames.has(importName + '_') ? importName + '_' : importName
+  );
+  return {
+    name: `\`\`\`ts\n${dedented}\n\`\`\``,
+    // ESM only
+    path: paths[0],
+    import: `{ ${uniqueImports.join(', ')} }`,
+  };
+}
+
+checks.push(
+  ts`
+  v.object({
+    email: v.pipe(v.string(), v.email()),
+    password: v.pipe(v.string(), v.minLength(8)),
+  })
+`
+);
+
+export default checks satisfies SizeLimitConfig;

library/package.json

@@ -49,18 +49,23 @@
     "lint.fix": "eslint \"src/**/*.ts*\" --fix",
     "format": "prettier --write ./src",
     "format.check": "prettier --check ./src",
-    "build": "tsdown"
+    "build": "tsdown",
+    "size": "size-limit"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",
+    "@size-limit/esbuild": "^11.2.0",
+    "@size-limit/preset-small-lib": "^11.2.0",
     "@vitest/coverage-v8": "^3.0.7",
+    "dedent": "^1.7.0",
     "eslint": "^9.21.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jsdoc": "^50.6.3",
     "eslint-plugin-redos-detector": "^3.1.1",
     "eslint-plugin-regexp": "^2.7.0",
     "eslint-plugin-security": "^3.0.1",
     "jsdom": "^26.0.0",
+    "size-limit": "^11.2.0",
     "tsm": "^2.3.0",
     "tsdown": "^0.12.4",
     "typescript": "^5.7.3",