@wp-typia/create-workspace-template 0.13.1 → 0.14.0

package/README.md.mustache

@@ -30,6 +30,7 @@ wp-typia add pattern hero-layout
 ## Development
 
 ```bash
+bun run sync
 bun run build
 bun run typecheck
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-typia/create-workspace-template",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "description": "Official empty wp-typia workspace template package",
   "packageManager": "bun@1.3.11",
   "type": "module",

package/package.json.mustache

@@ -6,12 +6,13 @@
   "author": "{{author}}",
   "license": "GPL-2.0-or-later",
   "scripts": {
+    "sync": "tsx scripts/sync-project.ts",
     "sync-types": "tsx scripts/sync-types-to-block-json.ts",
     "sync-rest": "tsx scripts/sync-rest-contracts.ts",
-    "build": "bun run sync-types --check && bun run sync-rest --check && node scripts/build-workspace.mjs build",
-    "start": "bun run sync-types && bun run sync-rest && node scripts/build-workspace.mjs start",
+    "build": "bun run sync --check && node scripts/build-workspace.mjs build",
+    "start": "bun run sync && node scripts/build-workspace.mjs start",
     "dev": "bun run start",
-    "typecheck": "bun run sync-types --check && bun run sync-rest --check && tsc --noEmit",
+    "typecheck": "bun run sync --check && tsc --noEmit",
     "lint:js": "wp-scripts lint-js",
     "lint:css": "wp-scripts lint-style",
     "lint": "bun run lint:js && bun run lint:css",

package/scripts/sync-project.ts.mustache

@@ -0,0 +1,103 @@
+/* eslint-disable no-console */
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
+interface SyncCliOptions {
+	check: boolean;
+}
+
+function parseCliOptions( argv: string[] ): SyncCliOptions {
+	const options: SyncCliOptions = {
+		check: false,
+	};
+
+	for ( const argument of argv ) {
+		if ( argument === '--check' ) {
+			options.check = true;
+			continue;
+		}
+
+		throw new Error( `Unknown sync flag: ${ argument }` );
+	}
+
+	return options;
+}
+
+function getSyncScriptEnv() {
+	const binaryDirectory = path.join( process.cwd(), 'node_modules', '.bin' );
+	const inheritedPath =
+		process.env.PATH ??
+		process.env.Path ??
+		Object.entries( process.env ).find(
+			( [ key ] ) => key.toLowerCase() === 'path'
+		)?.[ 1 ] ??
+		'';
+	const nextPath = fs.existsSync( binaryDirectory )
+		? `${ binaryDirectory }${ path.delimiter }${ inheritedPath }`
+		: inheritedPath;
+	const env: NodeJS.ProcessEnv = {
+		...process.env,
+	};
+
+	for ( const key of Object.keys( env ) ) {
+		if ( key.toLowerCase() === 'path' ) {
+			delete env[ key ];
+		}
+	}
+
+	env.PATH = nextPath;
+
+	return env;
+}
+
+function runSyncScript( scriptPath: string, options: SyncCliOptions ) {
+	const args = [ scriptPath ];
+	if ( options.check ) {
+		args.push( '--check' );
+	}
+
+	const result = spawnSync( 'tsx', args, {
+		cwd: process.cwd(),
+		env: getSyncScriptEnv(),
+		shell: process.platform === 'win32',
+		stdio: 'inherit',
+	} );
+
+	if ( result.error ) {
+		if ( ( result.error as NodeJS.ErrnoException ).code === 'ENOENT' ) {
+			throw new Error(
+				'Unable to resolve `tsx` for project sync. Install project dependencies or rerun the command through your package manager.'
+			);
+		}
+
+		throw result.error;
+	}
+
+	if ( result.status !== 0 ) {
+		throw new Error( `Sync script failed: ${ scriptPath }` );
+	}
+}
+
+async function main() {
+	const options = parseCliOptions( process.argv.slice( 2 ) );
+	const syncTypesScriptPath = path.join( 'scripts', 'sync-types-to-block-json.ts' );
+	const syncRestScriptPath = path.join( 'scripts', 'sync-rest-contracts.ts' );
+
+	runSyncScript( syncTypesScriptPath, options );
+
+	if ( fs.existsSync( path.resolve( process.cwd(), syncRestScriptPath ) ) ) {
+		runSyncScript( syncRestScriptPath, options );
+	}
+
+	console.log(
+		options.check
+			? '✅ Generated project metadata and REST artifacts are already synchronized.'
+			: '✅ Generated project metadata and REST artifacts were synchronized.'
+	);
+}
+
+main().catch( ( error ) => {
+	console.error( '❌ Project sync failed:', error );
+	process.exit( 1 );
+} );

package/scripts/sync-rest-contracts.ts.mustache

@@ -2,6 +2,7 @@
 import path from 'node:path';
 
 import {
+	runSyncBlockMetadata,
 	syncEndpointClient,
 	syncRestOpenApi,
 	syncTypeSchemas,
@@ -41,6 +42,34 @@ function isRestEnabledBlock(
 	);
 }
 
+async function assertTypeArtifactsCurrent( block: WorkspaceBlockConfig ) {
+	const report = await runSyncBlockMetadata(
+		{
+			blockJsonFile: path.join( 'src', 'blocks', block.slug, 'block.json' ),
+			jsonSchemaFile: path.join( 'src', 'blocks', block.slug, 'typia.schema.json' ),
+			manifestFile: path.join( 'src', 'blocks', block.slug, 'typia.manifest.json' ),
+			openApiFile: path.join( 'src', 'blocks', block.slug, 'typia.openapi.json' ),
+			sourceTypeName: block.attributeTypeName,
+			typesFile: block.typesFile,
+		},
+		{
+			check: true,
+		}
+	);
+
+	if ( report.failure?.code === 'stale-generated-artifact' ) {
+		throw new Error(
+			`${ block.slug }: ${ report.failure.message }\nRun \`sync\` or \`sync-types\` first to refresh type-derived artifacts before rerunning \`sync-rest\`.`
+		);
+	}
+
+	if ( report.failure ) {
+		throw new Error(
+			`${ block.slug }: type-derived artifact preflight failed before sync-rest.\n${ report.failure.message }`
+		);
+	}
+}
+
 async function main() {
 	const options = parseCliOptions( process.argv.slice( 2 ) );
 	const restBlocks = BLOCKS.filter( isRestEnabledBlock );
@@ -55,6 +84,8 @@ async function main() {
 	}
 
 	for ( const block of restBlocks ) {
+		await assertTypeArtifactsCurrent( block );
+
 		const contracts = block.restManifest.contracts;
 
 		for ( const [ baseName, contract ] of Object.entries( contracts ) ) {