@withstudiocms/buildkit 0.1.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 withStudioCMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# `@withstudiocms/buildkit`
+
+This is an esbuild based CLI kit for building Astro Integrations
+
+## Usage
+
+### Installation
+
+Install the package in the root of the repo:
+
+1. Install the required dependencies
+
+```bash
+pnpm add @withstudiocms/buildkit
+```
+
+```bash
+npm install @withstudiocms/buildkit
+```
+
+```bash
+yarn add @withstudiocms/buildkit
+```
+
+### Usage
+
+Once you install the buildkit package you now have access to a `buildkit` CLI utility, add the following to your integration scripts:
+
+```json
+{
+  "scripts": {
+    "build": "buildkit build 'src/**/*.{ts,astro,css}'",
+    "dev": "buildkit dev 'src/**/*.{ts,astro,css}'"
+  }
+}
+```
+
+The command pattern is `buildkit <command> 'path/to/file or glob/**/**.{ts}' [flags]`
+
+#### Available Flags (All are optional)
+
+- `--no-clean-dist`: Do not clean the dist output during build.
+- `--bundle`: Enable bundling.
+- `--force-cjs`: Force CJS output.
+- `--tsconfig=tsconfig.json`: Allows setting custom tsconfig for build time.
+- `--outdir=dist`: Allows settings the output directory.
+
+#### Files considered Assets
+
+The following file extensions will be copied from their src to their respective outputs and not transformed as if they are static assets.
+
+- `.astro`
+- `.d.ts`
+- `.json`
+- `.gif`
+- `.jpeg`
+- `.jpg`
+- `.png`
+- `.tiff`
+- `.webp`
+- `.avif`
+- `.svg`
+
+For other content types and how to use them see [The esBuild Docs](https://esbuild.github.io/content-types/)
+
+## Licensing
+
+-[MIT Licensed](https://github.com/withstudiocms/cachedfetch/blob/main/LICENSE).
++[MIT Licensed](https://github.com/withstudiocms/studiocms/blob/main/LICENSE).

package/index.js

@@ -0,0 +1,207 @@
+#!/usr/bin/env node
+import { execSync } from 'node:child_process';
+import fs from 'node:fs/promises';
+import esbuild from 'esbuild';
+import glob from 'fast-glob';
+import { dim, gray, green, red, yellow } from 'kleur/colors';
+
+/** @type {import('esbuild').BuildOptions} */
+const defaultConfig = {
+	minify: false,
+	format: 'esm',
+	platform: 'node',
+	target: 'node18',
+	sourcemap: false,
+	sourcesContent: false,
+	loader: {
+		'.astro': 'copy',
+		'.d.ts': 'copy',
+		'.json': 'copy',
+		'.gif': 'copy',
+		'.jpeg': 'copy',
+		'.jpg': 'copy',
+		'.png': 'copy',
+		'.tiff': 'copy',
+		'.webp': 'copy',
+		'.avif': 'copy',
+		'.svg': 'copy',
+	},
+};
+
+const dt = new Intl.DateTimeFormat('en-us', {
+	hour: '2-digit',
+	minute: '2-digit',
+});
+
+const dtsGen = (buildTsConfig, outdir) => ({
+	name: 'TypeScriptDeclarationsPlugin',
+	setup(build) {
+		build.onEnd((result) => {
+			if (result.errors.length > 0) return;
+			const date = dt.format(new Date());
+			console.log(`${dim(`[${date}]`)} Generating TypeScript declarations...`);
+			try {
+				const res = execSync(`tsc --emitDeclarationOnly -p ${buildTsConfig} --outDir ./${outdir}`);
+				console.log(res.toString());
+				console.log(dim(`[${date}] `) + green('√ Generated TypeScript declarations'));
+			} catch (error) {
+				console.error(dim(`[${date}] `) + red(`${error}\n\n${error.stdout.toString()}`));
+			}
+		});
+	},
+});
+
+export default async function run() {
+	const [cmd, ...args] = process.argv.slice(2);
+	const config = Object.assign({}, defaultConfig);
+	const patterns = args
+		.filter((f) => !!f) // remove empty args
+		.map((f) => f.replace(/^'/, '').replace(/'$/, '')); // Needed for Windows: glob strings contain surrounding string chars??? remove these
+	const entryPoints = [].concat(
+		...(await Promise.all(
+			patterns.map((pattern) => glob(pattern, { filesOnly: true, absolute: true }))
+		))
+	);
+	const date = dt.format(new Date());
+
+	const noClean = args.includes('--no-clean-dist');
+	const bundle = args.includes('--bundle');
+	const forceCJS = args.includes('--force-cjs');
+	const buildTsConfig =
+		args.find((arg) => arg.startsWith('--tsconfig='))?.split('=')[1] || 'tsconfig.json';
+	const outdir = args.find((arg) => arg.startsWith('--outdir='))?.split('=')[1] || 'dist';
+
+	const { type = 'module', dependencies = {} } = await readPackageJSON('./package.json');
+
+	const format = type === 'module' && !forceCJS ? 'esm' : 'cjs';
+
+	switch (cmd) {
+		case 'dev': {
+			if (!noClean) {
+				console.log(
+					`${dim(`[${date}]`)} Cleaning ${outdir} directory... ${dim(`(${entryPoints.length} files found)`)}`
+				);
+				await clean(outdir, date, [`!${outdir}/**/*.d.ts`]);
+			}
+
+			const rebuildPlugin = {
+				name: 'dev:rebuild',
+				setup(build) {
+					build.onEnd(async (result) => {
+						const date = dt.format(new Date());
+						if (result?.errors.length) {
+							const errMsg = result.errors.join('\n');
+							console.error(dim(`[${date}] `) + red(errMsg));
+						} else {
+							if (result.warnings.length) {
+								console.info(
+									dim(`[${date}] `) +
+										yellow(`! updated with warnings:\n${result.warnings.join('\n')}`)
+								);
+							}
+							console.info(dim(`[${date}] `) + green('√ updated'));
+						}
+					});
+				},
+			};
+
+			const builder = await esbuild.context({
+				...config,
+				entryPoints,
+				outdir,
+				format,
+				sourcemap: 'linked',
+				plugins: [rebuildPlugin],
+			});
+
+			console.log(
+				`${dim(`[${date}] `) + gray('Watching for changes...')} ${dim(`(${entryPoints.length} files found)`)}`
+			);
+			await builder.watch();
+
+			process.on('beforeExit', () => {
+				builder.stop?.();
+			});
+			break;
+		}
+		case 'build': {
+			if (!noClean) {
+				console.log(
+					`${dim(`[${date}]`)} Cleaning ${outdir} directory... ${dim(`(${entryPoints.length} files found)`)}`
+				);
+				await clean(outdir, date, [`!${outdir}/**/*.d.ts`]);
+			}
+			console.log(
+				`${dim(`[${date}]`)} Building...${bundle ? '(Bundling)' : ''} ${dim(`(${entryPoints.length} files found)`)}`
+			);
+			await esbuild.build({
+				...config,
+				bundle,
+				external: bundle ? Object.keys(dependencies) : undefined,
+				entryPoints,
+				outdir,
+				outExtension: forceCJS ? { '.js': '.cjs' } : {},
+				format,
+				plugins: [dtsGen(buildTsConfig, outdir)],
+			});
+			console.log(dim(`[${date}] `) + green('√ Build Complete'));
+			break;
+		}
+		case 'help': {
+			showHelp();
+			break;
+		}
+		default: {
+			showHelp();
+			break;
+		}
+	}
+}
+
+function showHelp() {
+	console.log(`
+${green('StudioCMS Buildkit')} - Build tool for StudioCMS packages
+
+${yellow('Usage:')}
+  buildkit <command> [...files] [...options]
+
+${yellow('Commands:')}
+  dev     Watch files and rebuild on changes
+  build   Perform a one-time build
+  help    Show this help message
+
+${yellow('Options:')}
+  --no-clean-dist    Skip cleaning the dist directory
+  --bundle          Enable bundling mode
+  --force-cjs       Force CommonJS output format
+  --tsconfig=<path> Specify TypeScript config file (default: tsconfig.json)
+  --outdir=<path>   Specify output directory (default: dist)
+
+${yellow('Examples:')}
+  buildkit build "src/**/*.ts"
+  buildkit dev "src/**/*.ts" --no-clean-dist
+  buildkit build "src/**/*.ts" --bundle --force-cjs
+`);
+}
+
+async function clean(outdir, date, skip = []) {
+	const files = await glob([`${outdir}/**`, ...skip], { filesOnly: true });
+	console.log(dim(`[${date}] `) + dim(`Cleaning ${files.length} files from ${outdir}`));
+	await Promise.all(files.map((file) => fs.rm(file, { force: true })));
+}
+
+async function readPackageJSON(path) {
+	try {
+		const content = await fs.readFile(path, { encoding: 'utf8' });
+		try {
+			return JSON.parse(content);
+		} catch (parseError) {
+			throw new Error(`Invalid JSON in ${path}: ${parseError.message}`);
+		}
+	} catch (readError) {
+		throw new Error(`Failed to read ${path}: ${readError.message}`);
+	}
+}
+
+// THIS IS THE ENTRY POINT FOR THE CLI - DO NOT REMOVE
+run();

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@withstudiocms/buildkit",
+  "version": "0.1.0-beta.1",
+  "description": "Build kit based on esbuild for the withstudiocms github org",
+  "author": {
+    "name": "Adam Matthiesen | Jacob Jenkins | Paul Valladares",
+    "url": "https://studiocms.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/withstudiocms/studiocms.git",
+    "directory": "packages/withstudiocms_buildkit"
+  },
+  "license": "MIT",
+  "files": [
+    "index.js",
+    "cmd"
+  ],
+  "type": "module",
+  "main": "./index.js",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "bin": {
+    "buildkit": "./index.js"
+  },
+  "dependencies": {
+    "esbuild": "^0.25.0",
+    "fast-glob": "^3.3.3",
+    "kleur": "^4.1.5"
+  },
+  "devDependencies": {
+    "vitest": "^3.1.1",
+    "strip-ansi": "^7.1.0"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}