@lcsoft/utils/README.md

龙创前端团队工具方法库

# 龙创前端团队PC端工具方法库

> 工具方法或封装的类

<img src="https://i.imgur.com/Bzpx586.png">

## 使用方式(以`formatDate`方法做示例)

1. 安装组件库`npm i @lcsoft/utils`

2. 引入需要的方法或类

    `import { formatDate } from '@lcsoft/utils'`

3. 参照每个方法或类的说明文档合理使用

    `var today = formatDate(Date.now(), yyyy-MM-dd)`

## 发布新方法或类

1. 在`lib`目录下建一个以方法名或类名命名的`js`文件(方法名使用`小驼峰`,类名使用`大驼峰`)

2. 在`lib`目录下的`index.js`统一导出你的方法或类,并添加简答的说明和作者以明确作用和责任
    ```js
    import formatDate from './formatDate' // 时间格式化-郑

    export {
        formatDate
    }
    ```
3. 在`package.json`中修改版本号。

    `"version": "x.y.z"`

4. 运行`npm publish --access=public` 发布

    > 发布之前请先将自己的库更新到最新版本

## 版本维护

如果npm发布新版本，各位小伙伴的注册邮箱应该会收到通知，请及时在自己的项目中执行`npm update` 或 `npm i @lcsoft/utils`更新依赖，保持团队依赖同步

## 使用技巧

如果你不放心自己添加的方法或类是否正确可用，你完全可以先进入自己项目的`node_modules`目录下，找到`@lcsoft`目录,在那里面修改或者添加，如果你在运行自己的项目时
完全OK，那么放心的`npm publish`吧。

<img src="https://i.imgur.com/CtWUeau.png" width="300">