@trenskow/esbuild-package-json 0.1.0

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "keyd",
+        "Kristian",
+        "trenskow"
+    ]
+}

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2026 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,39 @@
+@trenskow/esbuild-package-json
+----
+
+A esbuild plugin for generating `package.json` files.
+
+# Usage
+
+````javascript
+
+	import { build } from 'esbuild';
+	import packageJson from '@trenskow/esbuild-package-json';
+
+	(async () => {
+	const res = await build({
+		entryPoints: ['./src/main.ts'],
+		bundle: true,
+		watch: true,
+		outfile: './dist/main.js',
+		plugins: [
+			packageJson({
+				source: 'package.json',
+				destination: 'dist/package.json',
+				keyPaths: ['name', 'version', /* keys to copy to */],
+				additional: {
+					/* Additional keys to be merged into destination package.json */
+				},
+				postProcess: async ({ source, destination, packageJson }) => {
+					/* Any work that needs to be done before saving. */
+					/* `packageJson` is the object that will be saved to the destination `package.json`. */
+				}
+			})
+		],
+	});
+	})();
+````
+
+# License
+
+See license in LICENSE.

package/eslint.config.js

@@ -0,0 +1,54 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+
+	rules: {
+		indent: ['error', 'tab', {
+			SwitchCase: 1,
+		}],
+
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+
+		'no-console': ['error', {
+			allow: ['warn', 'error', 'info'],
+		}],
+
+		'no-unused-vars': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.d.ts

@@ -0,0 +1,27 @@
+//
+// index.d.ts
+// @trenskow/esbuild-package-json
+//
+// Created by Kristian Trenskow on 2024/12/18
+// See license in LICENSE.
+//
+
+import { Plugin } from 'esbuild';
+
+interface PostProcessOptions {
+	source: string;
+	destination: string;
+	packageJson: Record<string, any>;
+}
+
+interface PackageJsonOptions {
+	source?: string = 'package.json';
+	destination: string;
+	keyPaths?: string[];
+	additional?: Record<string, any>;
+	postProcess?: (options: PostProcessOptions) => Promise<void> | void;
+};
+
+export default function packageJsonPlugin(
+	options: PackageJsonOptions
+): Plugin;

package/index.js

@@ -0,0 +1,67 @@
+//
+// index.js
+// @trenskow/esbuild-package-json
+//
+// Created by Kristian Trenskow on 2024/12/18
+// See license in LICENSE.
+//
+
+import { dirname } from 'path';
+import { readFile, writeFile, mkdir } from 'fs/promises';
+
+import keyd from 'keyd';
+
+export default ({
+	source = 'package.json',
+	destination,
+	keyPaths,
+	additional = {},
+	postProcess
+} = {}) => {
+
+	if (!source) {
+		throw new Error('[package-json] source is required');
+	}
+
+	return {
+		name: 'package-json',
+
+		setup(build) {
+			build.onStart(async () => {
+
+				console.info('[processing] package.json');
+
+				await mkdir(dirname(destination), { recursive: true });
+
+				const sourceContent = await readFile(source, 'utf8');
+
+				keyPaths = keyPaths || keyd(sourceContent).keyPaths();
+
+				const indentation = sourceContent.match(/^( +|\t)/m)
+					?.sort((a, b) => a.length - b.length)?.[0] || '  ';
+
+				const sourcePackageJson = JSON.parse(sourceContent);
+
+				const destinationPackageJson = Object.assign({}, keyPaths.reduce((accumulator, keyPath) => {
+					const value = keyd(sourcePackageJson).get(keyPath);
+					if (typeof value !== 'undefined') {
+						keyd(accumulator).set(keyPath, value);
+					}
+					return accumulator;
+				}, {}), additional);
+
+				if (typeof postProcess === 'function') {
+					await postProcess({
+						source,
+						destination,
+						packageJson: destinationPackageJson
+					});
+				}
+
+				await writeFile(destination, JSON.stringify(destinationPackageJson, null, indentation), 'utf8');
+
+			});
+		}
+	};
+
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@trenskow/esbuild-package-json",
+  "version": "0.1.0",
+  "description": "A esbuild plugin for generating `package.json` files.",
+  "keywords": [
+    "esbuild",
+    "package",
+    "json"
+  ],
+  "homepage": "https://github.com/trenskow/esbuild-package-json#readme",
+  "bugs": {
+    "url": "https://github.com/trenskow/esbuild-package-json/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/trenskow/esbuild-package-json.git"
+  },
+  "license": "BSD-2-Clause",
+  "author": "Kristian Trenskow <this.is@kristians.email>",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "esbuild": "^0.27.2",
+    "keyd": "^2.1.50"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^2.0.2",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
+    "eslint": "^9.39.2",
+    "globals": "^17.3.0"
+  }
+}