@lazycatcloud/lzc-cli 1.3.13 → 2.0.0-pre.0

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, loadFromYaml, ensureDir, ensureDirectoryExists, dumpToYaml, isFileExist, isValidAppId, fakeLoadManifestYml, envsubstr } from '../utils.js';
 import path from 'node:path';
 import { TemplateConfig } from './lpk_create_generator.js';
 import fs from 'node:fs';
@@ -10,10 +10,60 @@ import { t } from '../i18n/index.js';
 
 let fsPromises = fs.promises;
 
+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 LpkManifest {
 	constructor(defaultAppID) {
 		this.pwd = contextDirname(import.meta.url);
 		this.manifest = {};
+		this.manifestText = '';
 		this.defaultAppID = defaultAppID;
 	}
 
@@ -24,7 +74,18 @@ export class LpkManifest {
 
 		if (askInfo) {
 			let answer = await this.askLpkInfo();
-			this.manifest = yaml.load(await envTemplateFile(manifestFilePath, answer));
+			const manifestTemplate = fs.readFileSync(manifestFilePath, 'utf-8');
+			this.manifestText = await envsubstr(manifestTemplate, {
+				options: {
+					envs: Object.entries(answer).map(([key, value]) => ({
+						name: key.replace(/-/g, '_'),
+						value,
+					})),
+					syntax: 'default',
+					protect: false,
+				},
+			});
+			this.manifest = yaml.load(this.manifestText);
 		} else {
 			try {
 				this.manifest = loadFromYaml(manifestFilePath);
@@ -39,6 +100,10 @@ export class LpkManifest {
 		let outputFilePath = path.join(outputDir, 'lzc-manifest.yml');
 		logger.debug(`create file ${outputFilePath}`);
 		ensureDir(outputFilePath);
+		if (this.manifestText) {
+			fs.writeFileSync(outputFilePath, this.manifestText);
+			return;
+		}
 		return dumpToYaml(this.manifest, outputFilePath);
 	}
 
@@ -74,14 +139,12 @@ 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);
 	}
 
 	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`);
@@ -94,28 +157,37 @@ export class TemplateInit {
 	}
 }
 
-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,17 +195,18 @@ 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();
 
-		console.log(chalk.green(t('lzc_cli.lib.app.lpk_create.exec_init_project_tips', `✨ 初始化项目 {{name}}`, { name: this.name })));
+		console.log(chalk.green(t('lzc_cli.lib.app.lpk_create.exec_init_project_tips', `✨ 初始化项目 {{ name }}`, { name: this.name, interpolation: { escapeValue: false } })));
 		const { isExists, renamedFileName } = ensureDirectoryExists(this.appDir, true);
 		if (isExists && renamedFileName) {
 			console.warn(
 				chalk.yellow(
-					t('lzc_cli.lib.app.lpk_create.exec_init_project_name_exist_tips', `! 检测到相同目录,已自动将旧目录重命名为 {{renamedFileName}}`, {
+					t('lzc_cli.lib.app.lpk_create.exec_init_project_name_exist_tips', `! 检测到相同目录,已自动将旧目录重命名为 {{ renamedFileName }}`, {
 						renamedFileName,
+						interpolation: { escapeValue: false }
 					}),
 				),
 			);
@@ -147,7 +220,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

@@ -46,7 +46,7 @@ function writeFileTree(target, files) {
 		if (!fs.existsSync(path.dirname(filePath))) {
 			fs.mkdirSync(path.dirname(filePath), { recursive: true });
 		}
-		logger.debug(t('lzc_cli.lib.app.lpk_create_generator.write_file_tree_create_file', `创建文件 {{filePath}}`, { filePath }));
+		logger.debug(t('lzc_cli.lib.app.lpk_create_generator.write_file_tree_create_file', `创建文件 {{ filePath }}`, { filePath, interpolation: { escapeValue: false } }));
 		fs.writeFileSync(filePath, files[p].content, { mode: files[p].mode });
 	});
 }
@@ -63,33 +63,171 @@ function appCreateSuccessTip(name) {
 				'lzc_cli.lib.app.lpk_create_generator.app_create_success_tip',
 				`
 ✨ 懒猫微服应用已创建成功 !
-✨ 进行下面步骤后即可进入容器开发
-   cd {{name}}
-   lzc-cli project devshell
+✨ 先完成第一次部署，确认手机/PC都可以访问
+   cd {{ name }}
+   npm install
+   lzc-cli project deploy
+   lzc-cli project info
+   `,
+				{
+					name,
+					interpolation: { escapeValue: false }
+				},
+			).trim(),
+		),
+	);
+}
+
+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_common',
+				`
+✨ 懒猫微服应用已创建成功 !
+✨ 先完成第一次部署，确认手机/PC都可以访问
+   cd {{ name }}{{ installBlock }}
+   lzc-cli project deploy
+   lzc-cli project info
    `,
-				{ name },
+				{
+					name,
+					installBlock,
+					interpolation: { escapeValue: false }
+				},
 			).trim(),
 		),
 	);
 }
 
 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
-   npm run dev
-🚀 启动应用:
-   进入微服客户端启动器页面点击应用图标来测试应用
+🛠 修改源码后，重新执行部署即可查看效果:
+   lzc-cli project deploy
+🔎 如果要排查问题:
+   lzc-cli project log -f
+   lzc-cli project exec /bin/sh
+   `,
+					).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',
+						`
+🛠 Spring Boot app starts inside image build/runtime:
+   lzc-cli project deploy
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   lzc-cli project exec /bin/sh
+   `,
+					).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',
+						`
+🛠 Flask app starts in container runtime:
+   lzc-cli project deploy
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   lzc-cli project exec /bin/sh
+   `,
+					).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',
+						`
+🛠 Golang app starts in container runtime:
+   lzc-cli project deploy
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   lzc-cli project exec /bin/sh
+					`,
+					).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
+🔎 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',
+						`
+🛠 This template includes @lazycatcloud/minidb:
+   lzc-cli project deploy
+🔎 For troubleshooting:
+   lzc-cli project log -f
+   lzc-cli project exec /bin/sh
    `,
 					).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'],
@@ -260,10 +262,10 @@ export class AppDevShell {
 				await createTemplateFileCommon(dockerfilePath, path.join(tempDir, 'Dockerfile'), { dependencies: depsStr });
 
 				const label = `${await md5String(depsStr)}:latest`;
-				logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_image_for_box_tips', `开始在盒子中构建 {{label}} 镜像 from {{tempDir}}`, { label, tempDir }));
+				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'];
@@ -287,11 +289,11 @@ export class AppDevShell {
 			}
 
 			const label = `${manifest['package']}-devshell:${manifest['version']}`;
-			logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_label_image_box_tips', `开始在盒子中构建 {{label}} 镜像`, { label }));
+			logger.debug(t('lzc_cli.lib.app.lpk_devshell.devshell_build_label_image_box_tips', `开始在盒子中构建 {{ label }} 镜像`, { label, interpolation: { escapeValue: false } }));
 
 			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);
 	}