jinbi-utils 1.0.20 → 1.0.21

package/README.md

@@ -1,190 +1,190 @@
-
-
-
-          
-# jbwy-utils 使用说明
-
-这是一个实用工具库，包含了多个常用的功能模块。以下是各个模块的详细说明：
-
-## 1. Common 模块 (common/index.ts)
-通用函数集合，提供了一些基础工具方法：
-
-### 1.1 判空相关
-```typescript
-import { isEmpty } from 'jbwy-utils/common'
-
-isEmpty('') // 返回 true
-isEmpty(null) // 返回 true
-isEmpty(undefined) // 返回 true
-isEmpty(12323) // 返回 false
-```
-
-### 1.2 环境判断
-```typescript
-import { getDeviceType, getEnvironment, getIsComWx } from 'jbwy-utils/common'
-
-// 获取设备类型
-const deviceInfo = getDeviceType()
-// 返回: { isWxWork, isWeixin, isMobileScreen, isMobileAny }
-
-// 获取运行环境
-const env = getEnvironment()
-// 返回: 'com-wx-mobile' | 'com-wx-pc' | 'wx-mobile' | 'wx-pc' | 'other'
-
-// 判断是否企业微信环境
-const isComWx = getIsComWx()
-```
-
-### 1.3 URL参数处理
-```typescript
-import { getQueryString, getQueryVariable } from 'jbwy-utils/common'
-
-// 获取URL参数
-getQueryString(url, 'key')
-getQueryVariable('key')
-```
-
-## 2. Number 模块 (number/index.ts)
-数字处理相关函数：
-
-```typescript
-import { toThousands, formatFloat, ceil, floor } from 'jbwy-utils/number'
-
-// 千分位格式化
-toThousands(12345) // 返回 '12,345'
-toThousands('12323.12') // 返回 '12,323.12'
-
-// 格式化小数位
-formatFloat('1.2345') // 返回 '1.23'
-formatFloat('1.2345', 3) // 返回 '1.235'
-
-// 向上取整
-ceil('1.234', 2) // 返回 1.24
-
-// 向下取整
-floor('1.234', 2) // 返回 1.23
-```
-
-## 3. String 模块 (string/index.ts)
-字符串处理相关函数：
-
-```typescript
-import { formatPhone, formatPhoneHide, formatBank } from 'jbwy-utils/string'
-
-// 格式化手机号
-formatPhone('18211572781') // 返回 '182 1157 2781'
-formatPhone('18211572781', '-') // 返回 '182-1157-2781'
-
-// 隐藏手机号中间四位
-formatPhoneHide('18211572781') // 返回 '182****2781'
-
-// 格式化银行卡号
-formatBank('6282356862823568123') // 返回 '6282 3568 6282 3568 123'
-```
-
-## 4. Validate 模块 (validate/index.ts)
-提供各种验证函数：
-
-```typescript
-import { isMobile, isEmail, isTelephone, isQQ } from 'jbwy-utils/validate'
-
-// 验证手机号
-isMobile('13800138000') // 返回 true/false
-
-// 验证邮箱
-isEmail('example@email.com') // 返回 true/false
-
-// 验证固定电话
-isTelephone('0755-88888888') // 返回 true/false
-
-// 验证QQ号
-isQQ('10000') // 返回 true/false
-```
-
-## 5. File 模块 (file/index.ts)
-文件处理相关函数：
-
-```typescript
-import { calcFileSize, fileSizeFormat, compressImg } from 'jbwy-utils/file'
-
-// 计算文件大小
-calcFileSize(1024) // 返回 { size: 1, unit: 'KB' }
-
-// 格式化文件大小
-fileSizeFormat('1024', 'KB') // 返回 '1MB'
-
-// 压缩图片
-compressImg(file, scaleCallback, qualityCallback)
-```
-
-## 6. Object 模块 (object/index.ts)
-对象处理相关函数：
-
-```typescript
-import { deepEqual, findNodePath } from 'jbwy-utils/object'
-
-// 深度比较两个对象是否相等
-deepEqual({a: 10}, {a: 10}) // 返回 true
-deepEqual({a: 10}, {a: 10, b: 20}) // 返回 false
-
-// 查找树结构节点路径
-findNodePath(nodeValue, nodeKey, treeArray, childrenKey)
-```
-
-## 7. WeChat Work 模块 (wecom/wecom.ts)
-企业微信相关功能：
-
-```typescript
-import { initWWConfig } from 'jbwy-utils/wecom'
-
-// 初始化企业微信配置
-initWWConfig()
-```
-## 8. middleware 模块 (middleware)
-中间件相关功能：
-### 8.1 requestLogger.middware.ts
-
-日志服务 此插件支持使用了koa的nodejs项目
-注意：（recordLogMiddleWare('project-plan-service')）需要传入项目名，日志文件会根据传入的项目名来 命名前缀
-
-```typescript
-// midway 项目接入方案 configuration.ts
-import { recordLogMiddleWare } from 'jinbi-utils'
-
-export class MainConfiguration {
-  @App('koa')
-  app: koa.Application;
-
-  async onReady() {
-    // 
-    this.app.useMiddleware([recordLogMiddleWare('project-plan-service')]);
-
-  }
-}
-```
-```typescript
-//  只用了koa的nodejs项目接入方案 app.js
-import { recordLogMiddleWare } from 'jinbi-utils'
-
-const app = new Koa();
-app.use(bodyParser());
-app.use(router.routes()).use(router.allowedMethods()).use(recordLogMiddleWare('project-plan-service'));
-```
-
-## 安装和使用
-
-1. 安装依赖：
-```bash
-npm install jbwy-utils
-```
-
-2. 引入使用：
-```typescript
-import { isEmpty } from 'jbwy-utils/common'
-import { formatPhone } from 'jbwy-utils/string'
-// ... 按需引入其他功能
-```
-
-注意：所有模块都支持按需引入，可以只引入需要使用的功能，减少打包体积。
-
+
+
+
+          
+# jbwy-utils 使用说明
+
+这是一个实用工具库，包含了多个常用的功能模块。以下是各个模块的详细说明：
+
+## 1. Common 模块 (common/index.ts)
+通用函数集合，提供了一些基础工具方法：
+
+### 1.1 判空相关
+```typescript
+import { isEmpty } from 'jbwy-utils/common'
+
+isEmpty('') // 返回 true
+isEmpty(null) // 返回 true
+isEmpty(undefined) // 返回 true
+isEmpty(12323) // 返回 false
+```
+
+### 1.2 环境判断
+```typescript
+import { getDeviceType, getEnvironment, getIsComWx } from 'jbwy-utils/common'
+
+// 获取设备类型
+const deviceInfo = getDeviceType()
+// 返回: { isWxWork, isWeixin, isMobileScreen, isMobileAny }
+
+// 获取运行环境
+const env = getEnvironment()
+// 返回: 'com-wx-mobile' | 'com-wx-pc' | 'wx-mobile' | 'wx-pc' | 'other'
+
+// 判断是否企业微信环境
+const isComWx = getIsComWx()
+```
+
+### 1.3 URL参数处理
+```typescript
+import { getQueryString, getQueryVariable } from 'jbwy-utils/common'
+
+// 获取URL参数
+getQueryString(url, 'key')
+getQueryVariable('key')
+```
+
+## 2. Number 模块 (number/index.ts)
+数字处理相关函数：
+
+```typescript
+import { toThousands, formatFloat, ceil, floor } from 'jbwy-utils/number'
+
+// 千分位格式化
+toThousands(12345) // 返回 '12,345'
+toThousands('12323.12') // 返回 '12,323.12'
+
+// 格式化小数位
+formatFloat('1.2345') // 返回 '1.23'
+formatFloat('1.2345', 3) // 返回 '1.235'
+
+// 向上取整
+ceil('1.234', 2) // 返回 1.24
+
+// 向下取整
+floor('1.234', 2) // 返回 1.23
+```
+
+## 3. String 模块 (string/index.ts)
+字符串处理相关函数：
+
+```typescript
+import { formatPhone, formatPhoneHide, formatBank } from 'jbwy-utils/string'
+
+// 格式化手机号
+formatPhone('18211572781') // 返回 '182 1157 2781'
+formatPhone('18211572781', '-') // 返回 '182-1157-2781'
+
+// 隐藏手机号中间四位
+formatPhoneHide('18211572781') // 返回 '182****2781'
+
+// 格式化银行卡号
+formatBank('6282356862823568123') // 返回 '6282 3568 6282 3568 123'
+```
+
+## 4. Validate 模块 (validate/index.ts)
+提供各种验证函数：
+
+```typescript
+import { isMobile, isEmail, isTelephone, isQQ } from 'jbwy-utils/validate'
+
+// 验证手机号
+isMobile('13800138000') // 返回 true/false
+
+// 验证邮箱
+isEmail('example@email.com') // 返回 true/false
+
+// 验证固定电话
+isTelephone('0755-88888888') // 返回 true/false
+
+// 验证QQ号
+isQQ('10000') // 返回 true/false
+```
+
+## 5. File 模块 (file/index.ts)
+文件处理相关函数：
+
+```typescript
+import { calcFileSize, fileSizeFormat, compressImg } from 'jbwy-utils/file'
+
+// 计算文件大小
+calcFileSize(1024) // 返回 { size: 1, unit: 'KB' }
+
+// 格式化文件大小
+fileSizeFormat('1024', 'KB') // 返回 '1MB'
+
+// 压缩图片
+compressImg(file, scaleCallback, qualityCallback)
+```
+
+## 6. Object 模块 (object/index.ts)
+对象处理相关函数：
+
+```typescript
+import { deepEqual, findNodePath } from 'jbwy-utils/object'
+
+// 深度比较两个对象是否相等
+deepEqual({a: 10}, {a: 10}) // 返回 true
+deepEqual({a: 10}, {a: 10, b: 20}) // 返回 false
+
+// 查找树结构节点路径
+findNodePath(nodeValue, nodeKey, treeArray, childrenKey)
+```
+
+## 7. WeChat Work 模块 (wecom/wecom.ts)
+企业微信相关功能：
+
+```typescript
+import { initWWConfig } from 'jbwy-utils/wecom'
+
+// 初始化企业微信配置
+initWWConfig()
+```
+## 8. middleware 模块 (middleware)
+中间件相关功能：
+### 8.1 requestLogger.middware.ts
+
+日志服务 此插件支持使用了koa的nodejs项目
+注意：（recordLogMiddleWare('project-plan-service')）需要传入项目名，日志文件会根据传入的项目名来 命名前缀
+
+```typescript
+// midway 项目接入方案 configuration.ts
+import { recordLogMiddleWare } from 'jinbi-utils'
+
+export class MainConfiguration {
+  @App('koa')
+  app: koa.Application;
+
+  async onReady() {
+    // 
+    this.app.useMiddleware([recordLogMiddleWare('project-plan-service')]);
+
+  }
+}
+```
+```typescript
+//  只用了koa的nodejs项目接入方案 app.js
+import { recordLogMiddleWare } from 'jinbi-utils'
+
+const app = new Koa();
+app.use(bodyParser());
+app.use(router.routes()).use(router.allowedMethods()).use(recordLogMiddleWare('project-plan-service'));
+```
+
+## 安装和使用
+
+1. 安装依赖：
+```bash
+npm install jbwy-utils
+```
+
+2. 引入使用：
+```typescript
+import { isEmpty } from 'jbwy-utils/common'
+import { formatPhone } from 'jbwy-utils/string'
+// ... 按需引入其他功能
+```
+
+注意：所有模块都支持按需引入，可以只引入需要使用的功能，减少打包体积。
+
         

