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

package/lib/migrate/index.js

@@ -0,0 +1,52 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import logger from 'loglevel';
+import { LpkBuild } from '../app/lpk_build.js';
+import { dumpToYaml, loadFromYaml } from '../utils.js';
+import { PACKAGE_FILE_NAME, splitManifestAndPackageInfo } from '../package_info.js';
+
+async function migrateHandler({ context, file }) {
+	const cwd = context ? path.resolve(context) : process.cwd();
+	const build = new LpkBuild(cwd, file || 'lzc-build.yml');
+	const manifestPath = build.manifestFilePath;
+	const packageFilePath = build.packageFilePath;
+
+	if (fs.existsSync(packageFilePath)) {
+		logger.info(`package metadata already exists at ${packageFilePath}`);
+		return;
+	}
+
+	let manifest;
+	try {
+		manifest = loadFromYaml(manifestPath) ?? {};
+	} catch {
+		throw new Error(`Cannot auto-migrate templated manifest: ${manifestPath}`);
+	}
+
+	const split = splitManifestAndPackageInfo(manifest);
+	if (Object.keys(split.packageInfo).length === 0) {
+		throw new Error(`No static package fields found in ${manifestPath}`);
+	}
+
+	dumpToYaml(split.packageInfo, packageFilePath);
+	dumpToYaml(split.manifest, manifestPath);
+
+	logger.info(`wrote ${PACKAGE_FILE_NAME}: ${packageFilePath}`);
+	logger.info(`updated manifest: ${manifestPath}`);
+}
+
+export function migrateCommand(program) {
+	program.command({
+		command: 'migrate [context]',
+		desc: 'Migrate manifest package metadata to package.yml',
+		builder: (args) => {
+			args.option('f', {
+				alias: 'file',
+				describe: 'Build config file',
+				type: 'string',
+				default: 'lzc-build.yml',
+			});
+		},
+		handler: migrateHandler,
+	});
+}

package/lib/package_info.js

@@ -0,0 +1,135 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import yaml from 'js-yaml';
+import { fakeLoadManifestText, fakeLoadManifestYml, loadFromYaml } from './utils.js';
+
+export const PACKAGE_FILE_NAME = 'package.yml';
+export const STATIC_PACKAGE_FIELDS = [
+	'package',
+	'version',
+	'name',
+	'description',
+	'author',
+	'license',
+	'homepage',
+	'min_os_version',
+	'unsupported_platforms',
+	'locales',
+];
+
+function hasOwn(obj, key) {
+	return Object.prototype.hasOwnProperty.call(obj ?? {}, key);
+}
+
+function readYamlIfExists(filePath) {
+	if (!filePath || !fs.existsSync(filePath)) {
+		return null;
+	}
+	return yaml.load(fs.readFileSync(filePath, 'utf-8')) ?? {};
+}
+
+function tryLoadManifestText(manifestText) {
+	const text = String(manifestText ?? '');
+	const hasGoTemplate = text.includes('{{') && text.includes('}}');
+	try {
+		return {
+			data: yaml.load(text) ?? {},
+			excp: hasGoTemplate,
+		};
+	} catch {
+		return {
+			data: fakeLoadManifestText(text) ?? {},
+			excp: true,
+		};
+	}
+}
+
+export function loadManifestFile(manifestPath) {
+	try {
+		return loadFromYaml(manifestPath) ?? {};
+	} catch {
+		return fakeLoadManifestYml(manifestPath) ?? {};
+	}
+}
+
+export function loadManifestText(manifestText) {
+	return tryLoadManifestText(manifestText).data;
+}
+
+export function loadPackageFile(packageFilePath) {
+	return readYamlIfExists(packageFilePath);
+}
+
+export function defaultPackageFilePath(manifestPath) {
+	return path.join(path.dirname(manifestPath), PACKAGE_FILE_NAME);
+}
+
+export function findManifestStaticFields(manifest) {
+	return STATIC_PACKAGE_FIELDS.filter((field) => hasOwn(manifest, field));
+}
+
+export function ensureManifestStaticFieldsAbsent(manifest, manifestPath) {
+	const invalidFields = findManifestStaticFields(manifest);
+	if (invalidFields.length === 0) {
+		return;
+	}
+	throw new Error(`Static package fields must be moved from ${manifestPath} to ${PACKAGE_FILE_NAME}: ${invalidFields.join(', ')}`);
+}
+
+export function applyPackageFileToManifest(manifest, packageInfo) {
+	const nextManifest = { ...(manifest ?? {}) };
+	for (const field of STATIC_PACKAGE_FIELDS) {
+		delete nextManifest[field];
+	}
+	if (!packageInfo) {
+		return nextManifest;
+	}
+	for (const field of STATIC_PACKAGE_FIELDS) {
+		if (hasOwn(packageInfo, field)) {
+			nextManifest[field] = packageInfo[field];
+		}
+	}
+	return nextManifest;
+}
+
+export function splitManifestAndPackageInfo(manifest, basePackageInfo = null) {
+	const manifestOnly = { ...(manifest ?? {}) };
+	const packageInfo = { ...(basePackageInfo ?? {}) };
+	for (const field of STATIC_PACKAGE_FIELDS) {
+		if (hasOwn(manifestOnly, field)) {
+			packageInfo[field] = manifestOnly[field];
+			delete manifestOnly[field];
+		}
+	}
+	return {
+		manifest: manifestOnly,
+		packageInfo,
+	};
+}
+
+export function loadEffectiveManifest(manifestPath, options = {}) {
+	const hasInlineManifestText = Object.prototype.hasOwnProperty.call(options, 'manifestText');
+	const loadedManifest = hasInlineManifestText
+		? tryLoadManifestText(options.manifestText)
+		: { data: loadManifestFile(manifestPath), excp: false };
+	const sourceManifest = loadedManifest.data;
+	const packageFilePath = options.packageFilePath || defaultPackageFilePath(manifestPath);
+	const hasPackageFile = fs.existsSync(packageFilePath);
+	const packageInfo = hasPackageFile ? loadPackageFile(packageFilePath) ?? {} : null;
+	if (hasPackageFile && options.strictStaticFields) {
+		ensureManifestStaticFieldsAbsent(sourceManifest, manifestPath);
+	}
+	const manifest = hasPackageFile ? applyPackageFileToManifest(sourceManifest, packageInfo) : sourceManifest;
+	return {
+		manifest,
+		sourceManifest,
+		packageInfo,
+		hasPackageFile,
+		packageFilePath,
+		excpManifest: loadedManifest.excp,
+	};
+}
+
+export function loadEffectiveManifestFromFiles(manifestPath, options = {}) {
+	return loadEffectiveManifest(manifestPath, options);
+}

