3.0.4 • Published 3 years ago
@ilime/util v3.0.4
lime-util 前端模块化 JavaScript 工具库
🔥 lime-util 🔥 是一个 前端模块化 JavaScript 工具库,目前共有 200+ ⚡️ 个 Api 方法,包含了开发中经常用到的一些模块方法集合,如字符串
,数组
,浏览器缓存
,日期工具库
,数学计算
,文件处理
,正则校验
和微信小程序工具库
等等。
📦 安装
1. 使用 npm 安装
npm i @lime-util/util --save
2. 或在浏览器中直接使用
<!-- 将工具包下面 dist/index.js 文件拷贝出来用 -->
<script src="dist/index.js"></script>
<!-- 使用 -->
<script>
console.log(LimeUtil.loadedTest()); // 输出:lime-util loaded successfully!
</script>
🔨 构建
工具库架构使用 pnpm
做为包管理工具,通过 packages
分包为多个工程模块来构建。如果需要 fork 二次开发,需要本地安装 pnpm
,并且在 packages
根目录下面加入新的模块目录。
# 构建 整合模块 以及 各个子模块 的dist包
pnpm build
🎨 使用
1. es6 方式
// 全部引入
import LimeUtil from "@lime-util/util";
LimeUtil.loadedTest(); // 输出:lime-util loaded successfully!
// 按需引入
import { loadedTest } from "@lime-util/util";
loadedTest(); // 输出:lime-util loaded successfully!
2. require 方式
// 全部引入
const LimeUtil = require("@lime-util/util");
LimeUtil.loadedTest(); // 输出:lime-util loaded successfully!
// 按需引入
const { loadedTest } = require("@lime-util/util");
loadedTest(); // 输出:lime-util loaded successfully!
📚 模块分包
lime-util
是包含所有 API 功能的整合版,如果你只想用日期工具
或者微信小程序工具
,可以单独安装对应的包使用。目前独立的包分为:lime-core
,lime-date
,lime-weapp
。
📝API 文档
🔖Git 提交规范
😝 主要
fix
: 修复 bugadd
: 增加功能del
: 删除功能update
: 更新功能
😉 次要
docs
: 文档更新style
: 颜色、字体大小等变动(不影响代码运行)build
: 构造工具或相关依赖变更refactor
: 代码重构revert
: 撤销,版本回退
😳 一般
test
: 添加或修改测试perf
: 提高性能的改动chore
: 构建过程或辅助工具的变更ci
: CI 配置,脚本文件等改动
# <type>后面英文冒号,并且后跟一个空格
git commit -m <type>(<scope>): <description>
# 举个栗子
git commit -m 'fix: 修复了xxx问题'
git commit -m 'fix(string): 修复了字符串模块的xxx问题'
git commit -m 'docs: 更新了字符串模块文档'