# npm-package

## 介绍

工具组件库

## 注意事项

如需使用第三方库，推荐使用 webpack 进行打包，放入 lib/中使用

## 软件架构

npm-packages
├── bin - 脚本文件暴露为可直接调用的命令  
│ └── cli.js - 命令入口调用方法判断  
├── build - 构建相关工具库  
 git-automation - git 自动化  
 zip-dist  
 index.js 压缩构建入口  
 template-version-config.json - 项目版本管理模板文件  
 zip.js 压缩模块
├── lib - 第三方库  
├── module - 模块  
├── script - 脚本模块  
 dataInit - 脚本数据配置  
├── tools - 工具  
├── index.js - npm 包初始文件  
├── package.json - npm 包管理配置, 正常无需 npm install 当前项目的依赖
├── webpack.config.js - webpack 配置实现打包第三方库减小体积

## 安装教程

```bash
# 项目安装
npm install
```

## 使用说明

安装依赖后注入脚本：
npm run build:zip 自动构建+压缩文件+更新版本信息  
npm run build:prod 仅构建+更新版本信息  
npm run build:zipInit 不构建更新版本信息  
npm run build: 自动构建压缩文件  
npm run preview 构建后预览项目  
npm run preview:no-build 不构建预览项目

## 参与贡献