cat-tools

简介

根据公司项目需求,将常用方法抽离出来,便于后续的方法的统一拓展。

如今脱离公司了,这个方法包却可以一直使用,目前支持vue2项目,理论上vue3和react的项目中也可以使用,不过我这里没做测试,后续时间充裕的时候我会自己测试一下的。

详情参考线上文档,如果您有兴趣,可以到我的仓库,一起修改这个工具方法包。

目的

聚合常用的前端工具方法,解决平日里使用过程中,多个项目不同人写的不同方法,导致判断逻辑混乱,代码阅读麻烦的问题。

使用

npm i cat-tools -s -d

vue2

在vue2项目中,我们在main.js文件中全局引入,然后挂在到vue.prototype上,之后就可以在this全局调用。

// 这样的写法可以使二者方法
import { catTools as devTools } from 'cat-tools' 
Vue.prototype.$devTools = Object.assign(devTools)

之后在项目中就可以全局引用了,这里我们以判空一个值为例子举例。

const test = "123"
const state = !this.$devTools.isNullorUndefined(test)
console.log(state) 
// 输出结果:false

使用

# 引入工具
npm i cat-tools -s-d

挂载到vue原型链上,这里以vue项目做例子,写在main.js中

import { catTools as devTools } from 'cat-tools'
Vue.prototype.$devTools = devTools

开发

针对于该工具包的开发者体用,

# 克隆项目
git clone https://github.com/CrazyStudent13/cat-tools.git

# 进入项目目录
cd cat-tools

# 安装依赖
npm install

发布

# 生成文档
npm run doc

# 打包
npm run build

参考

JS 工具库文档化 - JSDoc

jsdoc主题:minami