jinbi-utils 1.0.0

package/.babelrc

@@ -0,0 +1,19 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "modules": false,
+        "targets": {
+          "node": "current"
+        }
+      }
+    ],
+    "@babel/preset-typescript"
+  ],
+  "env": {
+    "test": {
+      "plugins": ["@babel/plugin-transform-modules-commonjs"]
+    }
+  }
+}

package/.cz-config.js

@@ -0,0 +1,55 @@
+'use strict';
+
+module.exports = {
+
+  types: [
+    {value: 'feat',     name: 'feat:     新特性或功能'},
+    {value: 'fix',      name: 'fix:      修复Bug'},
+    {value: 'docs',     name: 'docs:     文档的变更'},
+    {value: 'style',    name: 'style:    不影响代码运行的风格更改(空白、格式、缺少分号等)'},
+    {value: 'refactor', name: 'refactor: 代码重构, 注意和feat、fix区分'},
+    {value: 'perf',     name: 'perf:     提高性能'},
+    {value: 'test',     name: 'test:     添加测试'},
+    {value: 'chore',    name: 'chore:    开发工具(构建、脚手架工具等)和库（如文档生成）的更改'},
+    {value: 'revert',   name: 'revert:   代码回滚'},
+    {value: 'WIP',      name: 'WIP:      进行中开发'}
+  ],
+
+  // list of Function Modules
+  scopes: [
+    {name: '模块1'},
+    {name: '模块2'},
+  ],
+
+  // it needs to match the value for field type. Eg.: 'fix'
+  /*
+  scopeOverrides: {
+    fix: [
+      {name: 'merge'},
+      {name: 'style'},
+      {name: 'e2eTest'},
+      {name: 'unitTest'}
+    ]
+  },
+  */
+  // override the messages, defaults are as follows
+  messages: {
+    type: '选择一种提交类型:',
+    scope: '选择一个scope (可选):',
+    // used if allowCustomScopes is true
+    customScope: 'Denote the SCOPE of this change:',
+    subject: '简短说明:\n',
+    body: '长说明，使用"|"换行(可选)：\n',
+    breaking: '非兼容性说明 (可选):\n',
+    footer: '关联关闭的issue，例如：#31, #34(可选):\n',
+    confirmCommit: '确定提交说明?'
+  },
+
+
+  allowCustomScopes: true,
+  allowBreakingChanges: ['feat', 'fix'],
+
+  // limit subject length
+  subjectLimit: 100
+
+};

package/.dockerignore

@@ -0,0 +1,3 @@
+ .git
+ node_modules
+ npm-debug.log

package/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintignore

@@ -0,0 +1,8 @@
+/.git
+/.vscode
+node_modules
+dist
+test
+rollup.config.js
+types
+*

package/.eslintrc.js

@@ -0,0 +1,54 @@
+module.exports = {
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "parserOptions": {
+    "ecmaVersion": 2015,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'prefer-promise-reject-errors': 'off', // 要求使用 Error 对象作为 Promise 拒绝的原因
+    'linebreak-style': 'off', // 回车换行风格
+    'no-trailing-spaces': 1, // 允许在空行、在注释块中使用空白符
+    'import/prefer-default-export': 'off', // 
+    'object-curly-newline': 'off', // 不强制花括号内换行
+    'import/named': 'off', // 停用 import/named 校验
+    'no-underscore-dangle': 'off', // 禁止标识符中有悬空下划线
+    'import/order': 'off',
+    'prefer-object-spread': 1, // 禁止使用以对象字面量作为第一个参数的 Object.assign，优先使用对象扩展。
+    'arrow-parens': [2, "as-needed", { "requireForBlockBody": true }], // 要求箭头函数的参数使用圆括号
+    "comma-dangle": ["error", "always-multiline"], // 要求或禁止使用拖尾逗号
+    "semi": 2, // 要求或禁止使用分号代替 ASI
+    "keyword-spacing": 2, // 强制关键字周围空格的一致性
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-inferrable-types": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/member-delimiter-style": ["error", {
+      "multiline": {
+        "delimiter": "semi",
+        "requireLast": true
+      },
+      "singleline": {
+        "delimiter": "semi",
+        "requireLast": true
+      }
+    }]
+  }
+};

package/Dockerfile

@@ -0,0 +1,3 @@
+FROM nginx
+
+COPY docs /usr/share/nginx/html/

package/README.md

@@ -0,0 +1,160 @@
+
+
+
+          
+# 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()
+```
+
+## 安装和使用
+
+1. 安装依赖：
+```bash
+npm install jbwy-utils
+```
+
+2. 引入使用：
+```typescript
+import { isEmpty } from 'jbwy-utils/common'
+import { formatPhone } from 'jbwy-utils/string'
+// ... 按需引入其他功能
+```
+
+注意：所有模块都支持按需引入，可以只引入需要使用的功能，减少打包体积。
+
+        

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'],
+};