@lazycatcloud/lzc-cli 1.2.54 → 1.2.56

package/changelog.md

@@ -1,3 +1,16 @@
+# 1.2.56
+
+1. 修复没有写权限的lpk文件，不能通过 lzc-cli app install 安装
+
+# 1.2.55
+
+1. 添加 lzc-docker 命令
+2. 添加 lzc-docker-compose 命令
+3. 添加 deploy_params 打包支持
+4. 添加 lzc-cli 版本检测
+5. 修复 lzc-cli zsh/bash 补全错误
+6. 隐藏 triggerApk 错误
+
 # 1.2.54
 
 1. 添加 lzc-cli docker 命令

package/lib/app/apkshell.js

@@ -29,6 +29,6 @@ export async function triggerApk(id, name, iconPath) {
       throw `请求生成应用出错! 使用 --apk=n 停止生成APK`
     }
   } catch (error) {
-    logger.error(error)
+    logger.debug(error)
   }
 }

package/lib/app/lpk_build.js

@@ -76,6 +76,33 @@ async function fetchIconTo(options, cwd, destDir) {
   return
 }
 
+async function fetchLzcDeployParamTo(options, cwd, destDir) {
+  let deployParamsPath = options["deploy_params"]
+  if (!deployParamsPath) {
+    logger.debug("deploy_params 没有指定")
+    let cwdDeployParamsPath = path.join(cwd, "lzc-deploy-params.yml")
+    if (isFileExist(cwdDeployParamsPath)) {
+      deployParamsPath = cwdDeployParamsPath
+      logger.debug("检测当前目录下具有 lzc-deploy-params.yml")
+    }
+  }
+  if (!deployParamsPath) {
+    return
+  }
+
+  if (!path.isAbsolute(deployParamsPath)) {
+    deployParamsPath = path.resolve(cwd, deployParamsPath)
+  }
+
+  if (!isFileExist(deployParamsPath)) {
+    logger.warn(`deploy_params ${deployParamsPath} 不存在`)
+    return
+  }
+
+  fs.copyFileSync(deployParamsPath, path.join(destDir, "deploy_params.yml"))
+  return
+}
+
 // 提供一些方便的环境变量，可以在 lzc-build.yml 中直接使用
 // - LocalIP 本地局域网ip
 function localIp() {
@@ -137,7 +164,7 @@ export class LpkBuild {
     this.beforeBuildPackageFn = []
     this.beforeDumpYamlFn = []
     this.beforeTarContentFn = []
-    this.beforeDumpLpkFn = [fetchIconTo]
+    this.beforeDumpLpkFn = [fetchIconTo, fetchLzcDeployParamTo]
   }
 
   // init 时替换 lzc-build.yml 中的模板字段

package/lib/docker/index.js

@@ -4,43 +4,52 @@ import { isFileExist, isUserApp, loadFromYaml } from "../utils.js"
 import logger from "loglevel"
 import path from "node:path"
 
-export function lzcDockerCommand(program) {
-  program
-    .parserConfiguration({
-      "unknown-options-as-args": true
-    })
-    .middleware((argv, yargs) => {
-      argv.dockerArgs = []
-      // 找到 'docker-compose' 或者 ’docker’ 在参数中的位置
-      let index = argv._.indexOf("docker-compose")
-      if (index === -1) {
-        index = argv._.indexOf("docker")
-      }
+function dockerMiddleware(argv, yargs) {
+  if (argv.$0 == "lzc-docker" || argv.$0 == "lzc-docker-compose") {
+    argv.dockerArgs = argv._
+    return
+  }
 
-      if (index !== -1 && index < argv._.length - 1) {
-        // 获取原始的命令行参数
-        const originalArgs = argv._
+  argv.dockerArgs = []
+  // 找到 'docker-compose' 或者 ’docker’ 在参数中的位置
+  let index = argv._.indexOf("docker-compose")
+  if (index === -1) {
+    index = argv._.indexOf("docker")
+  }
 
-        // 将 'docker-compose' 或者 ’docker’ 之后的所有参数（包括选项）移到 dockerArgs 数组中
-        argv.dockerArgs = originalArgs.slice(index + 1)
+  if (index !== -1 && index < argv._.length - 1) {
+    // 获取原始的命令行参数
+    const originalArgs = argv._
 
-        // 从原始参数中移除这些参数
-        argv._ = argv._.slice(0, index + 1)
+    // 将 'docker-compose' 或者 ’docker’ 之后的所有参数（包括选项）移到 dockerArgs 数组中
+    argv.dockerArgs = originalArgs.slice(index + 1)
 
-        // 移除已经被处理的参数
-        for (const arg of argv.dockerArgs) {
-          delete argv[arg]
-        }
-      }
-      return argv
+    // 从原始参数中移除这些参数
+    argv._ = argv._.slice(0, index + 1)
+
+    // 移除已经被处理的参数
+    for (const arg of argv.dockerArgs) {
+      delete argv[arg]
+    }
+  }
+  return argv
+}
+
+function builder(args) {
+  // 禁用严格模式，允许未知参数
+  return args
+    .parserConfiguration({
+      "unknown-options-as-args": true
     })
+    .middleware(dockerMiddleware)
+    .strict(false)
+}
 
-  program.command({
-    command: "docker",
+export function singleLzcDockerCommand(commandName = "docker") {
+  return {
+    command: commandName,
     desc: "微服应用 docker 管理",
-    builder: (args) => {
-      return args.strict(false) // 禁用严格模式，允许未知参数
-    },
+    builder: builder,
     handler: async (args) => {
       logger.debug("args: ", args)
       await shellApi.init()
@@ -49,13 +58,14 @@ export function lzcDockerCommand(program) {
       logger.debug("docker", args.dockerArgs)
       await bridge.lzcDocker(args.dockerArgs)
     }
-  })
-  program.command({
-    command: "docker-compose",
+  }
+}
+
+export function singleLzcDockerComposeCommand(commandName = "docker-compose") {
+  return {
+    command: commandName,
     desc: "微服应用 docker-compose 管理",
-    builder: (args) => {
-      return args.strict(false) // 禁用严格模式，允许未知参数
-    },
+    builder: builder,
     handler: async (args) => {
       logger.debug("args: ", args)
       await shellApi.init()
@@ -86,5 +96,10 @@ export function lzcDockerCommand(program) {
       logger.debug("docker-compose", options.join(" "))
       await bridge.lzcDockerCompose(options)
     }
-  })
+  }
+}
+
+export function lzcDockerCommand(program) {
+  program.command(singleLzcDockerCommand())
+  program.command(singleLzcDockerComposeCommand())
 }

package/lib/log.js

@@ -0,0 +1,47 @@
+import chalk from "chalk"
+import logger from "loglevel"
+
+export function initLogger() {
+  // logger level middleware
+  const logLevelOriginalFactory = logger.methodFactory
+  logger.methodFactory = function (methodName, logLevel, loggerName) {
+    let debug = logLevel <= logger.levels.DEBUG
+    let rawMethod = logLevelOriginalFactory(methodName, logLevel, loggerName)
+    return function (...args) {
+      let color = (msg) => chalk.gray
+      switch (methodName) {
+        case "trace":
+          color = chalk.dim.cyan
+          break
+        case "debug":
+          color = chalk.blue
+          break
+        case "info":
+          color = chalk.green
+          break
+        case "warn":
+          color = chalk.magenta
+          break
+        case "error":
+          color = chalk.bold.red
+          break
+      }
+      const prefix = loggerName ?? methodName
+      rawMethod(
+        (debug ? `[${prefix}] ` : "") +
+          args
+            .map((a) => {
+              let res = a
+              if (typeof a == "object") {
+                res = JSON.stringify(a, undefined, 4)
+              }
+              return color(res)
+            })
+            .join(" ")
+      )
+    }
+  }
+  logger.setDefaultLevel("info")
+}
+
+initLogger()

package/lib/utils.js

@@ -19,6 +19,7 @@ import dns from "node:dns/promises"
 import axios from "axios"
 import AdmZip from "adm-zip"
 import commandExists from "command-exists"
+import fetch from "node-fetch"
 
 // lzc-cli 包的 pkgInfo 信息
 export const pkgInfo = JSON.parse(
@@ -27,6 +28,27 @@ export const pkgInfo = JSON.parse(
   )
 )
 
+export async function getLatestVersion(controller, pkgName = pkgInfo.name) {
+  const url = `https://data.jsdelivr.com/v1/package/npm/${pkgName}`
+  try {
+    logger.debug("check latest lzc-cli version...")
+    const data = await fetch(url, {
+      signal: controller.signal
+    })
+    const content = await data.json()
+    const latestVersion = content["tags"]["latest"]
+    if (latestVersion != pkgInfo.version) {
+      logger.warn(
+        `检测到 ${pkgName} 最新版本为 ${latestVersion}，使用 'npm i -g ${pkgName}@${latestVersion}' 升级到最新版本!`
+      )
+    } else {
+      logger.debug(`已经在最新版本: ${latestVersion}`)
+    }
+  } catch (err) {
+    logger.debug(`请求 ${url} 失败, error: ${err}`)
+  }
+}
+
 // 创建 Axios 实例
 export const api = axios.create()
 
@@ -260,12 +282,10 @@ export function isDirExist(path) {
 
 export function isFileExist(path) {
   try {
-    fs.accessSync(
-      path,
-      fs.constants.W_OK | fs.constants.R_OK | fs.constants.F_OK
-    )
+    fs.accessSync(path, fs.constants.R_OK | fs.constants.F_OK)
     return true
-  } catch {
+  } catch (err) {
+    logger.debug(`access ${path} error: ${err}`)
     return false
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lazycatcloud/lzc-cli",
-  "version": "1.2.54",
+  "version": "1.2.56",
   "description": "lazycat cloud developer kit",
   "scripts": {
     "prepublishOnly": "node check-changelog.js"
@@ -12,7 +12,9 @@
     "changelog.md"
   ],
   "bin": {
-    "lzc-cli": "scripts/cli.js"
+    "lzc-cli": "scripts/cli.js",
+    "lzc-docker": "scripts/lzc-docker.js",
+    "lzc-docker-compose": "scripts/lzc-docker-compose.js"
   },
   "type": "module",
   "keywords": [

package/scripts/cli.js

@@ -5,59 +5,32 @@ import fs from "fs"
 import logger from "loglevel"
 import yargs from "yargs"
 import { hideBin } from "yargs/helpers"
-import chalk from "chalk"
+import "../lib/log.js" // init logger
 
-import { contextDirname, pkgInfo } from "../lib/utils.js"
+import { contextDirname, pkgInfo, getLatestVersion } from "../lib/utils.js"
 import { boxCommand } from "../lib/box/index.js"
 import { appstoreCommand } from "../lib/appstore/index.js"
 import { lpkAppCommand, lpkProjectCommand } from "../lib/app/index.js"
 import { configCommand } from "../lib/config/index.js"
 import { lzcDockerCommand } from "../lib/docker/index.js"
 
-// logger level middleware
-const logLevelOriginalFactory = logger.methodFactory
-logger.methodFactory = function (methodName, logLevel, loggerName) {
-  let debug = logLevel <= logger.levels.DEBUG
-  let rawMethod = logLevelOriginalFactory(methodName, logLevel, loggerName)
-  return function (...args) {
-    let color = (msg) => chalk.gray
-    switch (methodName) {
-      case "trace":
-        color = chalk.dim.cyan
-        break
-      case "debug":
-        color = chalk.blue
-        break
-      case "info":
-        color = chalk.green
-        break
-      case "warn":
-        color = chalk.magenta
-        break
-      case "error":
-        color = chalk.bold.red
-        break
-    }
-    const prefix = loggerName ?? methodName
-    rawMethod(
-      (debug ? `[${prefix}] ` : "") +
-        args
-          .map((a) => {
-            let res = a
-            if (typeof a == "object") {
-              res = JSON.stringify(a, undefined, 4)
-            }
-            return color(res)
-          })
-          .join(" ")
-    )
-  }
-}
-logger.setDefaultLevel("info")
 function setLoggerLevel({ log }) {
   logger.setLevel(log, false)
 }
 
+function checkLatestVersion(controller) {
+  return ({ _: args }) => {
+    if (args.length > 0) {
+      switch (args[0]) {
+        case "project":
+        case "app":
+        case "appstore":
+          getLatestVersion(controller)
+      }
+    }
+  }
+}
+
 const program = yargs(hideBin(process.argv))
   .scriptName("lzc-cli")
   .usage("<command> [options]")
@@ -83,24 +56,30 @@ lzcDockerCommand(program)
 
 // 当没有参数的时候，默认显示帮助。
 ;(async () => {
+  const controller = new AbortController()
+
   const parser = program
     .strict()
     .showHelpOnFail(false, "使用 lzc-cli help 查看更多帮助")
-    .middleware([setLoggerLevel])
+    .middleware([setLoggerLevel, checkLatestVersion(controller)])
     .parse()
 
-  const argv = await parser
-  if (argv._.length == 1) {
-    switch (argv._[0]) {
-      case "box":
-      case "app":
-      case "project":
-      case "appstore":
-      case "config":
-        program.showHelp()
-        return
+  try {
+    const argv = await parser
+    if (argv._.length == 1) {
+      switch (argv._[0]) {
+        case "box":
+        case "app":
+        case "project":
+        case "appstore":
+        case "config":
+          program.showHelp()
+          return
+      }
+    } else if (argv._.length == 0) {
+      program.showHelp()
     }
-  } else if (argv._.length == 0) {
-    program.showHelp()
+  } finally {
+    controller.abort()
   }
 })()

package/scripts/lzc-docker-compose.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+import process from "process"
+import logger from "loglevel"
+import yargs from "yargs"
+import { hideBin } from "yargs/helpers"
+
+import "../lib/log.js"
+import { pkgInfo } from "../lib/utils.js"
+import { singleLzcDockerComposeCommand } from "../lib/docker/index.js"
+
+function setLoggerLevel({ log }) {
+  logger.setLevel(log, false)
+}
+
+const program = yargs(hideBin(process.argv))
+  .scriptName("lzc-docker-compose")
+  .usage("<command> [options]")
+  .version(`lzc-docker-compose ${pkgInfo.version}`)
+  .option("log", {
+    type: "string",
+    default: "info",
+    describe: "log level 'trace', 'debug', 'info', 'warn', 'error'"
+  })
+  .option("help", {
+    alias: "h",
+    type: "boolean",
+    default: false
+  })
+  .command(singleLzcDockerComposeCommand("$0"))
+
+// 当没有参数的时候，默认显示帮助。
+;(async () => {
+  const parser = program
+    .strict(false)
+    .showHelpOnFail(false, "使用 lzc-cli help 查看更多帮助")
+    .middleware([setLoggerLevel])
+    .parse()
+
+  const argv = await parser
+  if (argv._.length == 0) {
+    program.showHelp()
+  }
+})()

package/scripts/lzc-docker.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+import process from "process"
+import logger from "loglevel"
+import yargs from "yargs"
+import { hideBin } from "yargs/helpers"
+
+import "../lib/log.js"
+import { pkgInfo } from "../lib/utils.js"
+import { singleLzcDockerCommand } from "../lib/docker/index.js"
+
+function setLoggerLevel({ log }) {
+  logger.setLevel(log, false)
+}
+
+const program = yargs(hideBin(process.argv))
+  .scriptName("lzc-docker")
+  .usage("<command> [options]")
+  .version(`lzc-docker ${pkgInfo.version}`)
+  .option("log", {
+    type: "string",
+    default: "info",
+    describe: "log level 'trace', 'debug', 'info', 'warn', 'error'"
+  })
+  .option("help", {
+    alias: "h",
+    type: "boolean",
+    default: false
+  })
+  .command(singleLzcDockerCommand("$0"))
+
+// 当没有参数的时候，默认显示帮助。
+;(async () => {
+  const parser = program
+    .strict(false)
+    .showHelpOnFail(false, "使用 lzc-cli help 查看更多帮助")
+    .middleware([setLoggerLevel])
+    .parse()
+
+  const argv = await parser
+  if (argv._.length == 0) {
+    program.showHelp()
+  }
+})()

package/template/_lpk/vue.lzc-build.yml.in

@@ -18,6 +18,9 @@ pkgout: ./
 # icon 仅仅允许 png 后缀的文件
 icon: ./lazycat.png
 
+# deploy_params 指定用户运行时输入的模板字段
+# deploy_params: ./lzc-deploy-params.yml
+
 # devshell 自定义应用的开发容器环境
 # - routers 指定应用容器的访问路由