@lazycatcloud/lzc-cli 1.3.17 → 2.0.0-pre.1

package/lib/app/lpk_create.js

@@ -1,6 +1,6 @@
 import logger from 'loglevel';
 import inquirer from 'inquirer';
-import { contextDirname, loadFromYaml, envTemplateFile, ensureDir, ensureDirectoryExists, dumpToYaml, isFileExist, isValidAppId, fakeLoadManifestYml } from '../utils.js';
+import { contextDirname, ensureDir, ensureDirectoryExists, dumpToYaml, isFileExist, isValidAppId, envsubstr } from '../utils.js';
 import path from 'node:path';
 import { TemplateConfig } from './lpk_create_generator.js';
 import fs from 'node:fs';
@@ -8,38 +8,113 @@ import yaml from 'js-yaml';
 import chalk from 'chalk';
 import { t } from '../i18n/index.js';
 
-let fsPromises = fs.promises;
 
-export class LpkManifest {
-	constructor(defaultAppID) {
+function fakeLoadManifestText(text) {
+	let obj = {
+		application: {
+			subdomain: undefined,
+		},
+	};
+
+	const normalizeValue = (value) => {
+		const commentIndex = value.indexOf(' #');
+		if (commentIndex >= 0) {
+			value = value.slice(0, commentIndex);
+		}
+		return value.trim();
+	};
+
+	String(text ?? '').split('\n').forEach((rawLine) => {
+		const line = rawLine.trim();
+		const arr = line.split(':');
+		if (arr.length !== 2) {
+			return;
+		}
+		let [key, value] = arr;
+		value = normalizeValue(value);
+		if (!obj.package && key === 'package') {
+			obj.package = value;
+		}
+		if (!obj.application.subdomain && key === 'subdomain') {
+			obj.application.subdomain = value;
+		}
+		if (!obj.version && key === 'version') {
+			obj.version = value;
+		}
+	});
+	return obj;
+}
+
+async function renderTemplateText(templateFilePath, templateVars) {
+	const templateText = fs.readFileSync(templateFilePath, 'utf-8');
+	return await envsubstr(templateText, {
+		options: {
+			envs: Object.entries(templateVars).map(([key, value]) => ({
+				name: key.replace(/-/g, '_'),
+				value,
+			})),
+			syntax: 'default',
+			protect: false,
+		},
+	});
+}
+
+function loadTemplateYaml(text, fallbackLoader) {
+	try {
+		return {
+			data: yaml.load(text),
+			excp: false,
+		};
+	} catch {
+		return {
+			data: fallbackLoader(text),
+			excp: true,
+		};
+	}
+}
+
+export class LpkTemplateFile {
+	constructor(defaultAppID, outputFileName, fallbackLoader = (text) => yaml.load(text)) {
 		this.pwd = contextDirname(import.meta.url);
-		this.manifest = {};
 		this.defaultAppID = defaultAppID;
+		this.outputFileName = outputFileName;
+		this.fallbackLoader = fallbackLoader;
+		this.data = {};
+		this.text = '';
+		this.excpTemplate = false;
 	}
 
-	async init(manifestFilePath, askInfo = false) {
-		if (!manifestFilePath) {
-			manifestFilePath = path.join(this.pwd, '..', '..', 'template', '_lpk', 'manifest.yml.in');
+	async init(templateFilePath, askInfo = false, templateVars = null) {
+		if (!templateFilePath) {
+			throw new Error(`template file is required for ${this.outputFileName}`);
 		}
 
+		let vars = templateVars;
 		if (askInfo) {
-			let answer = await this.askLpkInfo();
-			this.manifest = yaml.load(await envTemplateFile(manifestFilePath, answer));
-		} else {
-			try {
-				this.manifest = loadFromYaml(manifestFilePath);
-			} catch (err) {
-				this.manifest = fakeLoadManifestYml(manifestFilePath);
-				this.excpManifest = true;
-			}
+			vars = vars || (await this.askLpkInfo());
+			this.text = await renderTemplateText(templateFilePath, vars);
+			const loaded = loadTemplateYaml(this.text, this.fallbackLoader);
+			this.data = loaded.data;
+			this.excpTemplate = loaded.excp;
+			return vars;
 		}
+
+		const templateText = fs.readFileSync(templateFilePath, 'utf-8');
+		const loaded = loadTemplateYaml(templateText, this.fallbackLoader);
+		this.data = loaded.data;
+		this.excpTemplate = loaded.excp;
+		return vars;
 	}
 
 	async create(outputDir) {
-		let outputFilePath = path.join(outputDir, 'lzc-manifest.yml');
+		let outputFilePath = path.join(outputDir, this.outputFileName);
 		logger.debug(`create file ${outputFilePath}`);
 		ensureDir(outputFilePath);
-		return dumpToYaml(this.manifest, outputFilePath);
+		if (this.text) {
+			fs.writeFileSync(outputFilePath, this.text);
+			return;
+		}
+		return dumpToYaml(this.data, outputFilePath);
 	}
 
 	async askLpkInfo() {
@@ -61,61 +136,133 @@ export class LpkManifest {
 				},
 			},
 		]);
-		const answer = {
+		return {
 			name: appId,
 			package: `cloud.lazycat.app.${appId}`,
 			subdomain: appId,
 		};
-		return answer;
 	}
 }
 
+export class LpkManifest extends LpkTemplateFile {
+	constructor(defaultAppID) {
+		super(defaultAppID, 'lzc-manifest.yml', fakeLoadManifestText);
+	}
+}
+
+export class LpkPackageFile extends LpkTemplateFile {
+	constructor(defaultAppID) {
+		super(defaultAppID, 'package.yml');
+	}
+}
+
+const PROJECT_TEMPLATE_OPTIONS = [
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_hello_vue',
+		defaultText: 'hello-vue (Vue基础模板)',
+		value: 'hello-vue',
+	},
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_todolist_java',
+		defaultText: 'todolist-java (Java Todo示例)',
+		value: 'todolist-java',
+	},
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_todolist_python',
+		defaultText: 'todolist-python (Python Todo示例)',
+		value: 'todolist-python',
+	},
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_todolist_golang',
+		defaultText: 'todolist-golang (Golang Todo示例)',
+		value: 'todolist-golang',
+	},
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_gui_vnc',
+		defaultText: 'gui-vnc (GUI VNC Embed示例)',
+		value: 'gui-vnc',
+	},
+	{
+		i18nKey: 'lzc_cli.lib.app.lpk_create.template_option_todolist_serverless',
+		defaultText: 'todolist-serverless (Serverless Todo示例)',
+		value: 'todolist-serverless',
+	},
+];
+
+export function listProjectTemplateValues() {
+	return PROJECT_TEMPLATE_OPTIONS.map((item) => item.value);
+}
+
+export function normalizeTemplateType(rawType) {
+	const type = String(rawType ?? '').trim();
+	if (!type) {
+		return '';
+	}
+	const allowedTypes = listProjectTemplateValues();
+	if (!allowedTypes.includes(type)) {
+		throw new Error(`Unsupported template "${type}". Available templates: ${allowedTypes.join(', ')}`);
+	}
+	return type;
+}
+
 export class TemplateInit {
 	constructor(cwd, name, type) {
 		this.cwd = cwd;
 		this.name = name;
-		this.type = type;
+		this.type = normalizeTemplateType(type);
 		this.lpkManifest = new LpkManifest(name);
+		this.lpkPackageFile = new LpkPackageFile(name);
 	}
 
 	async init() {
-		if (!this.type) {
-			this.type = await chooseTemplate();
-		}
+		this.type = await chooseTemplate(this.type);
 
-		// 优先使用模板项目自定义的模板文件
-		const typeTemplatePath = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', `${this.type}.manifest.yml.in`);
-		const templatePath = isFileExist(typeTemplatePath) ? typeTemplatePath : '';
-		await this.lpkManifest.init(templatePath, true);
+		const templateRoot = path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk');
+		const typeTemplatePath = path.join(templateRoot, `${this.type}.manifest.yml.in`);
+		const manifestTemplatePath = isFileExist(typeTemplatePath) ? typeTemplatePath : path.join(templateRoot, 'manifest.yml.in');
+		const packageTemplatePath = path.join(templateRoot, 'package.yml.in');
+		const templateVars = await this.lpkManifest.init(manifestTemplatePath, true);
+		await this.lpkPackageFile.init(packageTemplatePath, true, templateVars);
 	}
 
 	async create() {
-		await this.lpkManifest.create(path.resolve(this.cwd, this.name));
+		const outputDir = path.resolve(this.cwd, this.name);
+		await this.lpkManifest.create(outputDir);
+		await this.lpkPackageFile.create(outputDir);
 	}
 }
 
