my-uniapp-tools 1.0.0 → 1.0.1

package/README.md

@@ -1,4 +1,4 @@
-# Huang UniApp Toolkit
+# My UniApp Tools
 
 一个专为 UniApp 开发设计的实用工具函数库，提供常用的功能模块，帮助开发者快速构建跨平台应用。
 
@@ -6,20 +6,20 @@
 
 ```bash
 # 使用 npm
-npm install huang-uniapp-toolkit
+npm install my-uniapp-tools
 
 # 使用 yarn
-yarn add huang-uniapp-toolkit
+yarn add my-uniapp-tools
 
 # 使用 pnpm
-pnpm add huang-uniapp-toolkit
+pnpm add my-uniapp-tools
 ```
 
 ## 🚀 快速开始
 
 ```javascript
 // 导入所有工具函数
-import * from 'huang-uniapp-toolkit'
+import * as Tools from 'my-uniapp-tools'
 
 // 或者按需导入
 import { 
@@ -28,13 +28,15 @@ import {
   copyText, 
   setStorageSync, 
   getStorageSync, 
+  clearStorageSync,
+  useWindowInfo,
   getPlatform, 
   getCurrentEnv, 
   onCheckForUpdate,
   getStatusBarHeight,
   getNavHeight,
-  getAppConfig
-} from 'huang-uniapp-toolkit'
+  getTopNavBarHeight
+} from 'my-uniapp-tools'
 ```
 
 ## 📚 API 文档
@@ -65,6 +67,8 @@ useToast(
 )
 ```
 
+### 🧭 导航工具 (Navigation)
+
 #### `useBack(params)`
 
 返回上一页并支持传递参数给上一页的 init 方法
@@ -83,6 +87,8 @@ useBack({ refresh: true, data: 'some data' })
 
 **注意：** 上一页需要暴露 `init` 方法来接收参数
 
+### 📋 剪贴板工具 (Clipboard)
+
 #### `copyText(text)`
 
 跨平台文本复制功能，支持 H5、App、小程序。H5 平台优先使用现代的 Clipboard API，失败时回退到传统方法。
@@ -95,12 +101,14 @@ useBack({ refresh: true, data: 'some data' })
 copyText('要复制的文本内容')
 ```
 
+### 🖥️ 系统信息工具 (System)
+
 #### `useWindowInfo()`
 
 获取当前窗口的尺寸、像素比等信息
 
 **返回值:**
-- 窗口信息对象
+- 窗口信息对象，包含窗口尺寸、像素比等信息
 
 **示例:**
 ```javascript
@@ -240,7 +248,7 @@ const customNavStyle = {
 }
 ```
 
-#### `getAppConfig()`
+#### `getTopNavBarHeight()`
 
 一次性获取应用所需的状态栏和导航栏高度配置信息
 
