Description:

前端 js 工具库: 封装常用的工具函数，如日期格式化、浏览器判断等，提高开发效率

Document git仓库

Todo

• 引入代码校验工具 eslint
• jsdocs 自动化生成 api 文档
• 测试覆盖率统计 coverage
• 按需加载
• 支持浏览器环境，node 环境、es6 环境

如何使用:

1. 直接下载 dist 目录下的 nbtools.min.js 使用，支持 UMD 通用模块规范
2. 使用 npm 安装

浏览器：

<script src="nbtools.min.js"></script>
<script>
    var result = nbtools.add(1, 2)
</script>

npm:

npm i @tencent/nb-tools

全部加载（webpack、RequireJS、SeaJS 等）：

var nbtools = require("@tencent/nb-tools");
var result = nbtools.add(1, 2);

es6

import nbtools from "@tencent/nb-tools";
var result = nbtools.add(1, 2);

按需加载

安装

npm install babel-plugin-import-load --save-dev

按需加载可以极大的减小依赖包的体积

// .babelrc
{
	// ...
	"plugins": [
	     ["import-load", {"library": "@tencent/nb-tools"}]
	]
}
// webpack.config.js
module: {
	rules: [
		{
		  	test: /\.js$/,
			loader: 'babel-loader'
		}
	]
}

or

module: {
    rules: [
      {
        test: /\.js$/,
        loader: "babel-loader",
 +       options: {
 +         plugins: [["import-load", { library: "@tencent/nb-tools" }]]
 +       }
      }
    ]
 }

// webpack.config.js module: { rules: [ { test: /.js$/, loader: 'babel-loader' } ] }

```js
import { add } from "@tencent/nb-tools";
var result = add(1, 2);

自动化生成文档

JSDoc是一个根据 javascript 文件中注释信息，生成 JavaScript 应用程序或库、模块的 API 文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。类似 JavaDoc 和 PHPDoc。现在很多编辑器或 IDE 中还可以通过 JSDoc 直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。

npm run doc

扩展

如果你想添加自己的工具库，在 src 目录创建文件，对应 test 目录添加测试用例，执行 npm run test

贡献方法

• 新建一个分支来开始您的工作，分支的名字为 feature/功能名称 或者 buxfix/issueId。
• 完成功能后请在 test 目录添加完整测试。
• 完成后，发送一个 pull request 到 develop。