-export async function chooseTemplate() {
+export async function chooseTemplate(preselectedType = '') {
+	const fixedType = normalizeTemplateType(preselectedType);
+	if (fixedType) {
+		return fixedType;
+	}
+
 	return (
-		await inquirer.prompt([
-			{
-				name: 'type',
-				message: t('lzc_cli.lib.app.lpk_create.choose_template_message', '选择项目构建模板'),
-				type: 'list',
-				choices: ['vue3'],
-			},
-		])
-	)['type'];
+			await inquirer.prompt([
+				{
+					name: 'type',
+					message: t('lzc_cli.lib.app.lpk_create.choose_template_message', '选择项目构建模板'),
+					type: 'list',
+					choices: PROJECT_TEMPLATE_OPTIONS.map((item) => ({
+						name: t(item.i18nKey, item.defaultText),
+						value: item.value,
+					})),
+				},
+				])
+		)['type'];
 }
 
 // 创建一个应用
-// - 先选择模板信息（golang, vue3)
+// - 先选择模板信息（todolist-golang, hello-vue)
 // - 根据 lpk manifest 模板中所需要的字段填充manifest
 // - 调用模板的hook
 class LpkCreate {
-	constructor(name, cwd = process.cwd()) {
+	constructor(name, cwd = process.cwd(), type = '') {
 		this.name = name;
 		this.cwd = cwd ?? process.cwd();
 		this.appDir = path.resolve(this.cwd, this.name);
+		this.type = normalizeTemplateType(type);
 	}
 
 	async init() {
@@ -123,7 +270,7 @@ class LpkCreate {
 	}
 
 	async exec() {
-		const type = await chooseTemplate();
+		const type = await chooseTemplate(this.type);
 		const template = new TemplateInit(this.cwd, this.name, type);
 		await template.init();
 
@@ -148,7 +295,7 @@ class LpkCreate {
 	}
 }
 
-export default async (name, cwd = process.cwd()) => {
-	const lpk = await new LpkCreate(name, cwd).init();
+export default async (name, cwd = process.cwd(), type = '') => {
+	const lpk = await new LpkCreate(name, cwd, type).init();
 	return await lpk.exec();
 };

package/lib/app/lpk_create_generator.js

@@ -4,7 +4,6 @@ import fs from 'fs';
 import { isBinaryFileSync } from 'isbinaryfile';
 import { contextDirname } from '../utils.js';
 import chalk from 'chalk';
-// import spawn from "cross-spawn"
 import logger from 'loglevel';
 import { t } from '../i18n/index.js';
 
@@ -27,7 +26,6 @@ async function loadFiles(dirPath, prefix = '') {
 		} else {
 			content = fs.readFileSync(sourcePath, 'utf8');
 		}
-		// change _ prefix file into dot file
 		if (p.startsWith('_')) {
 			p = p.replace('_', '.');
 		}
@@ -56,19 +54,25 @@ export async function generate(type, to, opts = {}) {
 	writeFileTree(to, files);
 }
 
-function appCreateSuccessTip(name) {
+function appCreateSuccessTipByCommands(name, installCommand = '') {
+	const installBlock = installCommand ? `\n   ${installCommand}` : '';
 	console.log(
 		chalk.green(
 			t(
-				'lzc_cli.lib.app.lpk_create_generator.app_create_success_tip',
+				'lzc_cli.lib.app.lpk_create_generator.app_create_success_tip_common',
 				`
 ✨ 懒猫微服应用已创建成功 !
-✨ 进行下面步骤后即可进入容器开发
-   cd {{ name }}
-   lzc-cli project devshell
+✨ First deploy and open the app once
+   cd {{ name }}{{ installBlock }}
+   lzc-cli project deploy
+   lzc-cli project info
+ℹ By default, project commands use lzc-build.dev.yml when it exists.
+   Each command prints the active Build config.
+   Use --release if you want to operate on lzc-build.yml.
    `,
 				{
 					name,
+					installBlock,
 					interpolation: { escapeValue: false }
 				},
 			).trim(),
@@ -77,22 +81,146 @@ function appCreateSuccessTip(name) {
 }
 
 export const TemplateConfig = {
-	vue3: {
+	'hello-vue': {
 		build: async (to, option) => {
 			await generate('vue', to, option);
 		},
 		after: async function (name) {
-			appCreateSuccessTip(name);
+			appCreateSuccessTipByCommands(name);
 			console.log(
 				chalk.green(
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_vue3_green',
 						`
-⚙️  进入应用容器后执行下面命令:
-   npm install
+🛠 Open the app first.
+   If the frontend dev server is not running yet, the app page will show the expected port and next step.
+Then start local frontend dev:
    npm run dev
-🚀 启动应用:
-   进入微服客户端启动器页面点击应用图标来测试应用
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   `,
+					).trim(),
+				),
+			);
+		},
+	},
+	'todolist-java': {
+		build: async (to, option) => {
+			await generate('springboot', to, option);
+		},
+		after: async function (name) {
+			appCreateSuccessTipByCommands(name);
+			console.log(
+				chalk.green(
+					t(
+						'lzc_cli.lib.app.lpk_create_generator.template_config_springboot_green',
+						`
+🛠 Open the app first.
+   If the backend dev service is not ready yet, the app page will tell you how to sync or copy code and how to start the service.
+Recommended backend dev loop:
+   lzc-cli project sync --watch
+   lzc-cli project exec /bin/sh
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   `,
+					).trim(),
+				),
+			);
+		},
+	},
+	'todolist-python': {
+		build: async (to, option) => {
+			await generate('python', to, option);
+		},
+		after: async function (name) {
+			appCreateSuccessTipByCommands(name);
+			console.log(
+				chalk.green(
+					t(
+						'lzc_cli.lib.app.lpk_create_generator.template_config_python_green',
+						`
+🛠 Open the app first.
+   If the backend dev service is not ready yet, the app page will tell you how to sync or copy code and how to start the service.
+Recommended backend dev loop:
+   lzc-cli project sync --watch
+   lzc-cli project exec /bin/sh
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   `,
+					).trim(),
+				),
+			);
+		},
+	},
+	'todolist-golang': {
+		build: async (to, option) => {
+			await generate('golang', to, option);
+		},
+		after: async function (name) {
+			appCreateSuccessTipByCommands(name);
+			console.log(
+				chalk.green(
+					t(
+						'lzc_cli.lib.app.lpk_create_generator.template_config_golang_green',
+						`
+🛠 Open the app first.
+   If the backend dev service is not ready yet, the app page will tell you how to sync or copy code and how to start the service.
+Recommended backend dev loop:
+   lzc-cli project sync --watch
+   lzc-cli project exec /bin/sh
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
+						`,
+					).trim(),
+				),
+			);
+		},
+	},
+	'gui-vnc': {
+		build: async (to, option) => {
+			await generate('gui-vnc', to, option);
+		},
+		after: async function (name) {
+			appCreateSuccessTipByCommands(name);
+			console.log(
+				chalk.green(
+					t(
+						'lzc_cli.lib.app.lpk_create_generator.template_config_gui_vnc_green',
+						`
+🛠 GUI VNC app (embedded image template):
+   lzc-cli project deploy
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   lzc-cli project exec -s desktop /bin/sh
+   `,
+					).trim(),
+				),
+			);
+		},
+	},
+	'todolist-serverless': {
+		build: async (to, option) => {
+			await generate('vue-minidb', to, option);
+		},
+		after: async function (name) {
+			appCreateSuccessTipByCommands(name);
+			console.log(
+				chalk.green(
+					t(
+						'lzc_cli.lib.app.lpk_create_generator.template_config_vue_minidb_green',
+						`
+🛠 Open the app first.
+   If the frontend dev server is not running yet, the app page will show the expected port and next step.
+Then start local frontend dev:
+   npm run dev
+   The command output prints the active Build config.
+🔎 For troubleshooting:
+   lzc-cli project log -f
    `,
 					).trim(),
 				),

package/lib/app/lpk_devshell.js

@@ -30,6 +30,7 @@ import { DebugBridge } from '../debug_bridge.js';
 import shellApi from '../shellapi.js';
 import { t } from '../i18n/index.js';
 import { collectContextFromDockerFile } from './lpk_devshell_docker.js';
+import { resolveBuildRemoteFromOptions } from '../build_remote.js';
 
 // 判断是否需要重新构建
 // - 先判断 lzc-build.yml 是否发生改变
@@ -44,6 +45,7 @@ class AppDevShellMonitor {
 
 		this.optionsFilePath = path.join(this.pwd, buildConfigFile);
 		this.options = loadFromYaml(this.optionsFilePath);
+		this.buildRemote = resolveBuildRemoteFromOptions(this.options, `file:${this.optionsFilePath}`);
 
 		this.manifestFilePath = this.options['manifest'] ? path.join(this.pwd, this.options['manifest']) : path.join(this.pwd, 'lzc-manifest.yml');
 
@@ -54,7 +56,7 @@ class AppDevShellMonitor {
 		this.cacheFilePath = undefined;
 		this.oldHash = undefined;
 		this.newHash = undefined;
-		this.bridge = new DebugBridge();
+		this.bridge = new DebugBridge(this.pwd, this.buildRemote);
 	}
 
 	async init() {
@@ -101,6 +103,7 @@ export class AppDevShell {
 		this.buildConfigFile = buildConfigFile;
 		this.isUserApp = false;
 		this.monitor = undefined;
+		this.buildRemote = resolveBuildRemoteFromOptions(this.lpkBuild.options, `file:${this.lpkBuild.optionsFilePath}`);
 	}
 
 	async init() {
@@ -225,7 +228,6 @@ export class AppDevShell {
 		// 避免应用永远处于 unhealth 导致状态卡在 starting
 		this.lpkBuild.onBeforeDumpYaml(async (manifest, options) => {
 			logger.debug('merge lzc-build.yml devshell services\n', options);
-			const userapp = this.isUserApp ? shellApi.uid + '.' : '';
 			const devshell = {
 				application: {
 					devshell: options['devshell'],
@@ -263,7 +265,7 @@ export class AppDevShell {
 				logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_image_for_box_tips', `开始在盒子中构建 {{ label }} 镜像 from {{ tempDir }}`, { label, tempDir, interpolation: { escapeValue: false } }));
 
 				const contextTar = await collectContextFromDockerFile(tempDir, path.resolve(tempDir, 'Dockerfile'));
-				const bridge = new DebugBridge();
+				const bridge = new DebugBridge(this.cwd, this.buildRemote);
 				await bridge.init();
 				const tag = await bridge.buildImage(label, contextTar);
 				delete manifest['application']['devshell'];
@@ -291,7 +293,7 @@ export class AppDevShell {
 
 			const contextTar = await collectContextFromDockerFile(process.cwd(), path.resolve(process.cwd(), config['build'], 'Dockerfile'));
 
-			const bridge = new DebugBridge();
+			const bridge = new DebugBridge(this.cwd, this.buildRemote);
 			await bridge.init();
 			const tag = await bridge.buildImage(label, contextTar);
 			delete manifest['application']['devshell'];
@@ -323,15 +325,9 @@ export class AppDevShell {
 			return manifest;
 		});
 
-		// devshell 模式下，默认打开后台常驻
-		this.lpkBuild.onBeforeDumpYaml(async (manifest) => {
-			manifest['application']['background_task'] = true;
-			return manifest;
-		});
-
-		// 添加一个 devshell 的标记在 lpk 中，标记当前 lpk 为一个 debug 版本
-		this.lpkBuild.onBeforeDumpLpk(async (options, cwd, destDir) => {
-			fs.writeFileSync(path.resolve(destDir, 'devshell'), '');
+			// 添加一个 devshell 的标记在 lpk 中，标记当前 lpk 为一个 debug 版本
+			this.lpkBuild.onBeforeDumpLpk(async (options, cwd, destDir) => {
+				fs.writeFileSync(path.resolve(destDir, 'devshell'), '');
 		});
 
 		// 在构建生成 lpk 包后，调用 deploy 进行部署
@@ -343,7 +339,7 @@ export class AppDevShell {
 	async rsyncShell() {
 		const manifest = await this.lpkBuild.getManifest();
 		const pkgId = manifest['package'];
-		const devshell = new DevShell(pkgId, this.isUserApp);
+		const devshell = new DevShell(pkgId, this.isUserApp, this.cwd, this.buildRemote);
 		try {
 			await devshell.shell();
 		} catch (e) {
@@ -357,16 +353,34 @@ export class AppDevShell {
 }
 
 class DevShell {
-	constructor(appId, isUserApp) {
+	constructor(appId, isUserApp, cwd = process.cwd(), buildRemote = null) {
 		this.appId = appId;
 		this.isUserApp = isUserApp;
+		this.cwd = cwd;
+		this.buildRemote = buildRemote;
+		this.syncUID = '';
+	}
+
+	async resolveUID() {
+		if (!this.buildRemote) {
+			return shellApi.uid;
+		}
+		if (this.syncUID) {
+			return this.syncUID;
+		}
+		const bridge = new DebugBridge(this.cwd, this.buildRemote);
+		await bridge.init();
+		this.syncUID = await bridge.resolveCurrentUID();
+		return this.syncUID;
 	}
 
 	async syncProject(appId) {
-		const resolvedIp = await resolveDomain(`dev.${shellApi.boxname}.heiyu.space`);
+		const uid = await this.resolveUID();
+		const resolvedIp = this.buildRemote ? this.buildRemote.sshHost : await resolveDomain(`dev.${shellApi.boxname}.heiyu.space`);
 		const rsyncDebug = isDebugMode() ? '-P' : '';
-		const destDir = `${appId}${this.isUserApp ? '/' + shellApi.uid : ''}`;
-		const dest = `rsync://${shellApi.uid}@[${resolvedIp}]:874/lzcapp_cache/${destDir}/devshell`;
+		const destDir = `${appId}${this.isUserApp ? '/' + uid : ''}`;
+		const rsyncHost = resolvedIp.includes(':') ? `[${resolvedIp}]` : resolvedIp;
+		const dest = `rsync://${uid}@${rsyncHost}:874/lzcapp_cache/${destDir}/devshell`;
 		const rsyncCmd = isWindows ? path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'win-rsync', 'rsync.exe') : `rsync`;
 
 		try {
@@ -454,7 +468,7 @@ class DevShell {
 	}
 
 	async connectShell(onconnect = null) {
-		const bridge = new DebugBridge();
+		const bridge = new DebugBridge(this.cwd, this.buildRemote);
 		await bridge.init();
 		await bridge.devshell(this.appId, this.isUserApp, onconnect);
 	}