fix: fixed bun compatibility for @sapphire/utilities (#703)

resolves #702

Author: favna

.github/workflows/auto-updater.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Build packages for script
         run: yarn turbo run build --filter=@sapphire/timestamp --filter=@sapphire/fetch --filter=@sapphire/prettier-config
       - name: Run updater
-        run: node --experimental-json-modules scripts/twemoji-regex-updater.mjs
+        run: node scripts/twemoji-regex-updater.mjs
       - name: Run prettier on the code
         run: yarn format
       - name: Commit any changes and create a pull request

.github/workflows/continuous-integration.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - stable
   pull_request:
 
 jobs:
@@ -33,6 +32,7 @@ jobs:
             --include @sapphire/prettier-config \
             --include @sapphire/eslint-plugin-result \
             --include @sapphire/result \
+            --include @sapphire/node-utilities \
             --include @sapphire/utilities \
             run build
       - name: Run ESLint
@@ -101,3 +101,20 @@ jobs:
         run: yarn --immutable
       - name: Run Script
         run: yarn check-subpath -- --check
+
+  Check_DynamicSideEffects:
+    name: Check Dynamic Side Effects
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Project
+        uses: actions/checkout@v4
+      - name: Use Node.js v20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          registry-url: https://registry.yarnpkg.org/
+      - name: Install Dependencies
+        run: yarn --immutable
+      - name: Validate dynamic side effects
+        run: yarn dynamic-side-effects -- --check

package.json

@@ -14,7 +14,8 @@
 		"docs": "turbo run docs",
 		"update": "yarn upgrade-interactive",
 		"check-update": "turbo run check-update",
-		"check-subpath": "turbo run check-subpath"
+		"check-subpath": "turbo run check-subpath",
+		"dynamic-side-effects": "turbo run dynamic-side-effects"
 	},
 	"devDependencies": {
 		"@actions/core": "^1.10.1",

packages/utilities/package.json

@@ -13,11 +13,12 @@
 	"scripts": {
 		"test": "vitest run",
 		"lint": "eslint src tests --ext ts --fix -c ../../.eslintrc",
-		"build": "tsup",
+		"build": "tsup && yarn dynamic-side-effects && yarn check-subpath",
 		"docs": "typedoc-json-parser",
-		"prepack": "yarn build && yarn check-subpath",
+		"prepack": "yarn build",
 		"bump": "cliff-jumper",
 		"check-update": "cliff-jumper --dry-run",
+		"dynamic-side-effects": "node ../../scripts/dynamic-side-effects.mjs utilities",
 		"check-subpath": "node ../../scripts/subpath-updater.mjs utilities"
 	},
 	"repository": {
@@ -49,6 +50,8 @@
 	},
 	"devDependencies": {
 		"@favware/cliff-jumper": "^2.2.3",
+		"@sapphire/node-utilities": "workspace:^",
+		"@sapphire/prettier-config": "workspace:^",
 		"@vitest/coverage-v8": "^1.1.0",
 		"esbuild-plugin-file-path-extensions": "^2.0.0",
 		"tsup": "^8.0.1",
@@ -671,7 +674,7 @@
 		}
 	},
 	"sideEffects": [
-		"./dist/esm/chunk*.mjs",
+		"./dist/esm/chunk-G5GHKT7C.mjs",
 		"./dist/iife/index.global.js"
 	]
 }

scripts/dynamic-side-effects.mjs