package/RELEASE_GUIDE.md

@@ -0,0 +1,243 @@
+# 📦 发布指南
+
+本文档说明如何使用自动化命令发布新版本。
+
+## 🚀 快速开始
+
+### 一键发布（推荐）
+
+```bash
+# 发布 patch 版本（默认，如 1.0.8 -> 1.0.9）
+npm run release
+
+# 或者明确指定
+npm run release:patch
+```
+
+### 指定版本类型发布
+
+```bash
+# 发布 patch 版本（修复 bug）：1.0.8 -> 1.0.9
+npm run release:patch
+
+# 发布 minor 版本（新功能）：1.0.8 -> 1.1.0
+npm run release:minor
+
+# 发布 major 版本（破坏性更新）：1.0.8 -> 2.0.0
+npm run release:major
+
+# 发布 beta 版本（测试版）：1.0.8 -> 1.0.9-beta.0
+npm run release:beta
+```
+
+## 📋 发布流程说明
+
+当你运行 `npm run release:patch` 时，会自动执行以下步骤：
+
+1. ✅ **运行构建**：`npm run build`
+2. 📝 **更新版本号**：自动修改 `package.json` 中的版本号
+3. 📄 **生成 CHANGELOG**：根据 git commit 自动生成更新日志
+4. 🏷️ **创建 Git Tag**：创建版本标签（如 `v1.0.9`）
+5. 💾 **提交更改**：自动提交版本号和 CHANGELOG 的更改
+6. 📤 **发布到 npm**：执行 `npm publish`
+7. ⬆️ **推送到远程**：推送代码和标签到 Git 仓库
+
+## 🔍 发布前检查
+
+在发布前，建议手动运行检查脚本：
+
+```bash
+./scripts/pre-release-check.sh
+```
+
+这个脚本会检查：
+- ✅ Git 状态（是否有未提交的更改）
+- ✅ 当前分支（是否在 main/master）
+- ✅ 代码检查（ESLint）
+- ✅ 测试（如果有）
+- ✅ 构建
+
+## 📝 Commit 规范
+
+为了自动生成正确的 CHANGELOG，请遵循以下 commit 规范：
+
+### Commit 类型
+
+- `feat`: 新功能
+- `fix`: 修复 bug
+- `docs`: 文档更新
+- `style`: 代码格式（不影响代码运行）
+- `refactor`: 重构
+- `perf`: 性能优化
+- `test`: 测试相关
+- `chore`: 构建工具或辅助工具的变动
+
+### Commit 格式
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+### 示例
+
+```bash
+# 新功能
+git commit -m "feat: 添加文件大小格式化函数"
+git commit -m "feat(array): 添加数组去重方法"
+
+# 修复 bug
+git commit -m "fix: 修复日期格式化在 Safari 中的问题"
+git commit -m "fix(http): 修复请求超时配置无效的问题"
+
+# 破坏性更新（会触发 major 版本）
+git commit -m "feat: 重构 API 接口
+
+BREAKING CHANGE: 移除了旧的 formatDate 方法，请使用 formatTime 代替"
+```
+
+## 🎯 版本号规则
+
+遵循 [语义化版本](https://semver.org/lang/zh-CN/)：
+
+- **MAJOR（主版本号）**：不兼容的 API 修改
+- **MINOR（次版本号）**：向下兼容的功能性新增
+- **PATCH（修订号）**：向下兼容的问题修正
+
+### 何时升级版本？
+
+| 变更类型 | 版本类型 | 示例 |
+|---------|---------|------|
+| 修复 bug | patch | 1.0.8 -> 1.0.9 |
+| 新增功能（向下兼容） | minor | 1.0.8 -> 1.1.0 |
+| 破坏性更新 | major | 1.0.8 -> 2.0.0 |
+| 测试版本 | beta | 1.0.8 -> 1.0.9-beta.0 |
+
+## 🔧 手动发布（不推荐）
+
+如果需要手动控制每一步：
+
+```bash
+# 1. 运行构建
+npm run build
+
+# 2. 更新版本号和生成 CHANGELOG
+npm run standard-version -- --release-as patch
+
+# 3. 发布到 npm
+npm publish
+
+# 4. 推送到 Git
+git push --follow-tags
+```
+
+## 📦 发布到特定 registry
+
+如果需要发布到私有 npm registry：
+
+```bash
+# 设置 registry
+npm config set registry https://your-registry.com
+
+# 或者在发布时指定
+npm publish --registry https://your-registry.com
+```
+
+## 🔐 npm 认证
+
+首次发布需要登录 npm：
+
+```bash
+npm login
+```
+
+或者使用 token：
+
+```bash
+npm config set //registry.npmjs.org/:_authToken YOUR_TOKEN
+```
+
+## ⚠️ 注意事项
+
+1. **确保在正确的分支**：通常应该在 `main` 或 `master` 分支发布
+2. **确保代码已提交**：不要有未提交的更改
+3. **确保测试通过**：运行 `npm test` 确保所有测试通过
+4. **确保构建成功**：运行 `npm run build` 确保构建无错误
+5. **检查 .npmignore**：确保不会发布不必要的文件
+
+## 🔄 回滚版本
+
+如果发布了错误的版本：
+
+```bash
+# 1. 从 npm 撤回版本（24小时内）
+npm unpublish jinbi-utils@1.0.9
+
+# 2. 删除本地 tag
+git tag -d v1.0.9
+
+# 3. 删除远程 tag
+git push origin :refs/tags/v1.0.9
+
+# 4. 回退 commit
+git reset --hard HEAD~1
+git push -f origin main
+```
+
+## 📊 查看发布历史
+
+```bash
+# 查看所有版本
+npm view jinbi-utils versions
+
+# 查看最新版本
+npm view jinbi-utils version
+
+# 查看 Git tags
+git tag -l
+```
+
+## 🆘 常见问题
+
+### Q: 发布失败，提示 "You do not have permission to publish"
+
+A: 检查是否已登录 npm，或者是否有发布权限：
+```bash
+npm whoami
+npm owner ls jinbi-utils
+```
+
+### Q: 如何发布 beta 版本？
+
+A: 使用 `npm run release:beta`，这会创建类似 `1.0.9-beta.0` 的版本
+
+### Q: 如何跳过某个步骤？
+
+A: 可以手动执行命令，例如只更新版本号不发布：
+```bash
+npm run build
+standard-version --release-as patch
+# 不执行 npm publish
+```
+
+### Q: CHANGELOG 没有正确生成？
+
+A: 确保 commit 信息遵循规范，使用 `feat:`、`fix:` 等前缀
+
+## 📚 相关资源
+
+- [语义化版本规范](https://semver.org/lang/zh-CN/)
+- [Conventional Commits](https://www.conventionalcommits.org/zh-hans/)
+- [standard-version 文档](https://github.com/conventional-changelog/standard-version)
+- [npm 发布文档](https://docs.npmjs.com/cli/v8/commands/npm-publish)
+
+## 🎉 发布成功后
+
+1. ✅ 检查 npm 上的版本：https://www.npmjs.com/package/jinbi-utils
+2. ✅ 检查 CHANGELOG.md 是否正确生成
+3. ✅ 通知团队成员更新依赖
+4. ✅ 更新相关文档（如果需要）
+

package/api-extractor.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "./types/index.d.ts",
+  "bundledPackages": [ ],
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "./types/index.d.ts"
+  },
+  "docModel": {
+    "enabled": true
+  },
+  "apiReport": {
+    "enabled": true
+  }
+}

package/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

package/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  testEnvironment: 'jsdom',
+  testEnvironmentOptions: {
+    url: 'http://localhost'
+  },
+  preset: 'ts-jest',
+  rootDir: './',
+  collectCoverage: false,
+  transformIgnorePatterns: ["/node_modules/"],
+  moduleFileExtensions: ["js", "ts", "tsx"],
+  transform: {
+    '^.+\\.js$': 'babel-jest',
+    '.*\\.(ts)$': 'ts-jest',
+  },
+}