fx-front-utils

繁星前端工具类库

负责人：jiangjunjie（打包，发布等）

1. 使用原则

• 项目里重复使用的函数，TS类型等都可以放到此项目里
• 鼓励所有人对此组件库做出贡献

2. 文件夹介绍

• src：主要源码
• docs：vitePress 文档文件夹

3. 安装过程

1. 全局安装pnpm：npm install -g pnpm
2. 执行pnpm i --force

• 安装时遇到大量包请求报错，请先查看 .npmrc 文件中是否配置了「代理」，如果是，则先将代理配置为本机代理 或 注释掉代理配置，再执行安装；
• 安装过程慢的话，可以自己设置不同的npm registry或者修改.npmrc文件中的代理地址；
• 如安装后报错「sh: vite: command not found」，则可能是依赖未装全，建议切换到 npm 官方源，配置翻墙代理后，再进行安装；

4. 使用说明

新建文档（Doc）步骤

1. 在docs/目录下新建*.md文件

调试过程

1. 编写好对应的文档后，执行pnpm pnpm docs:dev 命令
2. 打开对应的文档地址，查看效果

打包发布过程

1. 升级版本：package.json 中的版本号
2. 执行 pnpm build 命令
3. 设置相应的 NPM Registry 地址（默认地址为公司的私有仓库）
4. 执行 pnpm pub 命令

构建帮助文档过程

1. 执行 pnpm docs:build 命令
2. 执行 pnpm docs:publish 命令，将文件上传到服务器