@@ -0,0 +1,44 @@
+import { bold, green, red } from 'colorette';
+import { readFile, writeFile } from 'node:fs/promises';
+import { basename } from 'node:path';
+import { format } from 'prettier';
+import { findFilesRecursivelyRegex } from '../packages/node-utilities/dist/esm/index.mjs';
+import prettierConfig from '../packages/prettier-config/dist/index.mjs';
+
+const packageName = process.argv[2];
+const check = process.argv[3] === '--check';
+
+const sideEffects = ['./dist/iife/index.global.js'];
+
+for await (const file of findFilesRecursivelyRegex(
+	new URL(`../packages/${packageName}/dist/esm`, import.meta.url),
+	/chunk-[A-Z0-9]+\.mjs(?!\.map)/
+)) {
+	const name = basename(file);
+	sideEffects.unshift(`./dist/esm/${name}`);
+}
+
+const packageJsonRaw = await readFile(new URL(`../packages/${packageName}/package.json`, import.meta.url), 'utf8');
+const packageJSON = JSON.parse(packageJsonRaw);
+
+const newPackageJSON = JSON.stringify({
+	...packageJSON,
+	sideEffects
+});
+
+const oldPackageJSON = JSON.stringify(packageJSON);
+
+if (oldPackageJSON === newPackageJSON) {
+	console.log(green(`The package.json file for ${packageName} is up to date!`));
+	process.exit(0);
+}
+
+if (check) {
+	console.error(red(`The package.json file for ${packageName} is not up to date! Run ${green(bold('yarn dynamic-side-effects'))} to update it.`));
+	process.exit(1);
+}
+
+const formattedNewPackageJSON = await format(newPackageJSON, { ...prettierConfig, parser: 'json-stringify' });
+await writeFile(new URL(`../packages/${packageName}/package.json`, import.meta.url), formattedNewPackageJSON);
+
+console.log(green(`The package.json file for ${packageName} is updated successfully!`));

scripts/subpath-updater.mjs

@@ -1,5 +1,5 @@
 import { bold, green, red } from 'colorette';
-import { writeFile } from 'node:fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
 import { basename } from 'node:path';
 import { format } from 'prettier';
 import { findFilesRecursivelyStringEndsWith } from '../packages/node-utilities/dist/esm/index.mjs';
@@ -76,11 +76,8 @@ for await (const file of findFilesRecursivelyStringEndsWith(new URL(`../packages
 
 const exportObj = Object.fromEntries([...exportMap.entries()].sort((a, b) => a[0].localeCompare(b[0])));
 
-const { default: packageJSON } = await import(`../packages/${packageName}/package.json`, {
-	assert: {
-		type: 'json'
-	}
-});
+const packageJsonRaw = await readFile(new URL(`../packages/${packageName}/package.json`, import.meta.url), 'utf8');
+const packageJSON = JSON.parse(packageJsonRaw);
 
 const newPackageJSON = JSON.stringify({
 	...packageJSON,

scripts/twemoji-regex-updater.mjs

@@ -38,7 +38,7 @@ url.searchParams.append('since', timestamp);
 
 const [commits, { default: ciData }] = await Promise.all([
 	fetch(url, FetchResultTypes.JSON), //
-	import(shaTrackerFileUrl, { assert: { type: 'json' } }) //
+	import(shaTrackerFileUrl, { with: { type: 'json' } }) //
 ]);
 
 const data = { sha: commits.length ? commits[0].sha : null, length: commits.length };

turbo.json

@@ -40,6 +40,10 @@
 			"dependsOn": ["@sapphire/prettier-config#build", "@sapphire/node-utilities#build"],
 			"outputs": ["package.json"]
 		},
+		"dynamic-side-effects": {
+			"dependsOn": ["@sapphire/prettier-config#build", "@sapphire/node-utilities#build", "@sapphire/utilities#build"],
+			"outputs": ["package.json"]
+		},
 		"docs": {
 			"dependsOn": [
 				"@sapphire/async-queue#build",

yarn.lock

@@ -1204,7 +1204,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@sapphire/node-utilities@npm:^1.0.0, @sapphire/node-utilities@workspace:packages/node-utilities":
+"@sapphire/node-utilities@npm:^1.0.0, @sapphire/node-utilities@workspace:^, @sapphire/node-utilities@workspace:packages/node-utilities":
   version: 0.0.0-use.local
   resolution: "@sapphire/node-utilities@workspace:packages/node-utilities"
   dependencies:
@@ -1244,7 +1244,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@sapphire/prettier-config@workspace:packages/prettier-config":
+"@sapphire/prettier-config@workspace:^, @sapphire/prettier-config@workspace:packages/prettier-config":
   version: 0.0.0-use.local
   resolution: "@sapphire/prettier-config@workspace:packages/prettier-config"
   dependencies:
@@ -1404,6 +1404,8 @@ __metadata:
   resolution: "@sapphire/utilities@workspace:packages/utilities"
   dependencies:
     "@favware/cliff-jumper": "npm:^2.2.3"
+    "@sapphire/node-utilities": "workspace:^"
+    "@sapphire/prettier-config": "workspace:^"
     "@vitest/coverage-v8": "npm:^1.1.0"
     esbuild-plugin-file-path-extensions: "npm:^2.0.0"
     tsup: "npm:^8.0.1"