@hz_org/hz-library

注意事项

node 版本要求：16+

开发须知

所有业务组件以 B 字母开头命名

组件开发

组件开发请前往 /packages 文件夹里创建组件文件夹要求开头字母大写，index.ts 文件用来导出组件。 src 文件夹里存放组件 组件命名要求开头字母大写。并撰写响应组件的 markdown 文档。

文档撰写

在 /docs/examples 文件夹里创建对应名称的组件文件夹。将文档所需的文件存到文件夹里。默认 markdown 名称为 README.md 。

并在 /docs/examples/.vuepress/config.js 文件下配置 sidebar。

打包组件

    pnpm build

本地运行文档

    pnpm docs:dev

本地打包文档

    pnpm docs:build

发布 npm 改变 packjson 版本

    npm publish

代码提交

    #  1.全局代码格式化
    pnpm format
    #  2.eslint全局校验
    pnpm lint
    #  3.代码暂存
    git add .
    #  4.填写代码提交
    pnpm cz