@orkestrel/scaffold 0.0.9 → 0.0.11

package/dist/src/core/index.cjs

@@ -143,6 +143,8 @@ var HOST_PATHS = Object.freeze([
 ]);
 /** The consumer-owned live-service provisioner expected only by service workspaces. */
 var SERVICE_SCRIPT_PATH = "scripts/service.sh";
+/** The consumer-owned Vitest global-setup module shared by its independently selected projects. */
+var GLOBAL_SETUP_PATH = "tests/setupGlobal.ts";
 /** The package-name RegExp — lowercase alphanumeric-with-hyphens, letter-first. */
 var NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
 /** Maximum bare workspace name length beneath the generated `@orkestrel/` scope. */
@@ -225,7 +227,7 @@ var DEFAULT_VERSION = "0.0.1";
 /** The `engines.node` range the `blueprint` builder fills. */
 var DEFAULT_ENGINES = `>=${MINIMUM_NODE_VERSION}`;
 /** The devDependency range generated packages pin `@orkestrel/scaffold` at. */
-var SCAFFOLD_RANGE = "^0.0.8";
+var SCAFFOLD_RANGE = "^0.0.11";
 /** Tooling versions shared by scaffold and every generated workspace. */
 var BASE_DEV_DEPENDENCIES = Object.freeze({
 	"@microsoft/api-extractor": "^7.58.12",
@@ -242,7 +244,7 @@ var BASE_DEV_DEPENDENCIES = Object.freeze({
 /** Additional development dependency required by a published browser source environment. */
 var SOURCE_BROWSER_DEV_DEPENDENCIES = Object.freeze({
 	"@vitest/browser-playwright": "^4.1.10",
-	playwright: "^1.61.1"
+	playwright: "^1.62.0"
 });
 /** Additional development dependencies required by a private Vue browser application. */
 var APP_BROWSER_DEV_DEPENDENCIES = Object.freeze({
@@ -425,8 +427,8 @@ function member(name, category, summary, environment = "core") {
 * `version` / `engines` default `DEFAULT_VERSION` / `DEFAULT_ENGINES`,
 * `src` defaults `['core']`, and `app` / `keywords` / `dependencies` /
 * `peers` / `extras` / `overrides` default `[]`, and `bin` / `integration` /
-* `service` default `false`. `description` is OMITTED entirely when absent, so
-* the result round-trips the exact-record `Blueprint` guard.
+* `service` / `global` default `false`. `description` is OMITTED entirely
+* when absent, so the result round-trips the exact-record `Blueprint` guard.
 * @returns A complete `Blueprint`.
 *
 * @example
@@ -450,7 +452,8 @@ function blueprint(name, options) {
 		overrides: options?.overrides ?? [],
 		bin: options?.bin ?? false,
 		integration: options?.integration ?? false,
-		service: options?.service ?? false
+		service: options?.service ?? false,
+		global: options?.global ?? false
 	};
 	return options?.description === void 0 ? base : {
 		...base,
@@ -1599,6 +1602,22 @@ function computeColumnWidth(text) {
 	return width;
 }
 /**
+* Test whether a complete rendered line fits the fleet formatter's print width.
+*
+* @param text - The complete rendered line, including indentation and trailing punctuation.
+* @returns Whether the line fits within `JSON_PRINT_WIDTH`.
+*
+* @example
+* ```ts
+* import { fitsPrintWidth } from '@orkestrel/scaffold'
+*
+* fitsPrintWidth('\t["ESNext"],') // true
+* ```
+*/
+function fitsPrintWidth(text) {
+	return computeColumnWidth(text) <= 100;
+}
+/**
 * Render a JSON array through `formatJson`'s inline-or-broken rule — inline
 * when the rendered width (via `computeColumnWidth`) fits `JSON_PRINT_WIDTH`, one
 * item per line otherwise.
@@ -1620,7 +1639,7 @@ function renderArray(entries, indent, prefix, suffix) {
 	if (entries.length === 0) return "[]";
 	const items = entries.map((entry) => renderValue(entry, indent, "", ""));
 	const inline = `[${items.join(", ")}]`;
-	if (computeColumnWidth(`${prefix}${inline}${suffix}`) <= 100) return inline;
+	if (fitsPrintWidth(`${prefix}${inline}${suffix}`)) return inline;
 	const childIndent = `${indent}\t`;
 	return `[\n${items.map((item) => `${childIndent}${item}`).join(",\n")}\n${indent}]`;
 }
@@ -1803,7 +1822,8 @@ function blueprintShape() {
 		overrides: (0, _orkestrel_contract.arrayShape)(overrideShape(), { max: MAX_COLLECTION_ITEMS }),
 		bin: (0, _orkestrel_contract.booleanShape)(),
 		integration: (0, _orkestrel_contract.booleanShape)(),
-		service: (0, _orkestrel_contract.booleanShape)()
+		service: (0, _orkestrel_contract.booleanShape)(),
+		global: (0, _orkestrel_contract.booleanShape)()
 	});
 }
 /**
@@ -5773,7 +5793,7 @@ function viteMachinery(src, app = [], bin = false) {
 *
 * @param src - The declared published environments.
 * @param app - The declared application environments.
-* @param axes - Optional executable, integration, and service project axes.
+* @param facts - Optional structural facts.
 * @returns Source projects, application projects, proof projects, then optional axis projects.
 *
 * @example
@@ -5782,7 +5802,7 @@ function viteMachinery(src, app = [], bin = false) {
 * // [{ project: 'srcCore' }, { project: 'policy' }, { project: 'guides' }, { project: 'integration' }]
 * ```
 */
-function viteProjectRegistrations(src, app = [], axes = {}) {
+function viteProjectRegistrations(src, app = [], facts = {}) {
 	const registrations = [];
 	for (const environment of ENVIRONMENTS) {
 		if (!src.includes(environment)) continue;
@@ -5803,15 +5823,15 @@ function viteProjectRegistrations(src, app = [], axes = {}) {
 		if (environment === "server") registrations.push({ project: "appServer" });
 	}
 	registrations.push({ project: "policy" }, { project: "guides" });
-	if (axes.bin === true) registrations.push({ project: "srcBin" });
-	if (axes.integration === true) registrations.push({ project: "integration" });
-	if (axes.service === true) registrations.push({ project: "service" });
+	if (facts.bin === true) registrations.push({ project: "srcBin" });
+	if (facts.integration === true) registrations.push({ project: "integration" });
+	if (facts.service === true) registrations.push({ project: "service" });
 	return registrations;
 }
 /**
 * Render the one ordered proof and structural-axis project definition block.
 *
-* @param axes - Optional executable, integration, and service project axes.
+* @param facts - Optional structural facts.
 * @returns Policy, guides, then selected axis project definitions, separated by one blank line.
 *
 * @example
@@ -5819,11 +5839,11 @@ function viteProjectRegistrations(src, app = [], axes = {}) {
 * viteProjectDefinitions({ bin: true }).includes('export const srcBin =') // true
 * ```
 */
-function viteProjectDefinitions(axes = {}) {
+function viteProjectDefinitions(facts = {}) {
 	const definitions = [policyViteProject(), guidesViteProject()];
-	if (axes.bin === true) definitions.push(binViteProject());
-	if (axes.integration === true) definitions.push(integrationViteProject(axes));
-	if (axes.service === true) definitions.push(serviceViteProject());
+	if (facts.bin === true) definitions.push(binViteProject());
+	if (facts.integration === true) definitions.push(integrationViteProject(facts));
+	if (facts.service === true) definitions.push(serviceViteProject());
 	return definitions.join("\n");
 }
 /**
@@ -5843,16 +5863,18 @@ function viteProjectDefinitions(axes = {}) {
 function renderViteTest(registrations, browser) {
 	const projects = registrations.map((registration) => registration.project);
 	const inlineProjects = `		projects: [${projects.join(", ")}],`;
-	const renderedProjects = computeColumnWidth(inlineProjects) <= 100 ? inlineProjects : `		projects: [
+	const renderedProjects = fitsPrintWidth(inlineProjects) ? inlineProjects : `		projects: [
 ${projects.map((project) => `			${project},`).join("\n")}
 		],`;
 	if (!browser) return `	test: {
 ${renderedProjects}
 	},`;
+	const renderedRegistrations = registrations.map((registration) => registration.browser === void 0 ? `{ project: ${registration.project} }` : `{ project: ${registration.project}, browser: ${serializeTypeScriptString(registration.browser)} }`);
+	const inlineRegistrations = `		[${renderedRegistrations.join(", ")}],`;
 	return `	test: gateBrowserProjects(
-		[
-${registrations.map((registration) => registration.browser === void 0 ? `{ project: ${registration.project} }` : `{ project: ${registration.project}, browser: ${serializeTypeScriptString(registration.browser)} }`).map((registration) => `			${registration},`).join("\n")}
-		],
+${fitsPrintWidth(inlineRegistrations) ? inlineRegistrations : `		[
+${renderedRegistrations.map((registration) => `			${registration},`).join("\n")}
+		],`}
 		hasChromium,
 		process.argv,
 	),`;
@@ -7449,17 +7471,17 @@ function binViteProject() {
 /**
 * Build the standalone Node-only installed-consumer integration proof project.
 *
-* @param axes - Optional executable and integration axes controlling the shared registry setup.
+* @param facts - Optional structural facts controlling the shared global setup.
 * @returns The emitted `integration` project definition.
 *
 * @example
 * ```ts
-* integrationViteProject({ bin: true, integration: true }).includes(
-*   "globalSetup: ['./tests/setupIntegration.ts']",
+* integrationViteProject({ bin: true, integration: true, global: true }).includes(
+*   "globalSetup: ['./tests/setupGlobal.ts']",
 * ) // true
 * ```
 */
-function integrationViteProject(axes = {}) {
+function integrationViteProject(facts = {}) {
 	return `${EXPORT_KEYWORD} const integration = (config?: UserConfig): UserConfig =>
 	mergeConfig(
 		{
@@ -7468,8 +7490,8 @@ function integrationViteProject(axes = {}) {
 				name: { label: 'integration', color: 'blue' },
 				include: ['tests/integration/**/*.test.ts'],
 				setupFiles: ['./tests/setup.ts'],
-${axes.bin === true && axes.integration === true ? `				// Wire the template registry for the generated-consumer proof.
-				globalSetup: ['./tests/setupIntegration.ts'],
+${facts.bin === true && facts.integration === true && facts.global === true ? `				// Wire the template registry for the generated-consumer proof.
+				globalSetup: ['./${GLOBAL_SETUP_PATH}'],
 ` : ""}				environment: 'node',
 				browser: { enabled: false },
 				testTimeout: 120_000,
@@ -7520,7 +7542,7 @@ function serviceViteProject() {
 * projects.
 *
 * @param environment - The sole declared non-`core` environment.
-* @param axes - Optional executable, integration, and service project axes.
+* @param facts - Optional structural facts.
 * @returns The root `vite.config.ts` file content for a single non-`core` environment, newline-terminated.
 *
 * @example
@@ -7528,11 +7550,11 @@ function serviceViteProject() {
 * singleSrcViteConfig('server').includes('srcServer') // true
 * ```
 */
-function singleSrcViteConfig(environment, axes = {}) {
+function singleSrcViteConfig(environment, facts = {}) {
 	const machinery = viteMachinery([environment]);
 	const header = viteHeader(machinery);
-	const renderedTest = renderViteTest(viteProjectRegistrations([environment], [], axes), machinery.browser);
-	const definitions = viteProjectDefinitions(axes);
+	const renderedTest = renderViteTest(viteProjectRegistrations([environment], [], facts), machinery.browser);
+	const definitions = viteProjectDefinitions(facts);
 	if (environment === "browser") return `${header}
 ${EXPORT_KEYWORD} const srcBrowser = (config?: UserConfig): UserConfig =>
 	mergeConfig(
@@ -7559,7 +7581,7 @@ ${EXPORT_KEYWORD} const srcBrowser = (config?: UserConfig): UserConfig =>
 			test: {
 				name: { label: 'src:browser', color: 'yellow' },
 				include: ['tests/src/browser/**/*.test.ts'],
-				setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
+				${facts.global === true ? `globalSetup: ['./${GLOBAL_SETUP_PATH}'],\n\t\t\t\t` : ""}setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
 				...(config?.test?.browser?.enabled === false
 					? {}
 					: {
@@ -7648,9 +7670,9 @@ ${renderedTest}
 *      environment is `browser` (it must run its own tests in a real browser).
 *
 * @param src - The declared `Environment[]`.
-* @param axes - Optional structural project axes. `bin` appends the standalone
-*   executable build-and-test project; `integration` and `service` append their
-*   standalone proof projects.
+* @param facts - Optional structural facts. `bin` appends the standalone executable
+*   build-and-test project; `integration` and `service` append their standalone
+*   proof projects; `global` wires the shared global-setup module.
 * @returns The root `vite.config.ts` file content, newline-terminated.
 *
 * @example
@@ -7658,14 +7680,14 @@ ${renderedTest}
 * rootViteConfig(['core']).includes('srcCore') // true
 * ```
 */
-function rootViteConfig(src, axes = {}) {
+function rootViteConfig(src, facts = {}) {
 	const hasCore = src.includes("core");
 	const nonCore = ENVIRONMENTS.filter((environment) => environment !== "core" && src.includes(environment));
 	const machinery = viteMachinery(src);
 	const header = viteHeader(machinery);
 	if (!hasCore) {
 		const [onlyEnvironment] = nonCore;
-		if (onlyEnvironment === "browser" || onlyEnvironment === "server") return singleSrcViteConfig(onlyEnvironment, axes);
+		if (onlyEnvironment === "browser" || onlyEnvironment === "server") return singleSrcViteConfig(onlyEnvironment, facts);
 	}
 	const browserBlock = `
 ${EXPORT_KEYWORD} const srcBrowser = (config?: UserConfig): UserConfig =>
@@ -7692,7 +7714,7 @@ ${EXPORT_KEYWORD} const srcBrowser = (config?: UserConfig): UserConfig =>
 					name: { label: 'src:browser', color: 'yellow' },
 					include: ['tests/src/browser/**/*.test.ts'],
 					exclude: ['tests/src/core/**/*.test.ts'],
-					setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
+					${facts.global === true ? `globalSetup: ['./${GLOBAL_SETUP_PATH}'],\n\t\t\t\t\t` : ""}setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
 					...(config?.test?.browser?.enabled === false
 						? {}
 						: {
@@ -7760,7 +7782,7 @@ ${EXPORT_KEYWORD} const srcServer = (config?: UserConfig): UserConfig =>
 	)
 `;
 	const blocks = nonCore.map((environment) => environment === "browser" ? browserBlock : serverBlock).join("");
-	const renderedTest = renderViteTest(viteProjectRegistrations(src, [], axes), machinery.browser);
+	const renderedTest = renderViteTest(viteProjectRegistrations(src, [], facts), machinery.browser);
 	return `${header}
 ${EXPORT_KEYWORD} const srcCore = (config?: UserConfig): UserConfig =>
 	mergeConfig(
@@ -7783,7 +7805,7 @@ ${EXPORT_KEYWORD} const srcCore = (config?: UserConfig): UserConfig =>
 		config ?? {},
 	)
 ${blocks}
-${viteProjectDefinitions(axes)}
+${viteProjectDefinitions(facts)}
 export default defineConfig({
 	resolve,
 ${renderedTest}
@@ -7796,7 +7818,7 @@ ${renderedTest}
 *
 * @param src - Published src environments.
 * @param app - Private app environments.
-* @param axes - Optional executable, integration, and service project axes.
+* @param facts - Optional structural facts.
 * @returns The root `vite.config.ts` content.
 *
 * @example
@@ -7804,9 +7826,9 @@ ${renderedTest}
 * applicationViteConfig([], ['core', 'server']).includes('appServer') // true
 * ```
 */
-function applicationViteConfig(src, app, axes = {}) {
+function applicationViteConfig(src, app, facts = {}) {
 	const hasSourceCore = src.includes("core");
-	const machinery = viteMachinery(src, app, axes.bin === true);
+	const machinery = viteMachinery(src, app, facts.bin === true);
 	const header = viteHeader(machinery);
 	const blocks = [];
 	if (src.includes("core")) blocks.push(`
@@ -7858,7 +7880,7 @@ ${EXPORT_KEYWORD} const srcBrowser = (config?: UserConfig): UserConfig =>
 			test: {
 				name: { label: 'src:browser', color: 'yellow' },
 				include: ['tests/src/browser/**/*.test.ts'],
-				${hasSourceCore ? "exclude: ['tests/src/core/**/*.test.ts'],\n				" : ""}setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
+				${hasSourceCore ? "exclude: ['tests/src/core/**/*.test.ts'],\n				" : ""}${facts.global === true ? `globalSetup: ['./${GLOBAL_SETUP_PATH}'],\n\t\t\t\t` : ""}setupFiles: ['./tests/setup.ts', './tests/setupBrowser.ts'],
 				...(config?.test?.browser?.enabled === false
 					? {}
 					: {
@@ -8041,8 +8063,8 @@ ${EXPORT_KEYWORD} const appServer = (config?: UserConfig): UserConfig =>
 		config ?? {},
 	)
 `);
-	const renderedTest = renderViteTest(viteProjectRegistrations(src, app, axes), machinery.browser);
-	const definitions = viteProjectDefinitions(axes);
+	const renderedTest = renderViteTest(viteProjectRegistrations(src, app, facts), machinery.browser);
+	const definitions = viteProjectDefinitions(facts);
 	return `${header}${blocks.join("")}
 ${definitions}
 export default defineConfig({
@@ -8455,7 +8477,7 @@ function configArtifacts(spec) {
 */
 function sourceArtifacts(spec, pascal) {
 	const inlineTypeImport = `import type { ${pascal}Interface, ${pascal}Options } from './types.js'`;
-	const typeImport = computeColumnWidth(inlineTypeImport) <= 100 ? inlineTypeImport : `import type {
+	const typeImport = fitsPrintWidth(inlineTypeImport) ? inlineTypeImport : `import type {
 	${pascal}Interface,
 	${pascal}Options,
 } from './types.js'`;
@@ -8463,7 +8485,7 @@ function sourceArtifacts(spec, pascal) {
 	const inlineSignature = `function create${pascal}(options: ${pascal}Options): ${pascal}Interface`;
 	const values = {
 		pascal,
-		signature: computeColumnWidth(`export ${inlineSignature} {`) <= 100 ? inlineSignature : `function create${pascal}(
+		signature: fitsPrintWidth(`export ${inlineSignature} {`) ? inlineSignature : `function create${pascal}(
 	options: ${pascal}Options,
 ): ${pascal}Interface`,
 		typeImport,
@@ -8537,7 +8559,7 @@ function paritySpecifiers(spec) {
 	for (const environment of spec.app) modules[`@app/${environment}`] = `app/${environment}`;
 	const specifierItems = selfSpecifiers.map((specifier) => `'${specifier}'`);
 	const inlineSpecifierList = `[${specifierItems.join(", ")}]`;
-	return `${EXPORT_KEYWORD} ${CONST_KEYWORD} SELF_SPECIFIERS = ${computeColumnWidth(`const SELF_SPECIFIERS = ${inlineSpecifierList}`) <= 100 ? inlineSpecifierList : `[
+	return `${EXPORT_KEYWORD} ${CONST_KEYWORD} SELF_SPECIFIERS = ${fitsPrintWidth(`const SELF_SPECIFIERS = ${inlineSpecifierList}`) ? inlineSpecifierList : `[
 ${specifierItems.map((specifier) => `\t${specifier},`).join("\n")}
 ]`}
 
@@ -8616,25 +8638,25 @@ function testArtifacts(spec, pascal) {
 	const multilineExplicitInstance = `instance: ${pascal}Interface = new ${pascal}({
 			id: 'example',
 		})`;
-	const explicitInstance = computeColumnWidth(`\t\tconst ${inlineExplicitInstance}`) <= 100 ? inlineExplicitInstance : computeColumnWidth(`\t\tconst instance: ${pascal}Interface = new ${pascal}({`) <= 100 ? multilineExplicitInstance : `instance: ${pascal}Interface =
+	const explicitInstance = fitsPrintWidth(`\t\tconst ${inlineExplicitInstance}`) ? inlineExplicitInstance : fitsPrintWidth(`\t\tconst instance: ${pascal}Interface = new ${pascal}({`) ? multilineExplicitInstance : `instance: ${pascal}Interface =
 			new ${pascal}({
 				id: 'example',
 			})`;
 	const inlineValueImport = `import { create${pascal}, ${pascal} } from '@src/core'`;
-	const valueImport = computeColumnWidth(inlineValueImport) <= 100 ? inlineValueImport : `import {
+	const valueImport = fitsPrintWidth(inlineValueImport) ? inlineValueImport : `import {
 	create${pascal},
 	${pascal},
 } from '@src/core'`;
 	const inlineTestTypeImport = `import type { ${pascal}Interface } from '@src/core'`;
-	const testTypeImport = computeColumnWidth(inlineTestTypeImport) <= 100 ? inlineTestTypeImport : `import type {
+	const testTypeImport = fitsPrintWidth(inlineTestTypeImport) ? inlineTestTypeImport : `import type {
 	${pascal}Interface,
 } from '@src/core'`;
 	const inlineFactoryInstance = `instance = create${pascal}({ id: 'example' })`;
-	const factoryInstance = computeColumnWidth(`\t\tconst ${inlineFactoryInstance}`) <= 100 ? inlineFactoryInstance : `instance = create${pascal}({
+	const factoryInstance = fitsPrintWidth(`\t\tconst ${inlineFactoryInstance}`) ? inlineFactoryInstance : `instance = create${pascal}({
 			id: 'example',
 		})`;
 	const inlineTypeExpectation = `expectTypeOf(create${pascal}({ id: 'example' })).toEqualTypeOf<${pascal}Interface>()`;
-	const typeExpectation = computeColumnWidth(`\t\t${inlineTypeExpectation}`) <= 100 ? inlineTypeExpectation : `expectTypeOf(
+	const typeExpectation = fitsPrintWidth(`\t\t${inlineTypeExpectation}`) ? inlineTypeExpectation : `expectTypeOf(
 			create${pascal}({ id: 'example' }),
 		).toEqualTypeOf<${pascal}Interface>()`;
 	for (const environment of spec.src) {
@@ -9587,6 +9609,7 @@ exports.EXTRA_NAME_PATTERN = EXTRA_NAME_PATTERN;
 exports.EXTRA_RANGE_PATTERN = EXTRA_RANGE_PATTERN;
 exports.FRESHNESS = FRESHNESS;
 exports.FUNCTION_KEYWORD = FUNCTION_KEYWORD;
+exports.GLOBAL_SETUP_PATH = GLOBAL_SETUP_PATH;
 exports.GROUPS = GROUPS;
 exports.HEX_PATTERN = HEX_PATTERN;
 exports.HOST_PATHS = HOST_PATHS;
@@ -9665,6 +9688,7 @@ exports.exportsMap = exportsMap;
 exports.fillArtifact = fillArtifact;
 exports.findFileConflict = findFileConflict;
 exports.findPathConflict = findPathConflict;
+exports.fitsPrintWidth = fitsPrintWidth;
 exports.formatJson = formatJson;
 exports.guideArtifacts = guideArtifacts;
 exports.guideMemberTable = guideMemberTable;