feat: Build with rollup and lint (#3)

Author: timfish

.github/workflows/CI.yml

@@ -1,5 +1,9 @@
 name: 'Build & Test'
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
@@ -12,6 +16,8 @@ jobs:
           node-version-file: 'package.json'
       - name: Install
         run: yarn install
+      - name: Lint
+        run: yarn lint
       - name: Build
         run: yarn build
       - name: Run Unit Tests

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 120,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package.json

@@ -4,40 +4,44 @@
   "license": "MIT",
   "exports": {
     "rollup": {
-      "require": "./dist/rollup.js",
-      "import": "./dist/rollup.mjs"
+      "require": "./dist/cjs/rollup.js",
+      "import": "./dist/esm/rollup.mjs"
     },
     "webpack": {
-      "require": "./dist/webpack.js",
-      "import": "./dist/webpack.mjs"
+      "require": "./dist/cjs/webpack.js",
+      "import": "./dist/esm/webpack.mjs"
     },
     "esbuild": {
-      "require": "./dist/esbuild.js",
-      "import": "./dist/esbuild.mjs"
+      "require": "./dist/cjs/esbuild.js",
+      "import": "./dist/esm/esbuild.mjs"
     },
     "vite": {
-      "require": "./dist/vite.js",
-      "import": "./dist/vite.mjs"
+      "require": "./dist/cjs/vite.js",
+      "import": "./dist/esm/vite.mjs"
     },
     "rspack": {
-      "require": "./dist/rspack.js",
-      "import": "./dist/rspack.mjs"
+      "require": "./dist/cjs/rspack.js",
+      "import": "./dist/esm/rspack.mjs"
     },
     "rolldown": {
-      "require": "./dist/rolldown.js",
-      "import": "./dist/rolldown.mjs"
+      "require": "./dist/cjs/rolldown.js",
+      "import": "./dist/esm/rolldown.mjs"
     }
   },
   "scripts": {
-    "build": "pkgroll --clean-dist --target=es2018 --target=node14 --sourcemap",
-    "test": "vitest run ./test/**/*.test.ts"
+    "build": "rollup --config rollup.config.mjs",
+    "test": "vitest run ./test/**/*.test.ts",
+    "lint": "prettier --check \"{src,test}/**/*.{ts,js}\"",
+    "fix": "prettier --write \"{src,test}/**/*.{ts,js}\""
   },
   "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.0",
     "@rspack/cli": "^1.0.8",
     "@rspack/core": "^1.0.8",
+    "@sentry-internal/typescript": "^8.32.0",
     "@types/node": "14",
     "esbuild": "^0.24.0",
-    "pkgroll": "^2.5.0",
+    "prettier": "^3.3.3",
     "rolldown": "^0.13.2",
     "rollup": "^4.22.5",
     "typescript": "^5.6.2",

rollup.config.mjs

@@ -0,0 +1,34 @@
+import { builtinModules } from 'node:module';
+import { resolve } from 'node:path';
+import { readFileSync } from 'node:fs';
+import typescript from '@rollup/plugin-typescript';
+
+const pkgJson = JSON.parse(readFileSync(resolve(process.cwd(), 'package.json')));
+const external = [...builtinModules, ...Object.keys(pkgJson.dependencies || {})];
+
+// a simple plugin that adds a package.json file with type: module
+const modulePackageJson = {
+  name: 'package-json-module-type',
+  generateBundle() {
+    this.emitFile({ type: 'asset', fileName: 'package.json', source: '{"type": "module"}' });
+  },
+};
+
+function transpileNode(format, input, outDir) {
+  return {
+    input,
+    output: {
+      sourcemap: true,
+      strict: false,
+      format,
+      dir: outDir,
+      preserveModules: true,
+    },
+    plugins: [typescript({ outDir, tsconfig: './tsconfig.json' }), format === 'esm' ? modulePackageJson : {}],
+    external,
+  };
+}
+
+const inputs = ['src/esbuild.ts', 'src/rolldown.ts', 'src/rollup.ts', 'src/rspack.ts', 'src/vite.ts', 'src/webpack.ts'];
+
+export default [transpileNode('cjs', inputs, 'dist/cjs'), transpileNode('esm', inputs, 'dist/esm')];

src/common.ts

@@ -1,37 +1,32 @@
-import * as crypto from "crypto";
+import * as crypto from 'crypto';
 
-export const DEFAULT_EXTENSIONS = [".js", ".mjs", ".cjs"];
+export const DEFAULT_EXTENSIONS = ['.js', '.mjs', '.cjs'];
 
 export function stringToUUID(str: string): string {
-  const md5sum = crypto.createHash("md5");
+  const md5sum = crypto.createHash('md5');
   md5sum.update(str);
-  const md5Hash = md5sum.digest("hex");
+  const md5Hash = md5sum.digest('hex');
 
   // Position 16 is fixed to either 8, 9, a, or b in the uuid v4 spec (10xx in binary)
   // RFC 4122 section 4.4
-  const v4variant = ["8", "9", "a", "b"][
-    md5Hash.substring(16, 17).charCodeAt(0) % 4
-  ] as string;
+  const v4variant = ['8', '9', 'a', 'b'][md5Hash.substring(16, 17).charCodeAt(0) % 4] as string;
 
   return (
     md5Hash.substring(0, 8) +
-    "-" +
+    '-' +
     md5Hash.substring(8, 12) +
-    "-4" +
+    '-4' +
     md5Hash.substring(13, 16) +
-    "-" +
+    '-' +
     v4variant +
     md5Hash.substring(17, 20) +
-    "-" +
+    '-' +
     md5Hash.substring(20)
   ).toLowerCase();
 }
 
 export function addDebugIdToSource(input: string, debugId: string): string {
-  return input.replace(
-    /\s*(?:\/\/# debugId=.+)?\s*(\/\/# sourceMappingURL=.+)?\s*$/,
-    `\n//# debugId=${debugId}\n$1`
-  );
+  return input.replace(/\s*(?:\/\/# debugId=.+)?\s*(\/\/# sourceMappingURL=.+)?\s*$/, `\n//# debugId=${debugId}\n$1`);
 }
 
 export function addDebugIdToSourcemap(input: string, debugId: string): string {

src/esbuild.ts

@@ -1,30 +1,20 @@
-import type { PluginBuild } from "esbuild";
-import {
-  addDebugIdToSource,
-  DEFAULT_EXTENSIONS,
-  stringToUUID,
-  addDebugIdToSourcemap,
-} from "./common";
-import { readFile, writeFile } from "fs/promises";
-import * as path from "path";
+import type { PluginBuild } from 'esbuild';
+import { addDebugIdToSource, DEFAULT_EXTENSIONS, stringToUUID, addDebugIdToSourcemap } from './common';
+import { readFile, writeFile } from 'fs/promises';
+import * as path from 'path';
 
 export default {
-  name: "esbuild-plugin-debug-ids",
+  name: 'esbuild-plugin-debug-ids',
   setup({ onEnd, initialOptions }: PluginBuild) {
-    if (
-      initialOptions.bundle !== true ||
-      initialOptions.sourcemap === undefined
-    ) {
+    if (initialOptions.bundle !== true || initialOptions.sourcemap === undefined) {
       return;
     }
 
     initialOptions.metafile = true;
 
     onEnd(async (result) => {
       const assets = Object.keys(result.metafile?.outputs || {});
-      const assetsWithCorrectExt = assets.filter((file) =>
-        DEFAULT_EXTENSIONS.some((ext) => file.endsWith(ext))
-      );
+      const assetsWithCorrectExt = assets.filter((file) => DEFAULT_EXTENSIONS.some((ext) => file.endsWith(ext)));
 
       if (assetsWithCorrectExt.length === 0) {
         return;
@@ -39,13 +29,13 @@ export default {
         }
 
         const sourcePath = path.join(process.cwd(), key);
-        const source = await readFile(sourcePath, { encoding: "utf-8" });
+        const source = await readFile(sourcePath, { encoding: 'utf-8' });
         const debugId = stringToUUID(source);
         const updatedSource = addDebugIdToSource(source, debugId);
         await writeFile(sourcePath, updatedSource);
 
         const sourcemapPath = path.join(process.cwd(), sourcemapKey);
-        const sourcemap = await readFile(sourcemapPath, { encoding: "utf-8" });
+        const sourcemap = await readFile(sourcemapPath, { encoding: 'utf-8' });
         const updatedSourcemap = addDebugIdToSourcemap(sourcemap, debugId);
         await writeFile(sourcemapPath, updatedSourcemap);
       });

src/rolldown.ts

@@ -1,3 +1,3 @@
-import rollupPlugin from "./rollup";
+import rollupPlugin from './rollup';
 
 export default rollupPlugin;

src/rollup.ts

@@ -1,21 +1,22 @@
-import { OutputAsset, OutputChunk, Plugin } from "rollup";
-import {
-  addDebugIdToSourcemap,
-  addDebugIdToSource,
-  stringToUUID,
-  DEFAULT_EXTENSIONS,
-} from "./common";
+import { OutputAsset, OutputChunk, Plugin } from 'rollup';
+import { addDebugIdToSourcemap, addDebugIdToSource, stringToUUID, DEFAULT_EXTENSIONS } from './common';
+import { TextDecoder } from 'util';
+
+function getString(input: string | Uint8Array): string {
+  if (typeof input === 'string') {
+    return input;
+  }
+
+  return new TextDecoder().decode(input);
+}
 
 export default function debugIds(): Plugin {
   return {
-    name: "rollup-plugin-debug-ids",
-    generateBundle: function (
-      _,
-      bundle: { [fileName: string]: OutputAsset | OutputChunk }
-    ) {
+    name: 'rollup-plugin-debug-ids',
+    generateBundle: function (_, bundle: { [fileName: string]: OutputAsset | OutputChunk }) {
       for (const [key, value] of Object.entries(bundle)) {
         // We only add debugId where there is a linked sourcemap file
-        if (!("sourcemapFileName" in value) || !value.sourcemapFileName) {
+        if (!('sourcemapFileName' in value) || !value.sourcemapFileName) {
           continue;
         }
 
@@ -26,32 +27,26 @@ export default function debugIds(): Plugin {
 
         // Check we have a sourcemap in the output and it has source property
         const sourceMapFile = bundle[value.sourcemapFileName];
-        if (!sourceMapFile || !("source" in sourceMapFile)) {
+        if (!sourceMapFile || !('source' in sourceMapFile)) {
           continue;
         }
 
         const debugId = stringToUUID(value.code);
         value.code = addDebugIdToSource(value.code, debugId);
-        sourceMapFile.source = addDebugIdToSourcemap(
-          sourceMapFile.source.toString(),
-          debugId
-        );
+        sourceMapFile.source = addDebugIdToSourcemap(sourceMapFile.source.toString(), debugId);
 
-        // vite has plugins that run after us which can modify the sourcemap so we
+        // vite has a plugin that runs after us which can modify the sourcemap so we
         // proxy the sourceMapFile to re-add the debugId if the source gets set again
-        bundle[value.sourcemapFileName] = new Proxy(
-          bundle[value.sourcemapFileName],
-          {
-            set: function (target, prop, value) {
-              if (prop === "source") {
-                target[prop] = addDebugIdToSourcemap(value, debugId);
-              } else {
-                target[prop] = value;
-              }
-              return true;
-            },
-          }
-        );
+        bundle[value.sourcemapFileName] = new Proxy(bundle[value.sourcemapFileName] as OutputAsset, {
+          set: function <K extends keyof OutputAsset>(target: OutputAsset, prop: K, value: OutputAsset[K]) {
+            if (prop === 'source') {
+              (target as any)[prop] = addDebugIdToSourcemap(getString(value as string | Uint8Array), debugId);
+            } else {
+              target[prop] = value;
+            }
+            return true;
+          },
+        }) as OutputAsset;
       }
     },
   };

src/rspack.ts

@@ -1,3 +1,3 @@
-import { DebugIdWebpackPlugin } from "./webpack";
+import { DebugIdWebpackPlugin } from './webpack';
 
 export class DebugIdRspackPlugin extends DebugIdWebpackPlugin {}

src/vite.ts

@@ -1,11 +1,11 @@
-import rollupPlugin from "./rollup";
-import { Plugin } from "vite";
+import rollupPlugin from './rollup';
+import { Plugin } from 'vite';
 
 export default function debugIds(): Plugin {
   return {
     ...rollupPlugin(),
-    name: "vite-plugin-debug-ids",
-    apply: "build",
-    enforce: "post",
+    name: 'vite-plugin-debug-ids',
+    apply: 'build',
+    enforce: 'post',
   };
 }