1. 功能介绍

为方便前端开发者基于 qPaas 平台高效进行二次开发，平台基于主流前沿的技术栈，封装了完备的开发者工具链，覆盖了微组件、微应用的创建、调试、打包、发布全链路。

2. 依赖清单

上述二次开发的功能是集成在下述几个 npm 包中的，每个 npm 包各司其职又有相互依赖的关系，各包的功能说明如下：

组件包	功能说明
@qpaas/create-qpaas	用于初始化前端项目和微组件，内置了类vue-cli的项目模板，以及微组件、微函数模板。 npm create @qpaas/qpaas@latest 创建全新的项目工程 npm run create 在已有项目工程中创建微组件
@qpaas/migrate-qpaas	用于迁移旧版本脚手架工程。
@qpaas/cli-plugin-build	用于打包微应用、微组件，生成描述文件，生成zip包等。该包为 @qpaas/cli-core 的内置依赖，开发者无需关心。
@qpaas/cli-plugin-playground	用于调试微组件，提供模拟器的能力。
@qpaas/cli-core	封装一些繁琐的打包、调试命令，提供微组件打包配置自动生成的能力。（基于@qpaas/cli-plugin-build、 @qpaas/cli-plugin-playground，内部基于 rspack、rsbuild 实现）

开发者仅需关注高频使用的两个：

@qpaas/create-qpaas用来创建全新工程或者在已有工程中创建微组件。
@qpaas/cli-core用来调试、打包、发布前端工程。

3. 功能清单

单看 npm 包可能比较抽象，从功能角度看，一个前端工程的创建到发布整个链路，上述开发工具链主要提供了如下功能，每个功能都提供了对应的细节链接，可以点击跳转到对应章节查看：

类别	功能
创建	创建前端工程
创建	创建微组件
调试	调试微应用
调试	调试微组件
打包	打包前端工程
发布	通过云设施发布
	通过运维平台发布
	无运维平台发布
迁移	迁移之前通过 Lego-CLI 创建的前端工程

4. 注意事项

4.1. 环境要求

nodejs >= 18

4.2. .npmrc 配置

由于上述 npm 包是在私有的，未对公网 npm 仓库发布，所以需要增加对应的配置，配置过程和方法如下：

如果您之前已经配置过私有 npm ，则以下 1~2 步可跳过。否则请从第 1 步开始。

4.2.1. 打开 `.npmrc`

# Mac/Linux系统下执行命令
vi ~/.npmrc

# Windows系统下打开
C:\Users\【你的Windows用户名】\.npmrc

4.2.2. 添加 npm 私服的相关配置（在 `.npmrc` 文件的头部添加）。

always-auth=true
@bricks:registry=https://open-npm.qpaas.com/
@ay:registry=https://open-npm.qpaas.com/
@aytc:registry=https://open-npm.qpaas.com/
@qycloud:registry=https://open-npm.qpaas.com/
@qpaas:registry=https://open-npm.qpaas.com/
@51safety:registry=https://open-npm.qpaas.com/
@formbox:registry=https://open-npm.qpaas.com/
@commonbox:registry=https://open-npm.qpaas.com/
registry=https://registry.npmmirror.com/
host=https://npmmirror.com
disturl=https://npmmirror.com/dist
sass_binary_site=https://cdn.npmmirror.com/binaries/node-sass
phantomjs_cdnurl=https://cdn.npmmirror.com/binaries/phantomjs
sharp_dist_base_url=https://cdn.npmmirror.com/binaries/sharp-libvips/v8.7.4/
canvas_binary_host_mirror=https://cdn.npmmirror.com/binaries/canvas/

unsafe-perm=true

4.2.3. 登录私有 npm 仓库

npm login --registry https://open-npm.qpaas.com
# username: 云设施平台账号 https://www.qpaas.com
# password: 云设施平台密码 https://www.qpaas.com
# email: 个人邮箱

如果没有 https://www.qpaas.com 账号，联系团队负责人添加，或者联系售后开账号。