fe-stack 0.0.2 → 0.0.4

package/README.md

@@ -95,23 +95,18 @@ export default {
 
 #### Vue 应用模式
 
-在项目中创建 `vite.config.ts`：
-
 ```typescript
-import { defineConfig } from 'vite';
-import { createBaseConfig } from 'fe-stack/vite.config.base.js';
-
-const baseConfig = createBaseConfig(import.meta.dirname, { mode: 'app' });
-
-export default defineConfig({
-  ...baseConfig,
-  // 项目特定配置
-  server: {
-    port: 5173,
-    proxy: {
-      '/api': {
-        target: 'http://your-api-server',
-        changeOrigin: true,
+import { createBaseConfig } from 'fe-stack/vite.config.base';
+
+export default createBaseConfig(import.meta.dirname, {
+  viteConfig: {
+    server: {
+      port: 5173,
+      proxy: {
+        '/api': {
+          target: 'http://your-api-server',
+          changeOrigin: true,
+        }
       }
     }
   }
@@ -120,27 +115,26 @@ export default defineConfig({
 
 #### Lib 打包模式
 
-用于打包纯 TypeScript 库：
-
 ```typescript
-import { defineConfig } from 'vite';
-import { createBaseConfig } from 'fe-stack/vite.config.base.js';
+import { createBaseConfig } from 'fe-stack/vite.config.base';
 
-const baseConfig = createBaseConfig(import.meta.dirname, {
+export default createBaseConfig(import.meta.dirname, {
   mode: 'lib',
-  libOptions: {
-    lib: {
-      name: 'MyLib',  // UMD 全局变量名
+  viteConfig: {
+    build: {
+      lib: {
+        entry: './src/index.ts',
+        name: 'MyLib',
+        fileName: 'index',
+      },
     },
-    dtsExclude: ['src/**/*.test.ts'],  // 排除测试文件
   },
 });
-
-export default defineConfig(baseConfig);
 ```
 
 **特性：**
-- ✅ 自动配置 `vite-plugin-dts` 生成类型文件
-- ✅ 自动合并所有类型到单个 `.d.ts` 文件
+- ✅ 完整的 TypeScript 类型支持
+- ✅ 使用 `mergeConfig` 优雅合并配置
+- ✅ lib 模式自动配置 `vite-plugin-dts`
 - ✅ 默认打包为 ESM 格式
-- ✅ entry 默认为 `src/index.ts`
+- ✅ 所有配置通过 `viteConfig` 统一管理，简单直观

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "fe-stack",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "共享的配置文件集合，用于 Vite、Tailwind、Biome、Prettier 和 TypeScript",
   "type": "module",
   "exports": {
-    "./vite.config.base.js": "./vite.config.base.js",
+    "./vite.config.base": {
+      "types": "./vite.config.base.d.ts",
+      "import": "./vite.config.base.js"
+    },
     "./tsconfig.*.json": "./tsconfig.*.json",
     "./biome.json": "./biome.json",
     "./prettier.json": "./prettier.json",
@@ -17,6 +20,7 @@
     "tsconfig.app.json",
     "tsconfig.node.json",
     "vite.config.base.js",
+    "vite.config.base.d.ts",
     "README.md"
   ],
   "keywords": [

package/vite.config.base.d.ts

@@ -0,0 +1,26 @@
+import type { UserConfig } from 'vite';
+
+export interface CreateBaseConfigOptions {
+  /**
+   * 构建模式
+   * - 'app': Vue 应用模式，包含 Vue Router、Auto Import 等
+   * - 'lib': 库打包模式，配置 vite-plugin-dts
+   */
+  mode?: 'app' | 'lib';
+
+  /**
+   * 额外的 Vite 配置，会与基础配置合并
+   */
+  viteConfig?: UserConfig;
+}
+
+/**
+ * 创建基础 Vite 配置
+ * @param dirname - 项目根目录路径（通常使用 import.meta.dirname）
+ * @param options - 配置选项
+ * @returns Vite 配置
+ */
+export function createBaseConfig(
+  dirname: string,
+  options?: CreateBaseConfigOptions,
+): import('vite').UserConfigExport;

package/vite.config.base.js

@@ -4,11 +4,26 @@ import vue from '@vitejs/plugin-vue';
 import AutoImport from 'unplugin-auto-import/vite';
 import Components from 'unplugin-vue-components/vite';
 import VueRouter from 'unplugin-vue-router/vite';
+import { defineConfig, mergeConfig } from 'vite';
 import dts from 'vite-plugin-dts';
 
+/**
+ * @typedef {import('vite').UserConfig} UserConfig
+ * @typedef {Object} CreateBaseConfigOptions
+ * @property {'app' | 'lib'} [mode] - 构建模式：'app' 为 Vue 应用，'lib' 为库打包
+ * @property {UserConfig} [viteConfig] - 额外的 Vite 配置，会与基础配置合并
+ */
+
+/**
+ * 创建基础 Vite 配置
+ * @param {string} dirname - 项目根目录路径
+ * @param {CreateBaseConfigOptions} [options] - 配置选项
+ * @returns {import('vite').UserConfigExport} Vite 配置
+ */
 export function createBaseConfig(dirname, options = {}) {
-  const { mode = 'app', libOptions = {} } = options;
+  const { mode = 'app', viteConfig = {} } = options;
 
+  /** @type {UserConfig} */
   const baseConfig = {
     resolve: {
       alias: {
@@ -26,6 +41,14 @@ export function createBaseConfig(dirname, options = {}) {
       ],
     },
     plugins: [],
+    worker: {
+      format: 'es',
+      rollupOptions: {
+        output: {
+          format: 'es',
+        },
+      },
+    },
   };
 
   // App mode: 包含 Vue 全家桶
@@ -47,41 +70,26 @@ export function createBaseConfig(dirname, options = {}) {
     );
   }
 
-  // Lib mode: 纯 TypeScript，用于打包库
+  // Lib mode: 提供默认配置
   if (mode === 'lib') {
-    // 添加 lib 构建配置
     baseConfig.build = {
       lib: {
         entry: path.resolve(dirname, 'src/index.ts'),
         formats: ['es'],
         fileName: 'index',
-        ...libOptions.lib,
       },
     };
 
-    // 添加 dts 插件
-    // 重要：include 需要使用绝对路径，否则在某些项目中会报错
-    const dtsInclude = libOptions.dtsInclude || ['src/**/*.ts'];
-    const absoluteInclude = dtsInclude.map((pattern) =>
-      pattern.startsWith('/') ? pattern : path.resolve(dirname, pattern),
-    );
-
-    const dtsExclude = libOptions.dtsExclude || [];
-    const absoluteExclude = dtsExclude.map((pattern) =>
-      pattern.startsWith('/') ? pattern : path.resolve(dirname, pattern),
-    );
-
+    // 默认添加 dts 插件
     baseConfig.plugins.push(
       dts({
-        include: absoluteInclude,
-        exclude: absoluteExclude,
-        rollupTypes: true,
-        // 确保 root 设置为项目根目录
+        include: ['src/**/*.ts'],
         root: dirname,
-        ...libOptions.dts,
+        rollupTypes: true,
       }),
     );
   }
 
-  return baseConfig;
+  // 使用 mergeConfig 合并用户自定义配置
+  return defineConfig(mergeConfig(baseConfig, viteConfig));
 }