Zerone

命令行接口

Zerone 命令行接口是由 @zeronejs/cli在新窗口打开 包提供的。

npm i -g @zeronejs/cli
1

执行 zerone --help 来获取下列帮助信息：

Usage: zerone <command> [options]

Options:
  -v, --version         Output the current version.
  -h, --help            Output usage information.

Commands:
  new|n [name]          Generate New Zerone application.
  build [options]       ts代码打包为js
  info|i                Display Zerone project details.
  generate|g [options]  Generate a Zerone CRUD element
  api                   Generate Swagger Api
  help [command]        display help for command
1
2
3
4
5
6
7
8
9
10
11
12
13

api

读取 swagger(v3)的文档，生成前端相应的 ts/js 代码

提示

如果您是前端开发者，这将很有帮助。

Usage: zerone api [options]

Generate Swagger Api

Options:
  -d, --delete       删除之前生成的代码.
  -js, --javascript  生成js代码.
  -p, --path <path>  指定 "swagger.config.json "文件夹的路径（相对于当前位置）
  -h, --help         Output usage information.
1
2
3
4
5
6
7
8
9

  • 步骤 1: 你需要在生成 api 的位置添加一个 swagger.config.json 配置文件

    配置示例

    {
    "docsUrl": "http://www.example.com/v3/api-docs",
    "includeTags": [],
    "excludeTags": ["bot-callback-controller"],
    "axiosInstanceUrl": "@/utils/request",
    "prefix": "",
    "vueUseAxios": true,
}
    1
    2
    3
    4
    5
    6
    7
    8

  • 步骤 2: 运行命令

zerone api
1
参数说明
参数说明
docsUrljson 文档地址
includeTags要包含的 tags（不填或空数组表示全部包含）
excludeTags要排除的 tags
axiosInstanceUrlaxios 实例地址 （默认：@/utils/request）
prefix接口要添加的前缀
vueUseAxios同时生成 vueuse 中的 useAxios在新窗口打开 （需要安装@vueuse/integrations）

info

输出当前系统和依赖相关的信息。

在你想要检查你的环境，或者提交 Issue 时候，可以使用该命令。

zerone info
1

new

新建一个 Zerone 项目。

Usage: zerone new|n [options] [name]

Generate New Zerone application.

Options:
  -h, --help  Output usage information.
1
2
3
4
5
6

generate

通常，在开发过程中，我们每创建一个表都需要创建与之相关的 CRUD 接口或服务， 其中充斥着大量的 C / V 操作、创建多个 文件，这其中还有重命名等多个操作，既浪费时间，也不会有技术提升。

并且初级开发者在执行上述操作时，经常因复制或重命名等低级失误导致项目进度卡住。

generate旨在帮助开发者降低重复工作量，帮您在一盏茶的功夫完成工作。并且程序生成的代码命名就是正确的，不会出现低级失误。

generate会读取当前命令行目录下所有*.entity.ts 文件，并生成与之相关的 CRUD，您仅需写一个表结构在新窗口打开。

提示

生成的 Module 类 需要导入到根模块。

Usage: zerone generate|g [options]

Generate a Zerone CRUD element

Options:
  -d, --delete       Delete files generated before this module.
  -p, --path <path>  Specifies the path to the "entities" folder (relative to the command line).
  -h, --help         Output usage information.
1
2
3
4
5
6
7
8

build

会编译打包项目中的 ts 文件，它与tsc的区别在于 可以复制其他文件 如：package.json 等

提示

如果您是库开发者，这将很有帮助。

但在实际开发过程中，您可能不需要它，请使用npm run build。

Usage: zerone build [options]

ts代码打包为js

Options:
  -p, --path <path>  Specify the path of the folder where "tsconfig.json" is located.
  -d, --delete       Delete files specified by "outDir".
  -h, --help         Output usage information.
1
2
3
4
5
6
7
8