Build @php-wasm packages as dual ESM + CJS (#2087)

WordPress · Dec 17, 2024 · c5d0811 · c5d0811
1 parent eb876ab
commit c5d0811
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 12 deletions.
diff --git a/packages/php-wasm/scopes/package.json b/packages/php-wasm/scopes/package.json
@@ -20,8 +20,17 @@
 		"directory": "../../../dist/packages/php-wasm/scopes"
 	},
 	"license": "GPL-2.0-or-later",
+	"exports": {
+		".": {
+			"import": "./index.js",
+			"require": "./index.cjs"
+		},
+		"./package.json": "./package.json",
+		"./README.md": "./README.md"
+	},
 	"type": "module",
-	"main": "index.js",
+	"main": "./index.cjs",
+	"module": "./index.js",
 	"types": "index.d.ts",
 	"gitHead": "2f8d8f3cea548fbd75111e8659a92f601cddc593",
 	"engines": {

diff --git a/packages/php-wasm/scopes/vite.config.ts b/packages/php-wasm/scopes/vite.config.ts
@@ -32,7 +32,7 @@ export default defineConfig({
 			entry: 'src/index.ts',
 			name: 'php-wasm-scope',
 			fileName: 'index',
-			formats: ['es'],
+			formats: ['es', 'cjs'],
 		},
 		rollupOptions: {
 			// External packages that should not be bundled into your library.

diff --git a/packages/php-wasm/util/package.json b/packages/php-wasm/util/package.json
@@ -13,6 +13,17 @@
 		"access": "public",
 		"directory": "../../../dist/packages/php-wasm/util"
 	},
+	"exports": {
+		".": {
+			"import": "./index.js",
+			"require": "./index.cjs"
+		},
+		"./package.json": "./package.json",
+		"./README.md": "./README.md"
+	},
+	"type": "module",
+	"main": "./index.cjs",
+	"module": "./index.js",
 	"gitHead": "2f8d8f3cea548fbd75111e8659a92f601cddc593",
 	"engines": {
 		"node": ">=18.18.0",

diff --git a/packages/php-wasm/web-service-worker/package.json b/packages/php-wasm/web-service-worker/package.json
@@ -19,10 +19,18 @@
 		"access": "public",
 		"directory": "../../../dist/packages/php-wasm/web-service-worker"
 	},
-	"license": "GPL-2.0-or-later",
+	"exports": {
+		".": {
+			"import": "./index.js",
+			"require": "./index.cjs"
+		},
+		"./package.json": "./package.json",
+		"./README.md": "./README.md"
+	},
 	"type": "module",
-	"main": "src/index.js",
-	"types": "src/index.d.ts",
+	"main": "./index.cjs",
+	"module": "./index.js",
+	"license": "GPL-2.0-or-later",
 	"gitHead": "2f8d8f3cea548fbd75111e8659a92f601cddc593",
 	"engines": {
 		"node": ">=18.18.0",

diff --git a/packages/php-wasm/web-service-worker/project.json b/packages/php-wasm/web-service-worker/project.json
@@ -12,15 +12,20 @@
 				"buildTarget": "php-wasm-web-service-worker:build:bundle:production"
 			}
 		},
+		"build:package-json": {
+			"executor": "@wp-playground/nx-extensions:package-json",
+			"options": {
+				"tsConfig": "packages/php-wasm/web-service-worker/tsconfig.lib.json",
+				"outputPath": "dist/packages/php-wasm/web-service-worker",
+				"buildTarget": "php-wasm-web-service-worker:build:bundle:production"
+			}
+		},
 		"build:bundle": {
-			"executor": "@nx/js:tsc",
+			"executor": "@nx/vite:build",
 			"outputs": ["{options.outputPath}"],
 			"options": {
-				"outputPath": "dist/packages/php-wasm/web-service-worker",
-				"main": "packages/php-wasm/web-service-worker/src/index.ts",
-				"tsConfig": "packages/php-wasm/web-service-worker/tsconfig.lib.json",
-				"assets": ["packages/php-wasm/web-service-worker/*.md"],
-				"updateBuildableProjectDepsInPackageJson": true
+				"emptyOutDir": false,
+				"outputPath": "dist/packages/php-wasm/web-service-worker"
 			}
 		},
 		"lint": {

diff --git a/packages/php-wasm/web-service-worker/vite.config.ts b/packages/php-wasm/web-service-worker/vite.config.ts
@@ -6,6 +6,8 @@ import { join } from 'path';
 
 // eslint-disable-next-line @nx/enforce-module-boundaries
 import { viteTsConfigPaths } from '../../vite-extensions/vite-ts-config-paths';
+// eslint-disable-next-line @nx/enforce-module-boundaries
+import { getExternalModules } from '../../vite-extensions/vite-external-modules';
 
 export default defineConfig({
 	cacheDir: '../../../node_modules/.vite/php-wasm-web-service-worker',
@@ -22,6 +24,20 @@ export default defineConfig({
 		}),
 	],
 
+	build: {
+		lib: {
+			// Could also be a dictionary or array of multiple entry points.
+			entry: 'src/index.ts',
+			name: 'php-wasm-web-service-worker',
+			fileName: 'index',
+			formats: ['es', 'cjs'],
+		},
+		rollupOptions: {
+			// External packages that should not be bundled into your library.
+			external: getExternalModules(),
+		},
+	},
+
 	test: {
 		globals: true,
 		cache: {

diff --git a/packages/playground/data-liberation/blueprints-library b/packages/playground/data-liberation/blueprints-library
+0 −1		composer.json
+9 −1		src/WordPress/AsyncHttp/Client.php
+10 −0		src/WordPress/AsyncHttp/Request.php
+1 −2		src/WordPress/Blueprints/Runner/Step/UnzipStepRunner.php
+26 −0		src/WordPress/ByteReader/WP_Byte_Reader.php
+109 −0		src/WordPress/ByteReader/WP_File_Reader.php
+28 −0		src/WordPress/ByteReader/WP_GZ_File_Reader.php
+205 −0		src/WordPress/ByteReader/WP_Remote_File_Ranged_Reader.php
+182 −0		src/WordPress/ByteReader/WP_Remote_File_Reader.php
+101 −0		src/WordPress/Filesystem/WP_Abstract_Filesystem.php
+32 −0		src/WordPress/Filesystem/WP_File_Visitor_Event.php
+74 −0		src/WordPress/Filesystem/WP_Filesystem.php
+91 −0		src/WordPress/Filesystem/WP_Filesystem_Visitor.php
+270 −0		src/WordPress/Filesystem/WP_Zip_Filesystem.php
+0 −357		src/WordPress/Zip/NewZipStreamReader.php
+271 −0		src/WordPress/Zip/WP_Zip_Filesystem.php
+310 −157		src/WordPress/Zip/ZipStreamReader.php
+0 −36		src/WordPress/Zip/functions.php