跳到主要内容

快速开始

环境准备

1. Node.js

使用 ICE PKG 开发前需要安装 Node.js,并确保 node 版本是 16.14 或以上。

2. 包管理工具

安装 Node.js 后,默认会包含 npm。在国内使用 npm 安装依赖可能会比较慢。建议使用 cnpm 的国内镜像源进行加速:

$ npm install -g cnpm --registry=https://registry.npmmirror.com
# 验证 cnpm 安装是否成功
$ cnpm -v

除此之外,你还可以使用 pnpmyarn 等其他包管理工具。本文档仍以 npm 作为示例。

初始化

以 React 组件类型为例,通过以下命令,可以快速初始化一个项目:

$ npm init @ice/pkg react-component

选择 React 组件项目类型:

? 请选择项目类型 (Use arrow keys)
❯ React 组件
Node 模块
前端类库
Rax 组件

你还可以通过附加的命令行选项的方式指定你想要的模板和 npm 包名,比如:

$ npm init @ice/pkg react-component --template @ice/template-pkg-react --npmName my-react-component

启动项目

$ cd react-component
$ npm start

现在,访问 http://localhost:4000,即可查看组件 README 文档:

demo-readme

访问 http://localhost:4000/usage,即可预览组件:

component-preview

生成构建产物

$ npm run build

发布产物

  1. package.json 中修改包名

  2. 执行发布命令:

$ npm publish