package/lib/shellapi.js

@@ -23,7 +23,9 @@ function getShellAPIConfigDir() {
 }
 
 class ShellApi {
-	constructor() { }
+	constructor() {
+		this.clientId = '';
+	}
 
 	async init() {
 		// 检查当前 shell 环境上下文是否配置 HTTP_PROXY
@@ -109,6 +111,38 @@ NOTE：在指定环境变量的模式下，有些接口依旧不能访问，为
 		});
 	}
 
+	async queryShellCoreInfo() {
+		if (!this.client) {
+			return {};
+		}
+		return new Promise((resolve, reject) => {
+			this.client.queryShellCoreInfo({}, this.metadata, function (err, response) {
+				if (err) {
+					reject(err);
+					return;
+				}
+				resolve(response);
+			});
+		});
+	}
+
+	async resolveClientId() {
+		const cached = String(this.clientId ?? '').trim();
+		if (cached) {
+			return cached;
+		}
+		if (!this.client) {
+			return '';
+		}
+		const info = await this.queryShellCoreInfo();
+		const clientId = String(info?.id ?? '').trim();
+		if (!clientId) {
+			throw new Error('resolve client id failed: empty shell core id');
+		}
+		this.clientId = clientId;
+		return clientId;
+	}
+
 	async initBoxInfo() {
 		try {
 			const boxes = await this.boxList();

package/lib/sig/core.js

@@ -5,7 +5,7 @@ import crypto from 'node:crypto';
 import archiver from 'archiver';
 import AdmZip from 'adm-zip';
 import * as tar from 'tar';
-import yaml from 'js-yaml';
+import { loadEffectiveManifestFromFiles } from '../package_info.js';
 import { t } from '../i18n/index.js';
 
 function toPosixPath(filePath) {
@@ -118,7 +118,7 @@ function loadManifestInfo(workDir) {
 		return { appid: '', version: '' };
 	}
 	try {
-		const manifest = yaml.load(fs.readFileSync(manifestPath, 'utf-8'));
+		const manifest = loadEffectiveManifestFromFiles(manifestPath).manifest;
 		return {
 			appid: manifest?.package ?? '',
 			version: manifest?.version ? String(manifest.version) : '',

package/lib/utils.js

@@ -182,28 +182,38 @@ export function loadFromYaml(file) {
 }
 
 // lzc-manifest.yml 要支持模板，目前无法直接用yaml库解释，手动读出必要字段
-export function fakeLoadManifestYml(file) {
-	const res = fs.readFileSync(file, 'utf8');
+function fakeLoadManifestCore(text) {
 	let obj = {
 		application: {
 			subdomain: undefined,
 		},
 	};
 
-	res.split('\n').forEach((v) => {
+	const normalizeValue = (value) => {
+		const commentIndex = value.indexOf(' #');
+		if (commentIndex >= 0) {
+			value = value.slice(0, commentIndex);
+		}
+		return value.trim();
+	};
+
+	String(text ?? '').split('\n').forEach((v) => {
 		let line = v.trim();
 		const arr = line.split(':');
 		if (arr.length != 2) {
 			return;
 		}
 		let [key, value] = arr;
-		value = value.trim();
+		value = normalizeValue(value);
 		if (!obj.package && key == 'package') {
 			obj.package = value;
 		}
 		if (!obj.application.subdomain && key == 'subdomain') {
 			obj.application.subdomain = value;
 		}
+		if (!obj.name && key == 'name') {
+			obj.name = value;
+		}
 		if (!obj.version && key == 'version') {
 			obj.version = value;
 		}
@@ -211,6 +221,14 @@ export function fakeLoadManifestYml(file) {
 	return obj;
 }
 
+export function fakeLoadManifestText(text) {
+	return fakeLoadManifestCore(text);
+}
+
+export function fakeLoadManifestYml(file) {
+	return fakeLoadManifestCore(fs.readFileSync(file, 'utf8'));
+}
+
 export function dumpToYaml(template, target) {
 	fs.writeFileSync(
 		target,
@@ -526,16 +544,29 @@ export async function resolveDomain(domain, quiet = false) {
 	}
 }
 
-export function unzipSync(zipPath, destPath, entries = []) {
-	if (!isFileExist(zipPath)) {
-		throw t('lzc_cli.lib.utils.unzip_sync_not_exist_fail', `{{ zipPath }} 找不到该文件`, { zipPath, interpolation: { escapeValue: false } });
+function detectLpkArchiveFormatSync(filePath) {
+	const fd = fs.openSync(filePath, 'r');
+	try {
+		const header = Buffer.alloc(512);
+		const bytesRead = fs.readSync(fd, header, 0, header.length, 0);
+		if (bytesRead >= 4 && header[0] === 0x50 && header[1] === 0x4b && header[2] === 0x03 && header[3] === 0x04) {
+			return 'zip';
+		}
+		if (bytesRead >= 265 && header.subarray(257, 262).toString() === 'ustar') {
+			return 'tar';
+		}
+		throw new Error(`Unsupported LPK archive format: ${filePath}`);
+	} finally {
+		fs.closeSync(fd);
 	}
+}
 
-	// 确保目标目录存在
-	fs.mkdirSync(destPath, { recursive: true });
-	// 创建 zip 实例
-	const zip = new AdmZip(zipPath);
+function normalizeArchiveEntryPath(entryPath) {
+	return String(entryPath ?? '').replace(/^\.\//, '').replace(/\\/g, '/');
+}
 
+function extractZipEntriesSync(zipPath, destPath, entries = []) {
+	const zip = new AdmZip(zipPath);
 	if (entries.length > 0) {
 		entries.forEach((entry) => {
 			try {
@@ -544,10 +575,56 @@ export function unzipSync(zipPath, destPath, entries = []) {
 				logger.debug(t('lzc_cli.lib.utils.unzip_sync_not_exist_file_log', `压缩包中没有找到 {{ entry }} 文件`, { entry, interpolation: { escapeValue: false } }));
 			}
 		});
-	} else {
-		// 同步解压所有文件
-		zip.extractAllTo(destPath, true);
+		return;
+	}
+	zip.extractAllTo(destPath, true);
+}
+
+function extractTarEntriesSync(tarPath, destPath, entries = []) {
+	const wanted = new Set((entries ?? []).map((entry) => normalizeArchiveEntryPath(entry)).filter(Boolean));
+	tar.x({
+		file: tarPath,
+		cwd: destPath,
+		sync: true,
+		filter: (entryPath) => {
+			if (wanted.size === 0) {
+				return true;
+			}
+			const normalized = normalizeArchiveEntryPath(entryPath);
+			return wanted.has(normalized);
+		},
+	});
+
+	if (wanted.size === 0) {
+		return;
+	}
+	for (const entry of wanted) {
+		if (!isFileExist(path.join(destPath, entry))) {
+			logger.debug(t('lzc_cli.lib.utils.unzip_sync_not_exist_file_log', `压缩包中没有找到 {{ entry }} 文件`, { entry, interpolation: { escapeValue: false } }));
+		}
+	}
+}
+
+export function extractLpkSync(lpkPath, destPath, entries = []) {
+	if (!isFileExist(lpkPath)) {
+		throw t('lzc_cli.lib.utils.unzip_sync_not_exist_fail', `{{ zipPath }} 找不到该文件`, { zipPath: lpkPath, interpolation: { escapeValue: false } });
+	}
+
+	fs.mkdirSync(destPath, { recursive: true });
+	const format = detectLpkArchiveFormatSync(lpkPath);
+	if (format === 'zip') {
+		extractZipEntriesSync(lpkPath, destPath, entries);
+		return;
 	}
+	if (format === 'tar') {
+		extractTarEntriesSync(lpkPath, destPath, entries);
+		return;
+	}
+	throw new Error(`Unsupported LPK archive format: ${lpkPath}`);
+}
+
+export function unzipSync(zipPath, destPath, entries = []) {
+	extractLpkSync(zipPath, destPath, entries);
 }
 
 export async function selectSshPublicKey(avaiableKeys) {
@@ -643,7 +720,7 @@ export function checkRsync() {
 			}
 
 			const check = spawn.sync('rsync', ['--version'], {
-				shell: true,
+				shell: false,
 				encoding: 'utf-8',
 				stdio: ['pipe', 'pipe', 'pipe'],
 			});

package/package.json

@@ -1,91 +1,91 @@
 {
-  "name": "@lazycatcloud/lzc-cli",
-  "version": "2.0.0-pre.0",
-  "description": "lazycat cloud developer kit",
-  "scripts": {
-    "release": "release-it patch",
-    "prepublishOnly": "node check-changelog.js",
-    "i18n:parser": "i18next-cli extract -c i18next.config.js --sync-all && prettier -w ./lib/i18n/locales"
-  },
-  "files": [
-    "template",
-    "scripts",
-    "lib",
-    "changelog.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "bin": {
-    "lzc-cli": "scripts/cli.js",
-    "lzc-docker": "scripts/lzc-docker.js",
-    "lzc-docker-compose": "scripts/lzc-docker-compose.js"
-  },
-  "type": "module",
-  "keywords": [
-    "lazycat cloud sdk"
-  ],
-  "author": "zac zeng",
-  "license": "ISC",
-  "dependencies": {
-    "@balena/dockerignore": "^1.0.2",
-    "@grpc/grpc-js": "^1.11.1",
-    "@grpc/proto-loader": "^0.7.13",
-    "@lazycatcloud/sdk": "^0.1.423",
-    "adm-zip": "^0.5.16",
-    "archiver": "^7.0.1",
-    "axios": "^1.7.7",
-    "chalk": "^5.3.0",
-    "chokidar": "^3.6.0",
-    "command-exists": "^1.2.9",
-    "cross-spawn": "^7.0.3",
-    "dockerfile-ast": "^0.6.1",
-    "envsub": "^4.1.0",
-    "fast-glob": "^3.3.2",
-    "form-data": "^4.0.0",
-    "i18next": "^25.7.1",
-    "i18next-fs-backend": "^2.6.1",
-    "ignore": "^5.3.2",
-    "inquirer": "^10.1.8",
-    "isbinaryfile": "^5.0.2",
-    "js-yaml": "^4.1.0",
-    "lodash": "^4.17.23",
-    "lodash.debounce": "^4.0.8",
-    "lodash.merge": "^4.6.2",
-    "lodash.mergewith": "^4.6.2",
-    "loglevel": "^1.9.1",
-    "node-fetch": "^3.3.2",
-    "semver": "^7.6.3",
-    "tar": "^7.4.3",
-    "yargs": "^17.7.2"
-  },
-  "devDependencies": {
-    "@release-it/conventional-changelog": "^10.0.1",
-    "@types/command-exists": "^1.2.3",
-    "i18next-cli": "^1.32.0",
-    "prettier": "^3.3.3",
-    "release-it": "^19.0.4"
-  },
-  "release-it": {
-    "git": {
-      "requireCleanWorkingDir": false,
-      "commitMessage": "chore: release v${version}",
-      "commit": true,
-      "tag": true,
-      "push": false
-    },
-    "npm": {
-      "publish": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": "angular",
-        "infile": "changelog.md"
-      }
-    }
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org",
-    "access": "public"
-  }
+	"name": "@lazycatcloud/lzc-cli",
+	"version": "2.0.0-pre.2",
+	"description": "lazycat cloud developer kit",
+	"scripts": {
+		"release": "release-it patch",
+		"prepublishOnly": "node check-changelog.js",
+		"i18n:parser": "i18next-cli extract -c i18next.config.js --sync-all && prettier -w ./lib/i18n/locales"
+	},
+	"files": [
+		"template",
+		"scripts",
+		"lib",
+		"changelog.md"
+	],
+	"engines": {
+		"node": ">=18"
+	},
+	"bin": {
+		"lzc-cli": "scripts/cli.js",
+		"lzc-docker": "scripts/lzc-docker.js",
+		"lzc-docker-compose": "scripts/lzc-docker-compose.js"
+	},
+	"type": "module",
+	"keywords": [
+		"lazycat cloud sdk"
+	],
+	"author": "zac zeng",
+	"license": "ISC",
+	"dependencies": {
+		"@balena/dockerignore": "^1.0.2",
+		"@grpc/grpc-js": "^1.11.1",
+		"@grpc/proto-loader": "^0.7.13",
+		"@lazycatcloud/sdk": "^0.1.423",
+		"adm-zip": "^0.5.16",
+		"archiver": "^7.0.1",
+		"chalk": "^5.3.0",
+		"chokidar": "^3.6.0",
+		"command-exists": "^1.2.9",
+		"cross-spawn": "^7.0.3",
+		"dockerfile-ast": "^0.6.1",
+		"envsub": "^4.1.0",
+		"fast-glob": "^3.3.2",
+		"form-data": "^4.0.0",
+		"i18next": "^25.7.1",
+		"i18next-fs-backend": "^2.6.1",
+		"ignore": "^5.3.2",
+		"inquirer": "^10.1.8",
+		"isbinaryfile": "^5.0.2",
+		"js-yaml": "^4.1.0",
+		"lodash": "^4.17.23",
+		"lodash.debounce": "^4.0.8",
+		"lodash.merge": "^4.6.2",
+		"lodash.mergewith": "^4.6.2",
+		"loglevel": "^1.9.1",
+		"node-fetch": "^3.3.2",
+		"semver": "^7.6.3",
+		"tar": "^7.4.3",
+		"yargs": "^17.7.2"
+	},
+	"devDependencies": {
+		"@release-it/conventional-changelog": "^10.0.1",
+		"@types/command-exists": "^1.2.3",
+		"i18next-cli": "^1.32.0",
+		"prettier": "^3.3.3",
+		"release-it": "^19.0.4"
+	},
+	"release-it": {
+		"git": {
+			"requireCleanWorkingDir": false,
+			"commitMessage": "chore: release v${version}",
+			"commit": true,
+			"tag": true,
+			"push": false
+		},
+		"npm": {
+			"publish": false
+		},
+		"plugins": {
+			"@release-it/conventional-changelog": {
+				"preset": "angular",
+				"infile": "changelog.md"
+			}
+		}
+	},
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org",
+		"access": "public",
+		"tag": "lpkv2"
+	}
 }

package/scripts/cli.js

@@ -15,6 +15,7 @@ import { lpkAppCommand, lpkProjectCommand } from '../lib/app/index.js';
 import { configCommand } from '../lib/config/index.js';
 import { lzcDockerCommand } from '../lib/docker/index.js';
 import { lpkCommand } from '../lib/lpk/index.js';
+import { migrateCommand } from '../lib/migrate/index.js';
 
 function setLoggerLevel({ log }) {
 	logger.setLevel(log, false);
@@ -66,6 +67,7 @@ lpkProjectCommand(program);
 appstoreCommand(program);
 lzcDockerCommand(program);
 lpkCommand(program);
+migrateCommand(program);
 
 // 当没有参数的时候，默认显示帮助。
 (async () => {