uniky 1.0.15 → 1.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uniky",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "uni-app 开发工具库，包含 hooks、http 请求和 vite 插件",
   "type": "module",
   "main": "./src/lib/index.ts",
@@ -20,11 +20,11 @@
   "files": [
     "src/lib",
     "src/plugin",
-    "README.md",
-    "CHANGELOG.md",
-    "ARCHITECTURE.md"
+    "scripts",
+    "README.md"
   ],
   "scripts": {
+    "postinstall": "node scripts/postinstall.js",
     "publish:auto": "bash publish.sh"
   },
   "keywords": [

package/scripts/postinstall.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+import { copyFileSync, mkdirSync, existsSync, writeFileSync } from 'fs';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+function findProjectRoot() {
+  let currentDir = process.cwd();
+  const maxDepth = 10;
+  let depth = 0;
+
+  while (depth < maxDepth) {
+    const packageJsonPath = join(currentDir, 'package.json');
+    if (existsSync(packageJsonPath)) {
+      const nodeModulesPath = join(currentDir, 'node_modules');
+      if (existsSync(nodeModulesPath)) {
+        return currentDir;
+      }
+    }
+    const parentDir = dirname(currentDir);
+    if (parentDir === currentDir) break;
+    currentDir = parentDir;
+    depth++;
+  }
+
+  return process.cwd();
+}
+
+function installPluginFiles() {
+  try {
+    const projectRoot = findProjectRoot();
+    const unikyDir = join(projectRoot, '.uniky');
+    const pluginDir = join(unikyDir, 'plugin');
+
+    if (!existsSync(unikyDir)) {
+      mkdirSync(unikyDir, { recursive: true });
+    }
+
+    if (!existsSync(pluginDir)) {
+      mkdirSync(pluginDir, { recursive: true });
+    }
+
+    const sourceDir = join(__dirname, '..', 'src', 'plugin');
+    const filesToCopy = [
+      'pages.defined.ts',
+      'global.defined.ts',
+      'lib.defined.ts',
+      'index.ts'
+    ];
+
+    let copiedCount = 0;
+    filesToCopy.forEach(file => {
+      const sourcePath = join(sourceDir, file);
+      const targetPath = join(pluginDir, file);
+
+      if (existsSync(sourcePath)) {
+        copyFileSync(sourcePath, targetPath);
+        copiedCount++;
+      }
+    });
+
+    const indexContent = `// created by zhuxietong on 2026-01-30 16:37
+export * from './plugin/index.js';
+`;
+
+    writeFileSync(join(unikyDir, 'index.ts'), indexContent, 'utf-8');
+
+    console.log(`[uniky] 插件文件已安装到 ${unikyDir} (${copiedCount} 个文件)`);
+  } catch (error) {
+    console.warn('[uniky] 插件文件安装失败，将在 vite 启动时自动安装:', error.message);
+  }
+}
+
+installPluginFiles();

package/src/plugin/index.ts

@@ -1,8 +1,11 @@
 // created by zhuxietong on 2026-01-30 16:37
 import type { Plugin } from 'vite';
+
 import pagesDefinedPlugin from './pages.defined';
 import globalDefinedPlugin from './global.defined';
 
+
+
 export interface UnikyPluginOptions {
   enablePages?: boolean;
   enableGlobal?: boolean;

package/src/plugin/pages.defined.ts

@@ -1,6 +1,6 @@
 import type { Plugin } from 'vite';
-import fs from 'node:fs';
-import path from 'node:path';
+import fs from 'fs';
+import path from 'path';
 
 interface PagesJson {
   pages?: Array<{
@@ -136,7 +136,7 @@ function extractPagePaths(pagesJson: PagesJson): string[] {
  */
 function generateTypeScriptCode(pagePaths: string[]): string {
   const pagesArray = pagePaths.map((p) => `"${p}"`).join(', ');
-  
+
   return `// Auto-generated by vite-plugin-pages-defined
 // Do not edit this file manually
 
@@ -156,18 +156,18 @@ interface ToRouteInterface {
 const buildUrl = (path: string, query?: Record<string, any>, json?: Record<string, any>): string => {
   const fullPath = path.startsWith('/') ? path : \`/\${path}\`;
   const params: string[] = [];
-  
+
   if (query && Object.keys(query).length > 0) {
     Object.entries(query).forEach(([key, value]) => {
       params.push(\`\${encodeURIComponent(key)}=\${encodeURIComponent(String(value))}\`);
     });
   }
-  
+
   if (json && Object.keys(json).length > 0) {
     const jsonStr = JSON.stringify(json);
     params.push(\`json=\${encodeURIComponent(jsonStr)}\`);
   }
-  
+
   return params.length > 0 ? \`\${fullPath}?\${params.join('&')}\` : fullPath;
 };
 
@@ -203,7 +203,7 @@ export const _To = ToRoute;
 function generatePagesFile(srcDir: string, outputPath: string): void {
   try {
     const pagesJsonPath = path.resolve(srcDir, 'pages.json');
-    
+
     // 读取 pages.json
     if (!fs.existsSync(pagesJsonPath)) {
       console.warn('[pages-defined] pages.json not found');
@@ -244,7 +244,7 @@ export default function pagesDefinedPlugin(): Plugin {
 
   return {
     name: 'vite-plugin-pages-defined',
-    
+
     configResolved(config) {
       // 确定 src 目录和输出路径
       srcDir = path.resolve(config.root, 'src');
@@ -259,7 +259,7 @@ export default function pagesDefinedPlugin(): Plugin {
     configureServer(server) {
       // 监听 pages.json 文件变化
       const pagesJsonPath = path.resolve(srcDir, 'pages.json');
-      
+
       server.watcher.add(pagesJsonPath);
       server.watcher.on('change', (file) => {
         if (file === pagesJsonPath) {
@@ -272,4 +272,4 @@ export default function pagesDefinedPlugin(): Plugin {
       generatePagesFile(srcDir, outputPath);
     }
   };
-}
+}

package/ARCHITECTURE.md

@@ -1,233 +0,0 @@
-# uniky 架构说明
-
-## 📦 混合发布模式
-
-从 v1.0.13 开始，`uniky` 采用**混合发布模式**，结合了源码发布和编译发布的优势。
-
-## 🗂️ 目录结构
-
-```
-uniky/
-├── src/
-│   ├── lib/              # TypeScript 源码（发布）
-│   │   ├── hook/
-│   │   │   ├── index.ts
-│   │   │   └── useParam.ts
-│   │   ├── http/
-│   │   │   ├── index.ts
-│   │   │   └── ky.ts
-│   │   └── index.ts
-│   │
-│   └── plugin/           # TypeScript 源码（编译）
-│       ├── index.ts
-│       ├── pages.defined.ts
-│       └── global.defined.ts
-│
-└── dist/
-    └── plugin/           # 编译后的 JS（发布）
-        ├── index.js
-        ├── index.d.ts
-        ├── pages.defined.js
-        ├── pages.defined.d.ts
-        ├── global.defined.js
-        └── global.defined.d.ts
-```
-
-## 📋 发布内容
-
-根据 `package.json` 的 `files` 字段：
-
-```json
-"files": [
-  "src/lib",      // ← lib 的 TS 源码
-  "dist/plugin",  // ← plugin 的编译 JS
-  "README.md"
-]
-```
-
-## 🎯 为什么采用混合模式？
-
-### lib 部分 - TypeScript 源码
-
-**原因**:
-- 在运行时被用户代码导入使用
-- 用户的 Vite 构建工具会处理 TS 编译
-- peerDependencies (vue, @dcloudio/uni-app) 由用户项目提供
-
-**优势**:
-- ✅ 避免依赖冲突 - 使用项目自己的依赖版本
-- ✅ 更好的类型支持 - 直接使用源码类型定义
-- ✅ 调试更方便 - 可以直接查看和调试源码
-- ✅ 体积更小 - 不包含重复的编译代码
-
-**使用示例**:
-```typescript
-// 在用户项目代码中
-import { useParam } from 'uniky';  // ← 导入 src/lib/hook/useParam.ts
-
-const params = useParam();
-```
-
-### plugin 部分 - 编译后的 JavaScript
-
-**原因**:
-- 在 Vite 配置文件中使用
-- Vite 加载配置文件时使用 esbuild
-- esbuild 在某些环境会尝试用 `require()` 加载模块
-- 编译为 JS 可以避免 ESM 兼容性问题
-
-**优势**:
-- ✅ 兼容性好 - 支持各种 Node.js 环境
-- ✅ 加载更快 - 无需实时编译
-- ✅ 类型完整 - 包含 `.d.ts` 类型定义
-
-**使用示例**:
-```typescript
-// vite.config.ts
-import { unikyPlugin } from 'uniky/plugin';  // ← 导入 dist/plugin/index.js
-
-export default defineConfig({
-  plugins: [
-    uni(),
-    ...unikyPlugin()  // ← 编译后的 JS 插件
-  ]
-});
-```
-
-## ⚙️ package.json 配置
-
-```json
-{
-  "type": "module",
-  "main": "./src/lib/index.ts",
-  "module": "./src/lib/index.ts",
-  "types": "./src/lib/index.ts",
-  "exports": {
-    ".": {
-      "types": "./src/lib/index.ts",
-      "import": "./src/lib/index.ts"
-    },
-    "./plugin": {
-      "types": "./dist/plugin/index.d.ts",
-      "import": "./dist/plugin/index.js"
-    }
-  }
-}
-```
-
-### 解读
-
-- **`"."`** - 主入口（lib）
-  - 指向 TypeScript 源码
-  - 用户项目构建工具会处理
-
-- **`"./plugin"`** - 插件入口
-  - 指向编译后的 JavaScript
-  - 包含类型定义文件
-
-## 🔧 构建配置
-
-### tsconfig.json
-
-```json
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "outDir": "./dist",
-    // ... 其他配置
-  },
-  "include": ["src/plugin/**/*"],      // ← 只编译 plugin
-  "exclude": ["src/lib/**/*"]          // ← 排除 lib
-}
-```
-
-### 构建脚本
-
-```json
-{
-  "scripts": {
-    "build": "tsc",                    // 只编译 plugin
-    "prepublishOnly": "npm run build"  // 发布前自动构建
-  }
-}
-```
-
-## 🚀 工作流程
-
-### 开发流程
-
-1. 修改 `src/lib/*` - 无需编译
-2. 修改 `src/plugin/*` - 需要运行 `npm run build`
-3. 使用 `npm link` 链接到测试项目
-4. 清除 Vite 缓存：`rm -rf node_modules/.vite`
-
-### 发布流程
-
-```bash
-# 方式一：自动发布脚本
-npm run publish:auto
-
-# 方式二：手动发布
-npm run build        # 编译 plugin
-npm publish          # 发布到 npm
-```
-
-`prepublishOnly` 钩子确保发布前自动编译。
-
-## 💡 最佳实践
-
-### 对于库用户
-
-1. **使用 lib**:
-```typescript
-import { useParam } from 'uniky';
-```
-- 确保项目支持 TypeScript
-- Vite 会自动处理编译
-- 不需要任何特殊配置
-
-2. **使用 plugin**:
-```typescript
-import { unikyPlugin } from 'uniky/plugin';
-```
-- 直接使用，无需担心 ESM 问题
-- 已编译为 JS，兼容性好
-
-### 对于库开发者
-
-1. **修改 lib 代码**:
-   - 直接修改 `src/lib/**/*`
-   - 无需编译
-
-2. **修改 plugin 代码**:
-   - 修改 `src/plugin/**/*`
-   - 运行 `npm run build`
-   - 测试编译后的代码
-
-3. **发布新版本**:
-   - 运行 `npm run publish:auto`
-   - 自动编译 + 发布
-
-## 🎓 技术要点
-
-1. **ESM 模块系统**
-   - `"type": "module"` 声明包为 ESM
-   - 所有导入使用 `.js` 扩展名
-   - Node.js 内置模块使用 `node:` 前缀
-
-2. **TypeScript 编译**
-   - 只编译 plugin 部分
-   - 生成 `.js` 和 `.d.ts` 文件
-   - 保持 ESM 模块格式
-
-3. **依赖管理**
-   - peerDependencies 避免依赖冲突
-   - 用户项目提供实际依赖
-   - 开发时安装 devDependencies
-
-## 📚 参考资料
-
-- [Node.js ESM 文档](https://nodejs.org/api/esm.html)
-- [TypeScript 模块解析](https://www.typescriptlang.org/docs/handbook/module-resolution.html)
-- [Vite 插件开发](https://vitejs.dev/guide/api-plugin.html)

package/CHANGELOG.md

@@ -1,74 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## [1.0.13] - 2024-01-30
-
-### Changed
-- **重要变更：采用混合发布模式**
-  - **lib 部分**：保持 TypeScript 源码（`src/lib/**/*`），由用户项目构建工具处理
-    - 避免依赖冲突，使用项目自己的 vue、@dcloudio/uni-app 等依赖
-    - 更好的类型支持和调试体验
-  - **plugin 部分**：编译为 JavaScript（`dist/plugin/**/*`）
-    - 解决 Vite 配置文件加载时的 ESM 兼容性问题
-    - 包含完整的类型定义文件（`.d.ts`）
-  - 更新 `tsconfig.json`，只编译 `src/plugin` 目录
-  - 更新 `package.json` exports 配置，分别指向源码和编译文件
-
-### Fixed
-- **彻底修复 ESM 兼容性问题**
-  - 修复了 `uniky/plugin` 在 Vite 配置文件加载时被 `require()` 导致的 ESM 错误
-  - 将 Node.js 内置模块导入改为使用 `node:` 前缀 (如 `node:fs`, `node:path`)
-  - 在所有相对导入中添加 `.js` 扩展名，确保 ESM 环境下正确解析
-  - 验证在 uni-shell 项目中正常运行，无警告
-
-### Added
-- 添加了 `tsconfig.json` 配置文件，提供完整的 TypeScript 编译配置
-- 在 README 中新增"架构说明"章节，详细说明混合发布模式的优势
-- 在 README 中新增"故障排除"章节，包含 7 种常见 ESM 错误的解决方案
-- 在 README 中新增"开发说明"章节，包含本地开发和发布流程
-- 为 uni-shell 项目创建 `UPDATE_UNIKY.md` 更新指南
-
-### 如何更新
-
-在使用 `uniky` 的项目中执行：
-
-```bash
-# 如果是从 npm 安装
-npm update uniky
-
-# 如果是本地开发使用 npm link
-cd /path/to/uniky
-npm run build
-npm link
-
-cd /path/to/your-project
-npm link uniky
-rm -rf node_modules/.vite  # 清除 Vite 缓存
-```
-
-## [1.0.12] - 2024-01-30
-
-### Changed
-- 全部编译为 JavaScript（已在 1.0.13 中改为混合模式）
-
-## [1.0.11] - 2024-01-30
-
-### Fixed
-- 初步 ESM 兼容性修复（未完全解决）
-
-### Added
-- 添加了基础的 TypeScript 和 ESM 支持
-- 在 README 中新增故障排除章节
-
-### Changed
-- 优化了 `package.json` 配置，添加 `sideEffects: false`
-
-## [1.0.10] - 2024-01-30
-
-### Initial Release
-- 提供 uni-app 常用 hooks
-- 提供 HTTP 请求封装
-- 提供 Vite 插件：
-  - `pagesDefinedPlugin`: 从 pages.json 生成类型安全的路由定义
-  - `globalDefinedPlugin`: 自动收集并生成全局类型定义

package/src/plugin/_pages.md

@@ -1,37 +0,0 @@
-
-src/autoGen/global/pages.ts 的生成逻辑
-```ts
-// pages.json 提取到的path 整理
-export const _Pages = ["pages/home/index", "pages/about/index", "pages/profile/index"] as const;
-export type _PagePath = typeof _Pages[number];
-
-
-type RouteFunction = (path: _PagePath, options: { query: Record<string, any>, json: Record<string, any> }) => void;
-interface ToRouteInterface {
-  navigate: RouteFunction;
-  redirect: RouteFunction;
-  switchTab: RouteFunction;
-  reLaunch: RouteFunction;
-  back: (delta?: number) => void;
-}
-
-const ToRoute: ToRouteInterface = {
-  push: (path, options) => {
-    // Implementation for navigate
-  },
-  redirect: (path, options) => {
-    // Implementation for redirect
-  },
-  switchTab: (path, options) => {
-    // Implementation for switchTab
-  },
-  reLaunch: (path, options) => {
-    // Implementation for reLaunch
-  },
-  back: (delta = 1) => {
-    // Implementation for back
-  }
-};
-
-export const _To = ToRoute;
-```