lime-util 前端模块化 JavaScript 工具库

🔥 lime-util 🔥 是一个前端模块化 JavaScript 工具库，目前共有 248+ ⚡️ 个 Api 方法，包含了开发中经常用到的一些模块方法集合，如字符串，数组，浏览器缓存，浏览器Cookie，Dom处理，日期工具，数学计算，文件处理，正则校验，微信小程序工具库等等。

📦 安装

1. 使用 npm 安装

npm i @lime-util/util --save

2. 或在浏览器中直接引入

<!-- 将工具包下面 dist/index.js 文件拷贝出来引入 -->
<script src="dist/index.js"></script>
<!-- 使用 -->
<script>
  LimeUtil.loadedTest();
</script>

🎨 使用

1. es6 方式

// 全部引入
import LimeUtil from "@lime-util/util";
LimeUtil.loadedTest();

// 按需引入
import { loadedTest } from "@lime-util/util";
loadedTest();

2. require 方式

// 全部引入
const LimeUtil = require("@lime-util/util");
LimeUtil.loadedTest();

// 按需引入
const { loadedTest } = require("@lime-util/util");
loadedTest();

🔨 构建

工具库源码架构使用 pnpm 做为包管理工具，在 packages 目录中分为多个工程模块来构建。

# 构建所有模块的包
pnpm build

# 构建核心模块的包
pnpm build:core

# 构建日期模块的包
pnpm build:date

📚 模块介绍

lime-util 分为lime-util 整合工具库，lime-core 核心工具库 或 lime-date 日期工具库，整合工具库包含所有的功能，如果你想轻量级使用，可以只引入核心库或日期库。

📝API 文档

🔖Git 提交规范

😝 主要

fix: 修复 bug
add: 增加功能
del: 删除功能
update: 更新功能

😉 次要

docs: 文档更新
merge: 合并分支
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): 修复了string工具类的xxx问题'
git commit -m 'docs: 更新了字符串模块文档'

wengfengtong / lime-util Goto Github PK

lime-util's Introduction