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

package/lib/app/lpk_create.js

@@ -1,6 +1,6 @@
 import logger from 'loglevel';
 import inquirer from 'inquirer';
-import { contextDirname, loadFromYaml, ensureDir, ensureDirectoryExists, dumpToYaml, isFileExist, isValidAppId, fakeLoadManifestYml, envsubstr } 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,103 +8,113 @@ import yaml from 'js-yaml';
 import chalk from 'chalk';
 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',
-	},
-];
+function fakeLoadManifestText(text) {
+	let obj = {
+		application: {
+			subdomain: undefined,
+		},
+	};
 
-export function listProjectTemplateValues() {
-	return PROJECT_TEMPLATE_OPTIONS.map((item) => item.value);
+	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;
 }
 
-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(', ')}`);
+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,
+		};
 	}
-	return type;
 }
 
-export class LpkManifest {
-	constructor(defaultAppID) {
+export class LpkTemplateFile {
+	constructor(defaultAppID, outputFileName, fallbackLoader = (text) => yaml.load(text)) {
 		this.pwd = contextDirname(import.meta.url);
-		this.manifest = {};
-		this.manifestText = '';
 		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();
-			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);
-			} 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);
-		if (this.manifestText) {
-			fs.writeFileSync(outputFilePath, this.manifestText);
+		if (this.text) {
+			fs.writeFileSync(outputFilePath, this.text);
 			return;
 		}
-		return dumpToYaml(this.manifest, outputFilePath);
+		return dumpToYaml(this.data, outputFilePath);
 	}
 
 	async askLpkInfo() {
@@ -126,34 +136,99 @@ 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 = normalizeTemplateType(type);
 		this.lpkManifest = new LpkManifest(name);
+		this.lpkPackageFile = new LpkPackageFile(name);
 	}
 
 	async init() {
 		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);
 	}
 }
 

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,28 +54,6 @@ export async function generate(type, to, opts = {}) {
 	writeFileTree(to, files);
 }
 
-function appCreateSuccessTip(name) {
-	console.log(
-		chalk.green(
-			t(
-				'lzc_cli.lib.app.lpk_create_generator.app_create_success_tip',
-				`
-✨ 懒猫微服应用已创建成功 !
-✨ 先完成第一次部署，确认手机/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(
@@ -86,10 +62,13 @@ function appCreateSuccessTipByCommands(name, installCommand = '') {
 				'lzc_cli.lib.app.lpk_create_generator.app_create_success_tip_common',
 				`
 ✨ 懒猫微服应用已创建成功 !
-✨ 先完成第一次部署，确认手机/PC都可以访问
+✨ 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,
@@ -113,11 +92,13 @@ export const TemplateConfig = {
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_vue3_green',
 						`
-🛠 修改源码后，重新执行部署即可查看效果:
-   lzc-cli project deploy
-🔎 如果要排查问题:
+🛠 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
-   lzc-cli project exec /bin/sh
    `,
 					).trim(),
 				),
@@ -135,11 +116,14 @@ export const TemplateConfig = {
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_springboot_green',
 						`
-🛠 Spring Boot app starts inside image build/runtime:
-   lzc-cli project deploy
+🛠 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
-   lzc-cli project exec /bin/sh
    `,
 					).trim(),
 				),
@@ -157,11 +141,14 @@ export const TemplateConfig = {
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_python_green',
 						`
-🛠 Flask app starts in container runtime:
-   lzc-cli project deploy
+🛠 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
-   lzc-cli project exec /bin/sh
    `,
 					).trim(),
 				),
@@ -179,12 +166,15 @@ export const TemplateConfig = {
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_golang_green',
 						`
-🛠 Golang app starts in container runtime:
-   lzc-cli project deploy
+🛠 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
-   lzc-cli project exec /bin/sh
-					`,
+						`,
 					).trim(),
 				),
 			);
@@ -203,6 +193,7 @@ export const TemplateConfig = {
 						`
 🛠 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
@@ -223,11 +214,13 @@ export const TemplateConfig = {
 					t(
 						'lzc_cli.lib.app.lpk_create_generator.template_config_vue_minidb_green',
 						`
-🛠 This template includes @lazycatcloud/minidb:
-   lzc-cli project deploy
+🛠 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
-   lzc-cli project exec /bin/sh
    `,
 					).trim(),
 				),

package/lib/app/lpk_devshell.js

@@ -384,11 +384,15 @@ class DevShell {
 		const rsyncCmd = isWindows ? path.join(contextDirname(import.meta.url), '..', '..', 'template', '_lpk', 'win-rsync', 'rsync.exe') : `rsync`;
 
 		try {
-			const rsyncArgs = [`${rsyncDebug}`, `--recursive`, `--relative`, `--perms`, `--update`, `-F --filter=':- .gitignore'`, `--ignore-errors`, `. ${dest}`];
+			const rsyncArgs = [];
+			if (rsyncDebug) {
+				rsyncArgs.push(rsyncDebug);
+			}
+			rsyncArgs.push('--recursive', '--relative', '--perms', '--update', '-F', '--filter=:- .gitignore', '--ignore-errors', '.', dest);
 			logger.debug(t('lzc_cli.lib.app.lpk_devshell.sync_project_code_tips', '同步代码: '), rsyncCmd, rsyncArgs.join(' '));
 			const rsyncStream = spawn.sync(rsyncCmd, rsyncArgs, {
 				env: { ...process.env, RSYNC_PASSWORD: 'fakefakefake' },
-				shell: true,
+				shell: false,
 				stdio: ['ignore', isDebugMode() ? 'inherit' : 'ignore', 'inherit'],
 			});
 		} catch (err) {

package/lib/app/lpk_installer.js

@@ -1,7 +1,8 @@
 import logger from 'loglevel';
 import fs from 'node:fs';
 import path from 'node:path';
-import { loadFromYaml, Downloader, unzipSync } from '../utils.js';
+import { Downloader, extractLpkSync } from '../utils.js';
+import { loadEffectiveManifestFromFiles } from '../package_info.js';
 import { DebugBridge } from '../debug_bridge.js';
 import shellapi from '../shellapi.js';
 import { t } from '../i18n/index.js';
@@ -95,8 +96,8 @@ export class LpkInstaller {
 		const tempDir = fs.mkdtempSync('.lzc-cli-install');
 		let manifest;
 		try {
-			unzipSync(pkgPath, tempDir, ['manifest.yml', 'icon.png']);
-			manifest = loadFromYaml(path.join(tempDir, 'manifest.yml'));
+			extractLpkSync(pkgPath, tempDir, ['manifest.yml', 'package.yml', 'icon.png']);
+			manifest = loadEffectiveManifestFromFiles(path.join(tempDir, 'manifest.yml')).manifest;
 			if (!manifest['application']['subdomain']) {
 				throw t('lzc_cli.lib.app.lpk_installer.install_from_file_manifest_not_exists_app_subdomain_fail', 'manifest.yml 中的 `application.subdomain` 字段不能为空');
 			}