@@ -251,14 +259,14 @@ const customNavStyle = {
 
 **示例:**
 ```javascript
-const appConfig = getAppConfig()
-console.log(appConfig.statusBarHeight) // 状态栏高度
-console.log(appConfig.navHeight)       // 导航栏总高度
+const topNavConfig = getTopNavBarHeight()
+console.log(topNavConfig.statusBarHeight) // 状态栏高度
+console.log(topNavConfig.navHeight)       // 导航栏总高度
 
 // 用于全局配置
 const globalConfig = {
-  ...appConfig,
-  contentHeight: windowHeight - appConfig.navHeight
+  ...topNavConfig,
+  contentHeight: windowHeight - topNavConfig.navHeight
 }
 ```
 
@@ -351,6 +359,11 @@ npm install
 yarn dev
 # 或
 npm run dev
+
+# 运行测试
+yarn test
+# 或
+npm test
 ```
 
 ## 🏗️ 技术栈
@@ -362,7 +375,9 @@ npm run dev
 ## 📁 项目结构
 
 ```
-huang-uniapp-toolkit/
+my-uniapp-tools/
+├── .augment/           # 增强配置目录
+│   └── rules/
 ├── src/
 │   ├── ui/              # UI交互工具函数
 │   │   └── index.ts
@@ -375,14 +390,17 @@ huang-uniapp-toolkit/
 │   ├── localStorage/    # 本地存储工具
 │   │   └── index.ts
 │   └── index.js        # 主入口文件
+├── .gitignore          # Git 忽略配置
 ├── package.json        # 项目配置
 ├── tsconfig.json       # TypeScript 配置
-└── README.md          # 项目说明
+├── yarn.lock           # Yarn 依赖锁定文件
+├── README.md           # 项目说明
+└── RECORD.md           # 项目记录
 ```
 
 ## 🔄 版本信息
 
-当前版本：v1.0.5
+当前版本：v1.0.0
 
 ## 📄 许可证
 
@@ -402,55 +420,26 @@ ISC
 
 ## 📝 更新日志
 
-### v1.0.6
-- ✨ **新增功能**：添加状态栏和导航栏高度获取函数
-- 📏 新增 `getStatusBarHeight()` 函数，用于获取设备状态栏高度
-- 📐 新增 `getNavHeight()` 函数，用于获取小程序导航栏总高度
-- ⚙️ 新增 `getAppConfig()` 函数，一次性获取状态栏和导航栏配置信息
-- 🛡️ 添加完善的错误处理机制，确保在获取失败时返回默认值
-- 📚 更新API文档，添加详细的使用说明和界面适配示例
-- 💡 遵循单一职责原则，每个函数专注于特定的高度获取功能
-- 🎯 主要用于小程序平台的界面适配和自定义导航栏开发
-
-### v1.0.5
-- ✨ **新增功能**：完善 `onCheckForUpdate()` 函数
-- 📱 实现小程序版本更新检查功能，支持自动检查、下载和提示更新
-- 🔄 支持静默下载新版本，用户可选择立即重启或稍后更新
-- 🛡️ 添加完善的错误处理机制，包括下载失败和异常情况处理
-- 📚 更新API文档，添加详细的平台支持说明和使用示例
-- 💡 遵循单一职责原则，提供用户友好的更新体验
-- 🎯 支持微信、支付宝、百度、抖音、QQ、快手、京东等主流小程序平台
-
-### v1.0.4
-- ✨ **新增功能**：完善 `getCurrentEnv()` 函数
-- 📱 新增小程序账户信息获取功能，支持获取appId、版本号、环境版本等信息
-- 🛡️ 添加错误处理机制，确保函数调用的稳定性
-- 📚 更新API文档，添加详细的使用说明和示例
-- 💡 遵循单一职责原则，提供清晰的返回值结构
-
-### v1.0.3
-- 🏗️ **重大重构**：按功能类型重新组织代码结构
-- 📁 将原 `common` 模块拆分为 5 个专门模块：
+### v1.0.0
+- 🎯 **初始版本发布**
+- 🏗️ **模块化架构**：按功能类型组织代码结构
+- 📁 **五大核心模块**：
   - `ui` - UI交互工具（useToast）
   - `navigation` - 导航工具（useBack）
   - `clipboard` - 剪贴板工具（copyText）
-  - `system` - 系统信息工具（useWindowInfo, getPlatform, getCurrentEnv）
-  - `localStorage` - 本地存储工具（保持不变）
-- 📚 更新文档结构，按模块分类展示API
-- 💡 遵循单一职责原则，提高代码可维护性
-- 🔧 完善函数注释，便于后续维护
-
-### v1.0.2
-- 🎉 完善项目文档
-- 🔧 优化代码注释
-- 🛡️ 添加错误处理机制
-- ✨ 新增 `getPlatform()` 函数，用于获取当前运行平台
-- 🚀 优化 `copyText()` 函数，H5 平台优先使用现代 Clipboard API
-
-### v1.0.1
-- 🎯 初始版本发布
-- 📦 基础工具函数实现
-- 💾 本地存储工具实现
+  - `system` - 系统信息工具（useWindowInfo, getPlatform, getCurrentEnv, onCheckForUpdate, getStatusBarHeight, getNavHeight, getTopNavBarHeight）
+  - `localStorage` - 本地存储工具（setStorageSync, getStorageSync, clearStorageSync）
+- ✨ **核心功能**：
+  - 📱 跨平台消息提示和导航返回
+  - 📋 跨平台剪贴板操作
+  - 🖥️ 系统信息获取和平台检测
+  - 🔄 小程序版本更新检查
+  - 📏 状态栏和导航栏高度适配
+  - 💾 本地存储数据管理
+- 🛡️ **完善的错误处理机制**，确保函数调用的稳定性
+- 💡 **遵循单一职责原则**，每个函数专注于特定功能
+- 📚 **详细的API文档**，包含使用说明和示例代码
+- 🎯 **支持主流平台**：微信、支付宝、百度、抖音、QQ、快手、京东等小程序平台以及H5、App
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "my-uniapp-tools",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "main": "src/index.js",
     "type": "module",
     "scripts": {

package/src/clipboard/index.ts

@@ -10,7 +10,8 @@ import { useToast } from '../ui';
  * @description 支持 H5、App、小程序。H5 平台优先使用现代的 Clipboard API，失败时回退到传统方法
  */
 export function copyText(text: string) {
-  // #ifndef H5 条件编译：非 H5 平台（如 App、小程序）执行此代码块
+  // #ifndef H5
+  // 条件编译：非 H5 平台（如 App、小程序）执行此代码块
   uni.setClipboardData({
     data: text, // 要复制的文本内容
     success: function () {
@@ -21,7 +22,8 @@ export function copyText(text: string) {
     },
   });
   // #endif
-  // #ifdef H5 条件编译：仅 H5 平台执行此代码块
+  // #ifdef H5
+  // 条件编译：仅 H5 平台执行此代码块
   // 优先使用现代的 Clipboard API
   if (navigator.clipboard && window.isSecureContext) {
     navigator.clipboard.writeText(text).then(() => {

package/RECORD.md

@@ -1,34 +0,0 @@
-# 项目记录 (RECORD.md)
-
-## 项目简介
-
-本项目名为 `my-uniapp-tool`，是一个基于 Node.js 的工具库，旨在为 UniApp 开发提供便利。根据 `package.json`，当前版本为 `1.0.2`，使用 ES Module 规范。
-
-## 核心框架/技术
-
-- **主要语言**: TypeScript (从 `tsconfig.json` 和 `.ts` 文件扩展名推断)
-- **运行环境**: Node.js (从 `package.json` 的 `scripts` 和 `main` 指向 `.js` 文件推断)
-- **核心依赖**:
-  - `@dcloudio/types`: 提供 DCloud UniApp 相关的类型定义，表明项目与 UniApp 生态紧密相关。
-
-## 目录结构
-
-```
-.
-├── .gitignore         # Git 忽略配置文件
-├── package.json       # 项目元数据和依赖管理
-├── tsconfig.json      # TypeScript 编译配置文件
-├── yarn.lock          # Yarn 依赖版本锁定文件
-├── src/               # 源代码目录
-│   ├── index.js       # 项目入口文件 (可能是编译后的 JS)
-│   ├── common/        # 通用工具或模块目录
-│   │   └── index.ts   # 通用模块入口文件
-│   └── localStorage/  # 本地存储相关模块目录
-│       └── index.ts   # 本地存储模块入口文件
-└── RECORD.md          # 本项目记录文件 (即本文档)
-```
-
-- **根目录**: 包含项目的基本配置文件和元数据。
-- **`src` 目录**: 存放项目的主要源代码。
-  - `common`: 包含项目中可复用的通用函数、常量或类型定义。
-  - `localStorage`: 封装了与浏览器或小程序本地存储相关的操作。