清鹏智能公共组件库

本仓库包含了清鹏智能的前端公共组件。

用法

用以下指令在前端项目中引入公共组件库。

$ npm install -S @tsingroc/tsingroc-components

开发

$ git clone [email protected]:web/tsingroc-components.git
$ cd tsingroc-components
$ npm install
$ npm run dev          # 启动文档站点的开发环境，文档站点的源代码位于 docs/
$ npm run lint         # 运行 ESLint 检查代码中的易错点
$ npm run format       # 格式化代码
$ npm run docs:build   # 构建文档站点，产物位于 doc_build/
$ npm run docs:preview # 预览构建完成的文档站点
$ npm run build        # 本地构建组件库

本项目正在逐步迁移到 TypeScript，新代码请使用 TypeScript 编写。在开发环境和文档站点中，请使用 import {...} from "@"; 导入组件库的组件。

编辑器配置

可以安装 ESLint 插件、MDX 插件和 Prettier 插件。VSCode 上可以在侧栏的“扩展”标签中看到工作区推荐的插件。

项目结构

.
├── .vscode/
├── dist/             -- 组件库的构建产物
├── doc_build/        -- 文档站点的构建产物
├── docs/             -- 文档站点的源代码
│   ├── components/   -- 文档站点内部用到的组件
│   ├── examples/     -- 文档站点的组件用法范例
│   ├── plugins/      -- 文档站点的编译期插件
│   ├── public/       -- 文档站点的静态资产
│   ├── theme/        -- 文档站点的主题
│   └── zh/
│       ├── echarts/  -- ECharts 组件的文档
│       └── react/    -- React 组件的文档
├── node_modules/
├── src/              -- 组件库的源代码
├── test/             -- 测试的源代码（暂时无效）
├── .gitignore
├── .gitlab-ci.yml    -- GitLab CI 的配置文件
├── .prettierignore   -- Prettier 需要忽略的文件列表
├── Dockerfile        -- 用于部署文档的 Docker 容器
├── eslint.config.js  -- ESLint 的配置文件
├── package-lock.json
├── package.json
├── README.md
├── rsbuild.config.ts -- Rsbuild 的配置文件，用于构建开发环境
├── rspress.config.ts -- Rspress 的配置文件，用于构建文档站点
├── tsconfig.json
├── tsconfig.lib.json -- 组件库的 TypeScript 配置
└── tsconfig.web.json -- 开发环境和文档站点的 TypeScript 配置

发布

$ git tag v1.x.x         # 将当前提交设置为新版本，注意只能在 main 分支上创建新版本
$ git push origin v1.x.x # 将 tag 推送到 GitLab，CI 会自动构建新版本并发布到 npmjs
$ # 注意，不要修改 package.json 中的版本号！

发布到 npmjs 的 access token 需要在 GitLab 项目设置中设定，而且需要定期更新。