Modernize the build process

- Current process fails on the external dependencies
- This modernizes both the test and build process
- And fixes the package defined exports

Author: hollandjake

examples/webpack/package.json

@@ -5,7 +5,7 @@
     "brace": "^0.11.1",
     "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
-    "pdfkit": "^0.15.0",
+    "pdfkit": "file:../..",
     "process": "^0.11.10",
     "readable-stream": "^4.5.2",
     "util": "^0.12.5"

examples/webpack/src/registerStaticFiles.js

@@ -1,8 +1,12 @@
 // the fs here is not node fs but the provided virtual one
 import fs from 'fs';
 // the content file is returned as is (webpack is configured to load *.afm files as asset/source)
-import Courier from 'pdfkit/js/data/Courier.afm';
-import CourierBold from 'pdfkit/js/data/Courier-Bold.afm';
+import Helvetica from 'pdfkit/data/Helvetica.afm';
+import HelveticaBold from 'pdfkit/data/Helvetica-Bold.afm';
+import HelveticaBoldOblique from 'pdfkit/data/Helvetica-BoldOblique.afm';
+import HelveticaOblique from 'pdfkit/data/Helvetica-Oblique.afm';
+import Courier from 'pdfkit/data/Courier.afm';
+import CourierBold from 'pdfkit/data/Courier-Bold.afm';
 
 function registerBinaryFiles(ctx) {
   ctx.keys().forEach(key => {
@@ -11,23 +15,15 @@ function registerBinaryFiles(ctx) {
   });
 }
 
-function registerAFMFonts(ctx) {
-  ctx.keys().forEach(key => {
-    const match = key.match(/([^/]*\.afm$)/);
-    if (match) {
-      // afm files must be stored on data path
-      fs.writeFileSync(`data/${match[0]}`, ctx(key));
-    }
-  });
-}
-
 // register all files found in assets folder (relative to src)
 registerBinaryFiles(require.context('./static-assets', true));
 
 // register AFM fonts distributed with pdfkit
 // is good practice to register only required fonts to avoid the bundle size increase too much
-registerAFMFonts(require.context('pdfkit/js/data', false, /Helvetica.*\.afm$/));
-
 // register files imported directly
+fs.writeFileSync('data/Helvetica.afm', Helvetica);
+fs.writeFileSync('data/Helvetica-Bold.afm', HelveticaBold);
+fs.writeFileSync('data/Helvetica-BoldOblique.afm', HelveticaBoldOblique);
+fs.writeFileSync('data/Helvetica-Oblique.afm', HelveticaOblique);
 fs.writeFileSync('data/Courier.afm', Courier);
 fs.writeFileSync('data/Courier-Bold.afm', CourierBold);

examples/webpack/webpack.config.js

@@ -16,7 +16,7 @@ module.exports = {
     symlinks: false,
     alias: {
       // maps fs to a virtual one allowing to register file content dynamically
-      fs: __dirname + '/../../js/virtual-fs.js'
+      fs: 'pdfkit/virtual-fs'
     },
     fallback: {
       // crypto module is not necessary at browser

examples/webpack/yarn.lock

@@ -23,12 +23,7 @@
   },
   "bugs": "https://github.com/foliojs/pdfkit/issues",
   "devDependencies": {
-    "@babel/core": "^7.26.0",
-    "@babel/plugin-external-helpers": "^7.25.9",
-    "@babel/preset-env": "^7.26.0",
     "@eslint/js": "^9.17.0",
-    "@rollup/plugin-babel": "^6.0.4",
-    "babel-jest": "^29.7.0",
     "blob-stream": "^0.1.3",
     "brace": "^0.11.1",
     "brfs": "~2.0.2",
@@ -44,23 +39,26 @@
     "pdfjs-dist": "^2.14.305",
     "prettier": "3.4.2",
     "pug": "^3.0.3",
-    "rollup": "^2.79.2",
-    "rollup-plugin-copy": "^3.5.0",
+    "vite": "^6.3.5",
+    "vite-plugin-node-polyfills": "^0.23.0",
+    "vite-plugin-static-copy": "^3.0.2",
     "vitest": "^3.2.4"
   },
   "dependencies": {
     "crypto-js": "^4.2.0",
     "fontkit": "^2.0.4",
     "jpeg-exif": "^1.1.4",
     "linebreak": "^1.1.0",
-    "@cto.af/linebreak": "^3.0.0",
+    "@cto.af/linebreak": "^3.0.1",
     "png-js": "^1.0.0"
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "rollup -c && npm run build-standalone",
-    "build-standalone": "browserify --standalone PDFDocument --ignore crypto js/pdfkit.js > js/pdfkit.standalone.js",
-    "browserify-example": "browserify examples/browserify/browser.js > examples/browserify/bundle.js",
+    "build": "npm run build-base && npm run build-virtual-fs && npm run build-standalone",
+    "build-base": "vite build",
+    "build-virtual-fs": "vite build --config vite.virtual-fs.config.js",
+    "build-standalone": "vite build --config vite.standalone.config.js",
+    "browserify-example": "browserify examples/browserify/browser.js -t brfs > examples/browserify/bundle.js",
     "pdf-guide": "node docs/generate.js",
     "website": "node docs/generate_website.js",
     "publish-website": "node docs/publish_website.js",
@@ -71,12 +69,20 @@
     "test:visual": "vitest run visual/",
     "test:unit": "vitest run unit/"
   },
+  "type": "commonjs",
   "main": "js/pdfkit.js",
   "module": "js/pdfkit.es.js",
-  "browserify": {
-    "transform": [
-      "brfs"
-    ]
+  "unpkg": "js/pdfkit.standalone.js",
+  "exports": {
+    ".": {
+      "require": "./js/pdfkit.js",
+      "import": "./js/pdfkit.es.js"
+    },
+    "./virtual-fs": {
+      "require": "./js/virtual-fs.js",
+      "import": "./js/virtual-fs.es.js"
+    },
+    "./data/*": "./js/data/*"
   },
   "engines": {
     "node": ">=20"

package.json

@@ -0,0 +1,29 @@
+import PDFDocument from '../../lib/document';
+import LayoutEngine from '../../lib/text/layout';
+import { logData } from './helpers';
+import { test as baseTest } from 'vitest';
+
+describe('LayoutEngine', () => {
+  const test = baseTest.extend({
+    doc: ({}, use) => use(new PDFDocument({ size: 'A4', margin: 72 })),
+    layout: ({ doc }, use) => use(new LayoutEngine(doc)),
+    docData: async ({ doc }, use) => use(logData(doc)),
+  });
+
+  describe('boundsOfString', () => {
+    afterEach(({ doc }) => {
+      doc.end();
+    });
+    test.concurrent.for([
+      ['', undefined, { x: 72, y: 72, width: 0, height: 0 }],
+      ['', {}, { x: 72, y: 72, width: 0, height: 0 }],
+      [
+        'Hello world!',
+        {},
+        { x: 72, y: 72, width: 62.736000000000004, height: 11.100000000000001 },
+      ],
+    ])(`'%s', %j -> %j`, ([text, options, expected], { layout, expect }) => {
+      expect(layout.boundsOfString(text, options)).toEqual(expected);
+    });
+  });
+});

rollup.config.js

@@ -1,5 +1,5 @@
 import { runDocTest } from './helpers';
-var tiger = require('../../examples/tiger');
+import tiger from '../../examples/tiger';
 
 describe('vector', function () {
   test('simple shapes', function () {

tests/unit/layout.spec.js

@@ -0,0 +1,57 @@
+import { defineConfig } from 'vitest/config';
+import { viteStaticCopy } from 'vite-plugin-static-copy'
+
+export const node_modules = [
+  'stream',
+  'zlib',
+  'fs',
+  'events',
+];
+
+export const external_packages = [
+  'fontkit',
+  'linebreak',
+  'png-js',
+  'crypto-js',
+  'jpeg-exif'
+]
+export const external = [
+  ...node_modules,
+  ...external_packages,
+];
+
+export default defineConfig({
+  test: {
+    globals: true,
+    setupFiles: './tests/unit/setupTests.js',
+    coverage: {
+      provider: 'istanbul'
+    },
+    fileParallelism: true,
+    dir: 'tests'
+  },
+  esbuild: {
+    keepNames: true,
+  },
+  build: {
+    outDir: "js",
+    lib: {
+      entry: 'lib/document.js',
+      fileName: 'pdfkit',
+    },
+    rollupOptions: {
+      external,
+      output: [
+        {format: 'cjs', entryFileNames: 'pdfkit.js'},
+        {format: 'es', entryFileNames: 'pdfkit.es.js'},
+      ]
+    },
+  },
+  plugins: [
+    viteStaticCopy({
+      targets: [
+        { src: ['lib/font/data/*.afm', 'lib/mixins/data/*.icc'], dest: 'data' }
+      ]
+    })
+  ]
+});

tests/visual/vector.spec.js

@@ -0,0 +1,48 @@
+import { defineConfig } from 'vite';
+import { nodePolyfills } from 'vite-plugin-node-polyfills';
+import { external_packages, node_modules } from './vite.config.js';
+import path from 'path';
+import fs from 'fs';
+
+export default defineConfig({
+  plugins: [
+    nodePolyfills({ include: node_modules }),
+    {
+      name: 'inline',
+      async transform(code, filename) {
+        const dirname = path.dirname(filename);
+        return {
+          // Inline any file imports
+          code: code.replaceAll(/fs\.readFileSync\(__dirname \+ '(.+?)', '(.+?)'\);/g, (match, filename, encoding) => {
+            const source = fs.readFileSync(path.join(dirname, filename), encoding);
+            return `"${source.replaceAll('\n', '\\n')}";`;
+          })
+        };
+      }
+    }
+  ],
+  esbuild: {
+    keepNames: true,
+  },
+  build: {
+    outDir: "js",
+    emptyOutDir: false,
+    chunkSizeWarningLimit: 3000,
+    rollupOptions: {
+      input: 'lib/document.js',
+      external: external_packages,
+      output: {
+        format: 'umd',
+        name: 'pdfkit',
+        entryFileNames: 'pdfkit.standalone.js',
+        globals: {
+          'crypto-js': 'CryptoJS',
+          'fontkit': 'fontkit',
+          'linebreak': 'LineBreaker',
+          'jpeg-exif': 'exif',
+          'png-js': 'PNG'
+        }
+      }
+    }
+  }
+});