README.md

前端模块化 JavaScript 工具库

🔥 i-utils 🔥 是一个 前端模块化 JavaScript 工具库，目前共有 362 ⚡️ 个 Api 方法，支持esm模块和umd浏览器环境使用 ，工具库包含了开发中经常用到的一些模块方法集合，如字符串，数组，浏览器缓存，浏览器Cookie，浏览器剪切板，Dom处理， 日期工具，加密解密，数学计算，文件处理，正则校验，身份证信息,微信小程序工具 等等。

📦 安装

1. 使用 npm 安装

# npm
npm i @ivujs/i-utils --save

# pnpm
pnpm i @ivujs/i-utils --save

# yarn
yarn add @ivujs/i-utils --save

🎨 使用

1. es 模块化引入方式

// 按需引入
import { loadedTest } from "@ivujs/i-utils";

loadedTest();

// 全部引入
import * as iUtils from "@ivujs/i-utils";

iUtils.loadedTest();

2. umd 浏览器环境引入方式

<!-- 将工具库下面 dist/lib/index.full.umd.js 文件拷贝出来引入 -->
<script src="dist/lib/index.full.umd.js"></script>;
<!-- 这里使用的实际是全局的 window.iUtils 对象 -->
<script>
  iUtils.loadedTest();
</script>;

3. require 服务端环境引入方式

// 全部引入
const iUtils = require("@ivujs/i-utils");
iUtils.loadedTest();

// 按需引入
const { loadedTest } = require("@ivujs/i-utils");
loadedTest();

🔨 构建

工具库源码架构使用 pnpm 做为包管理工具，打包后生成esm和umd可以用的包。

# 构建包
pnpm build

✅ 发布

pnpm publish

📝API 文档

常量集合 Constant

字符串
数字
数组
对象
函数
日期
数学
正则
随机数

文件
颜色
校验
键盘

生成id
加解密算法
脱敏
身份证号码
分页

浏览器 Url
浏览器 Cookie
浏览器 Storage
浏览器 Dom
浏览器 Device
浏览器 Clipboard

微信小程序工具

🔖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: 更新了字符串模块文档'