jlb-tools
Version:
85 lines (58 loc) • 2.91 kB
Markdown
<div align="center">
<img src="https://images2.bestjlb.com/jlboss957712e1852c8020a567831f671123a515421668652141068.png">
</div>
[](https://travis-ci.com/Pasoul/jtools)
[](https://coveralls.io/github/Pasoul/jtools?branch=master)
[](https://opensource.org/licenses/mit-license.php)
[](https://www.npmjs.com/package/jib-tools)
### Description:
前端 js 工具库: 封装常用的工具函数，如日期格式化、浏览器判断等，提高开发效率
[Document](https://pasoul.github.io/jtools/api-docs/)
## Todo
- [x] 引入代码校验工具 eslint
- [x] jsdocs 自动化生成 api 文档
- [x] 测试覆盖率统计 coverage
- [x] 按需加载
- [x] 支持浏览器环境，node 环境、es6 环境
- [ ] Typescript
### 如何使用:
1. 直接下载 `dist` 目录下的 `jtools.min.js` 使用，支持 UMD 通用模块规范
2. 使用 npm 安装
#### 浏览器：
```js
<script src="jtools.min.js"></script>
<script>
var result = jtools.add(1, 2)
</script>
```
#### npm:
`npm i jlb-tools`
##### 全部加载（webpack、RequireJS、SeaJS 等）：
```js
var jtools = require("jlb-tools");
var result = jtools.add(1, 2);
```
#### es6
```js
import jtools from "jlb-tools";
var result = jtools.add(1, 2);
```
### 按需加载
结合[babel-plugin-import-load](https://github.com/Pasoul/babel-plugin-import-load)按需加载可以极大的减小依赖包的体积
```js
import { add } from "jlb-tools";
var result = add(1, 2);
```
#### 自动化生成文档
[JSDoc](http://www.css88.com/doc/jsdoc/about-configuring-jsdoc.html)是一个根据 javascript 文件中注释信息，生成 JavaScript 应用程序或库、模块的 API 文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。类似 JavaDoc 和 PHPDoc。现在很多编辑器或 IDE 中还可以通过 JSDoc 直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。
`yarn run doc`
### 扩展
如果你想添加自己的工具库，在 `src` 目录创建文件，对应 `test` 目录添加测试用例，执行 `yarn test`
### 贡献方法
- fork 本仓库到自己账户。
- 新建一个分支来开始您的工作，分支的名字为 `feature_功能名称` 或者 `buxfix_issueId`。
- 完成功能后请在 test 目录添加完整测试。
- 完成后，发送一个 pull request 到 Pasoul/jtools。
- 等待核心开发者做 CodeReview。
- 最后，恭喜你贡献成功。