@zanyarsun/nx-components NPM

组件库使用

内效前端组件库当前托管在阿里云效的npm仓库中，使用前需要先设置npm源为阿里云效的npm仓库，具体操作如下：

1. 设置npm源

# npm
npm config set registry=https://packages.aliyun.com/6360c19e801ae2503bb93bfd/npm/npm-registry/

2. 安装组件库

# npm
npm install nx-components

3. 直接使用组件库

# npm 
npm i nx-components --registry=https://packages.aliyun.com/6360c19e801ae2503bb93bfd/npm/npm-registry/
# yarn
yarn add nx-components --registry=https://packages.aliyun.com/6360c19e801ae2503bb93bfd/npm/npm-registry/

按照上述步骤引入组件库后，即可在项目中使用组件库中的组件。

# 组件库开发
组件开发的`git` 分支为 `dev`分支，开发完成后合并到 `master`分支，`master`分支为组件库的发布分支，发布组件库时需要在`master`分支上打上对应的版本号的`tag`，组件库的版本号遵循[`semver`规范](https://semver.org/lang/zh-CN/)。

组件库开发只需在`src/components`目录下新建组件文件夹，一个组件的基本结构如下：
``` bash
- components
  - component-name              // 组件文件夹
    - component-name.tsx        // 组件代码主体
    - component-name.stories.ts // 组件的storybook调试与展示说明文档
    - styles.less               // 组件样式文件
    - index.ts                  // 组件导出文件

对于未完成的组件，可以先不在 src/components/index.ts 中导出，使用 yarn dev命令在当前组件的 `storybook 文档中调试开发，待组件开发完成后再导出。