@orkestrel/scaffold 0.0.40 → 0.0.42

package/dist/src/core/index.cjs

@@ -129,6 +129,7 @@ var HOST_PATHS = Object.freeze([
 	"tests/policy.test.ts",
 	"tests/config.test.ts",
 	"configs/helpers.ts",
+	"configs/policy.ts",
 	".editorconfig",
 	".gitattributes",
 	".gitignore",
@@ -234,16 +235,16 @@ var NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
 */
 var DEPENDENCY_NAME_PATTERN = /^@orkestrel\/[a-z][a-z0-9-]*$/;
 /**
-* The development extra name syntax: any valid npm package name.
+* The package name syntax for a dependency this package does not publish.
 *
 * @remarks
-* Wider than a runtime dependency name on purpose. An extra is manifest content
-* and never reaches a path, so it may carry any scope or no scope at all. The
-* single optional `/` is still fixed to the one scope boundary, and neither `..`
-* nor a backslash is admitted, so the shape cannot express a traversal even
-* though it accepts far more names.
+* A foreign package is one this package does not publish, so its name reaches
+* no path. It may carry any scope or no scope at all. Each name segment begins
+* with an alphanumeric character after an optional leading `@`, and the name
+* carries at most one `/`. No segment can therefore be `..`, and no backslash
+* is admitted, so the shape cannot express a traversal.
 */
-var EXTRA_NAME_PATTERN = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
+var FOREIGN_NAME_PATTERN = /^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
 /** The exact three-component version syntax a blueprint declares. */
 var VERSION_PATTERN = /^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
 /**
@@ -258,6 +259,15 @@ var VERSION_PATTERN = /^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
 var ORKESTREL_RANGE_PATTERN = /^\^0\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
 /** The registry-only semver subset accepted for a development extra's range. */
 var EXTRA_RANGE_PATTERN = /^(?:\^|~)?(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*)?$/;
+/**
+* The exact three-component floor accepted for a foreign peer's range.
+*
+* @remarks
+* This is independent from {@link ENGINES_PATTERN}. An engine floors the Node
+* runtime a workspace supports, while a peer floors a tool the consumer
+* supplies. Either obligation may change without changing the other.
+*/
+var FLOOR_RANGE_PATTERN = /^>=(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
 /** The minimum-Node engine syntax a blueprint declares. */
 var ENGINES_PATTERN = /^>=(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
 /** Exact lowercase hexadecimal bytes: two digits per byte, and empty content is valid. */
@@ -305,7 +315,7 @@ var DEFAULT_ENGINES = `>=${MINIMUM_NODE_VERSION}`;
 /** The tooling versions scaffold and every generated workspace share. */
 var BASE_DEV_DEPENDENCIES = Object.freeze({
 	"@orkestrel/guide": "^0.0.12",
-	"@orkestrel/scaffold": "^0.0.40",
+	"@orkestrel/scaffold": "^0.0.41",
 	"@orkestrel/test": "^0.0.6",
 	"@types/node": "^26.2.0",
 	oxfmt: "^0.62.0",
@@ -405,6 +415,7 @@ var CONFIG_TEMPLATES = Object.freeze({
 `,
 		vite: `import type { {{viteTypes}} } from 'vite'
 {{imports}}import { defineConfig, mergeConfig } from 'vitest/config'
+import manifest from './package.json' with { type: 'json' }
 import tsconfig from './tsconfig.json' with { type: 'json' }
 {{helpers}}{{browsers}}import { fileURLToPath, URL } from 'node:url'
 
@@ -412,6 +423,18 @@ import tsconfig from './tsconfig.json' with { type: 'json' }
 	return fileURLToPath(new URL(relativePath, import.meta.url))
 }
 
+const peerDependencies = 'peerDependencies' in manifest ? manifest.peerDependencies : undefined
+if (
+	peerDependencies !== undefined &&
+	(typeof peerDependencies !== 'object' ||
+		peerDependencies === null ||
+		Array.isArray(peerDependencies))
+) {
+	throw new Error('package peerDependencies must be an object')
+}
+export const peers: readonly string[] =
+	peerDependencies === undefined ? [] : Object.keys(peerDependencies)
+
 const resolve = {
 	alias: Object.entries(tsconfig.compilerOptions.paths).reduce((aliases, [key, values]) => {
 		const [path] = values
@@ -539,7 +562,13 @@ const resolve = {
 				},
 				outDir: 'dist/bin',
 				target: 'node22',
-				rolldownOptions: { external: [/^node:/, /^@orkestrel\\//, /^@src\\//] },
+				rolldownOptions: {
+					external: (id: string) =>
+						id.startsWith('node:') ||
+						id.startsWith('@orkestrel/') ||
+						id.startsWith('@src/') ||
+						peers.some((peer) => id === peer || id.startsWith(peer + '/')),
+				},
 			},
 			test: {
 				name: { label: 'src:bin', color: 'yellow' },
@@ -660,6 +689,24 @@ export function appBrowser(): UserConfig {
 				setupFiles: ['./tests/setup.ts'],
 				environment: 'node',
 				browser: { enabled: false },
+				// A config test validates every target wrapper and runs the real linter twice with
+				// 15-second child caps, so this budget clears both caps and reports their diagnostics.
+				testTimeout: 45_000,
+			},
+		},
+		options ?? {},
+	)
+`,
+		setup: `export const setup = (options?: UserConfig): UserConfig =>
+	mergeConfig(
+		{
+			resolve,
+			test: {
+				name: { label: 'setup', color: 'white' },
+				include: ['tests/setup*.test.ts'],
+				setupFiles: ['./tests/setup.ts'],
+				environment: 'node',
+				browser: { enabled: false },
 			},
 		},
 		options ?? {},
@@ -895,7 +942,7 @@ export const probe = (options?: UserConfig): UserConfig =>
 			core: `import { defineConfig } from 'vite'
 import dts from 'vite-plugin-dts'
 import { environmentBoundary, outputBoundary } from '../helpers.js'
-import { srcCore, resolveWorkspacePath } from '../../vite.config.ts'
+import { peers, srcCore, resolveWorkspacePath } from '../../vite.config.ts'
 
 export default defineConfig(
 	srcCore({
@@ -923,7 +970,12 @@ export default defineConfig(
 				fileName: (format) => (format === 'es' ? 'index.js' : 'index.cjs'),
 			},
 			outDir: 'dist/src/core',
-			rolldownOptions: { external: [/^node:/, /^@orkestrel\\//] },
+			rolldownOptions: {
+				external: (id: string) =>
+					id.startsWith('node:') ||
+					id.startsWith('@orkestrel/') ||
+					peers.some((peer) => id === peer || id.startsWith(peer + '/')),
+			},
 		},
 	}),
 )
@@ -1716,6 +1768,7 @@ var isBlueprint = (0, _orkestrel_contract.recordOf)({
 	engines: _orkestrel_contract.isString,
 	overrides: (0, _orkestrel_contract.andOf)(isCollection, (0, _orkestrel_contract.arrayOf)(isOverride)),
 	bin: _orkestrel_contract.isBoolean,
+	setup: _orkestrel_contract.isBoolean,
 	guides: _orkestrel_contract.isBoolean,
 	distribution: _orkestrel_contract.isBoolean,
 	integration: _orkestrel_contract.isBoolean,
@@ -2973,7 +3026,10 @@ function srcToExports(src) {
 * each declared axis adds the set its host needs. A declared extra or peer is
 * applied after those, so a workspace that pins a range for a package the
 * conditional sets also name gets the range it declared. An extra that restates
-* a shared toolchain pin never reaches here, because the gate refuses it.
+* a shared toolchain pin never reaches here, because the gate refuses it. A peer
+* that names a development tool already selected keeps that tool's pin, because
+* the peer's floor states what consumers may supply rather than what this workspace
+* develops against.
 *
 * A peer is declared here as well as under `peerDependencies`, because a peer is
 * not installed by the workspace that declares it and developing against one
@@ -3006,7 +3062,7 @@ function blueprintToDevDependencies(blueprint) {
 		...blueprint.app.includes("server") ? APP_SERVER_DEV_DEPENDENCIES : {}
 	};
 	for (const extra of blueprint.extras) merged[extra.name] = extra.range;
-	for (const peer of blueprint.peers) merged[peer.name] = peer.range;
+	for (const peer of blueprint.peers) if (!Object.hasOwn(merged, peer.name)) merged[peer.name] = peer.range;
 	const own = blueprint.src.length > 0 ? `@orkestrel/${blueprint.name}` : blueprint.name;
 	const runtime = new Set(blueprint.dependencies.map((dependency) => dependency.name));
 	return Object.fromEntries(Object.entries(merged).filter(([name]) => name !== own && !runtime.has(name)).sort(([left], [right]) => (0, _orkestrel_contract.compareValues)(left, right)));
@@ -3079,6 +3135,7 @@ function blueprintToScripts(blueprint) {
 		...blueprint.app.length > 0 ? ["npm run test:app"] : [],
 		"npm run test:policy",
 		"npm run test:config",
+		...blueprint.setup ? ["npm run test:setup"] : [],
 		...blueprint.guides ? ["npm run test:guides"] : [],
 		...blueprint.conformance ? ["npm run test:conformance"] : [],
 		...integrates ? ["npm run test:integration"] : [],
@@ -3099,6 +3156,7 @@ function blueprintToScripts(blueprint) {
 	}
 	scripts["test:policy"] = `${vitest} --project policy`;
 	scripts["test:config"] = `${vitest} --project config`;
+	if (blueprint.setup) scripts["test:setup"] = `${vitest} --project setup`;
 	if (blueprint.guides) scripts["test:guides"] = `${vitest} --project guides`;
 	if (blueprint.conformance) scripts["test:conformance"] = `${vitest} --project conformance`;
 	scripts["test:probe"] = "vitest run --config vite.config.ts --no-cache --reporter=verbose --project probe";
@@ -3322,7 +3380,12 @@ function blueprintToRootVite(blueprint) {
 	if (blueprint.src.includes("browser")) {
 		const core = blueprint.src.includes("core");
 		factories.push((0, _orkestrel_template.fillTemplate)(CONFIG_TEMPLATES.factories.src.browser, {
-			external: core ? "external: (id: string) => id === '@src/core' || id.startsWith('@orkestrel/')," : "external: (id: string) => id.startsWith('@orkestrel/'),",
+			external: core ? `external: (id: string) =>
+						id === '@src/core' ||
+						id.startsWith('@orkestrel/') ||
+						peers.some((peer) => id === peer || id.startsWith(peer + '/')),` : `external: (id: string) =>
+						id.startsWith('@orkestrel/') ||
+						peers.some((peer) => id === peer || id.startsWith(peer + '/')),`,
 			output: core ? "					output: { paths: { '@src/core': '../core/index.js' } }," : "					output: {},",
 			exclude: core ? "				exclude: ['tests/src/core/**/*.test.ts'],\n" : "",
 			global: blueprint.global ? "				globalSetup: ['./tests/setupGlobal.ts'],\n" : ""
@@ -3333,7 +3396,13 @@ function blueprintToRootVite(blueprint) {
 		const core = blueprint.src.includes("core");
 		factories.push((0, _orkestrel_template.fillTemplate)(CONFIG_TEMPLATES.factories.src.server, {
 			external: core ? `external: (id: string) =>
-						id === '@src/core' || id.startsWith('node:') || id.startsWith('@orkestrel/'),` : "external: (id: string) => id.startsWith('node:') || id.startsWith('@orkestrel/'),",
+						id === '@src/core' ||
+						id.startsWith('node:') ||
+						id.startsWith('@orkestrel/') ||
+						peers.some((peer) => id === peer || id.startsWith(peer + '/')),` : `external: (id: string) =>
+						id.startsWith('node:') ||
+						id.startsWith('@orkestrel/') ||
+						peers.some((peer) => id === peer || id.startsWith(peer + '/')),`,
 			output: core ? `\t\t\t\t\toutput: [
 						{
 							format: 'es',
@@ -3420,6 +3489,10 @@ export function appShowcase(): UserConfig {
 	projects.push("policy");
 	factories.push(CONFIG_TEMPLATES.factories.config);
 	projects.push("config");
+	if (blueprint.setup) {
+		factories.push(CONFIG_TEMPLATES.factories.setup);
+		projects.push("setup");
+	}
 	if (blueprint.guides) {
 		factories.push(CONFIG_TEMPLATES.factories.guides);
 		projects.push("guides");
@@ -4078,11 +4151,11 @@ function planToFindings(plan, current) {
 * range, in list order.
 *
 * @remarks
-* The three declared lists differ only in the two syntaxes they accept, so the
-* rules live here once and each caller supplies its own patterns. A runtime
-* dependency name reaches a path through its guide mirror and is fixed to the
-* `@orkestrel` scope; a development extra never reaches a path and admits any
-* valid npm name.
+* The declared lists and peer partitions differ only in the two syntaxes they
+* accept, so the rules live here once and each caller supplies its own patterns.
+* A runtime dependency name reaches a path through its guide mirror and is
+* fixed to the `@orkestrel` scope. A foreign peer or development extra reaches
+* no path and admits any valid npm name.
 *
 * Both patterns must be stateless. A global or sticky pattern carries a
 * `lastIndex` between calls, so it would answer differently for the same input
@@ -4240,7 +4313,7 @@ function blueprintToQuestions(blueprint) {
 		message: "showcase projects a browser app, and this workspace declares none, so it emits nothing.",
 		blocking: false
 	});
-	questions.push(...dependenciesToQuestions(blueprint.dependencies, "dependencies", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.peers, "peers", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.extras, "extras", EXTRA_NAME_PATTERN, EXTRA_RANGE_PATTERN));
+	questions.push(...dependenciesToQuestions(blueprint.dependencies, "dependencies", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.peers.filter((peer) => peer.name.startsWith("@orkestrel/")), "peers", DEPENDENCY_NAME_PATTERN, ORKESTREL_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.peers.filter((peer) => !peer.name.startsWith("@orkestrel/")), "peers", FOREIGN_NAME_PATTERN, FLOOR_RANGE_PATTERN), ...dependenciesToQuestions(blueprint.extras, "extras", FOREIGN_NAME_PATTERN, EXTRA_RANGE_PATTERN));
 	const lists = [
 		["dependencies", blueprint.dependencies],
 		["peers", blueprint.peers],
@@ -4742,6 +4815,7 @@ function createBlueprint(name, input) {
 		engines: input?.engines ?? DEFAULT_ENGINES,
 		overrides: input?.overrides ?? [],
 		bin: input?.bin ?? false,
+		setup: input?.setup ?? false,
 		guides: input?.guides ?? false,
 		distribution: input?.distribution ?? false,
 		integration: input?.integration ?? false,
@@ -4795,8 +4869,9 @@ exports.DISTRIBUTION_TEST_PATH = DISTRIBUTION_TEST_PATH;
 exports.ENGINES_PATTERN = ENGINES_PATTERN;
 exports.ENVIRONMENTS = ENVIRONMENTS;
 exports.EXECUTABLE_PATHS = EXECUTABLE_PATHS;
-exports.EXTRA_NAME_PATTERN = EXTRA_NAME_PATTERN;
 exports.EXTRA_RANGE_PATTERN = EXTRA_RANGE_PATTERN;
+exports.FLOOR_RANGE_PATTERN = FLOOR_RANGE_PATTERN;
+exports.FOREIGN_NAME_PATTERN = FOREIGN_NAME_PATTERN;
 exports.GLOBAL_SETUP_PATH = GLOBAL_SETUP_PATH;
 exports.GROUPS = GROUPS;
 exports.GUIDES_TEST_PATH = GUIDES_TEST_PATH;