fe-stack 0.0.1

package/README.md

@@ -0,0 +1,146 @@
+# fe-stack
+
+一个包含 Vite、Tailwind、Biome、Prettier 和 TypeScript 配置的共享包，可以在多个项目中复用。
+
+
+## 安装方法
+
+在项目中安装：
+
+```bash
+pnpm add -D fe-stack
+```
+
+## 使用方法
+
+### 1. Biome 配置
+
+在项目中创建 `biome.json` 继承：
+```json
+{
+  "extends": ["fe-stack/biome.json"]
+}
+```
+
+### 2. Prettier 配置
+
+在项目根目录创建 `.prettierrc.json`：
+
+```json
+"fe-stack/prettier.json"
+```
+
+或者：
+```json
+{
+  "extends": "fe-stack/prettier.json"
+}
+```
+
+### 3. Tailwind 配置
+
+在项目中创建 `tailwind.config.js`：
+
+```javascript
+import baseConfig from 'fe-stack/tailwind.config.js';
+
+export default {
+  ...baseConfig,
+  // 项目特定的覆盖配置
+  theme: {
+    extend: {
+      ...baseConfig.theme?.extend,
+      // 你的自定义主题
+    },
+  },
+};
+```
+
+### 4. TypeScript 配置
+
+**tsconfig.json**（Vue 应用）：
+```json
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ]
+}
+```
+
+**tsconfig.app.json**：
+```json
+{
+  "extends": "fe-stack/tsconfig.app.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"]
+}
+```
+
+**tsconfig.node.json**：
+```json
+{
+  "extends": "fe-stack/tsconfig.node.json",
+  "include": ["vite.config.*"]
+}
+```
+
+### 5. Vite 配置
+
+#### 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,
+      }
+    }
+  }
+});
+```
+
+#### Lib 打包模式
+
+用于打包纯 TypeScript 库：
+
+```typescript
+import { defineConfig } from 'vite';
+import { createBaseConfig } from 'fe-stack/vite.config.base.js';
+
+const baseConfig = createBaseConfig(import.meta.dirname, {
+  mode: 'lib',
+  libOptions: {
+    lib: {
+      name: 'MyLib',  // UMD 全局变量名
+    },
+    dtsExclude: ['src/**/*.test.ts'],  // 排除测试文件
+  },
+});
+
+export default defineConfig(baseConfig);
+```
+
+**特性：**
+- ✅ 自动配置 `vite-plugin-dts` 生成类型文件
+- ✅ 自动合并所有类型到单个 `.d.ts` 文件
+- ✅ 默认打包为 ESM 格式
+- ✅ entry 默认为 `src/index.ts`

package/biome.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "experimentalScannerIgnores": ["node_modules", "build", "dist", "public"]
+  },
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "groups": [":URL:", ":NODE:"]
+          }
+        }
+      }
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "lineWidth": 80,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "domains": {
+      "vue": "all"
+    },
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noExplicitAny": "off",
+        "noUnknownAtRules": "off"
+      },
+      "performance": {
+        "noDynamicNamespaceImportAccess": "off"
+      },
+      "style": {
+        "noNonNullAssertion": "off"
+      }
+    }
+  },
+  "overrides": [
+    {
+      "includes": [".vscode/**"],
+      "json": {
+        "parser": {
+          "allowComments": true,
+          "allowTrailingCommas": true
+        }
+      }
+    },
+    {
+      "includes": ["**/*.vue"],
+      "formatter": {
+        "enabled": false
+      },
+      "linter": {
+        "rules": {
+          "style": {
+            "useConst": "off",
+            "useImportType": "off"
+          },
+          "correctness": {
+            "noUnusedVariables": "off",
+            "noUnusedImports": "off"
+          }
+        }
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "fe-stack",
+  "version": "0.0.1",
+  "description": "共享的配置文件集合，用于 Vite、Tailwind、Biome、Prettier 和 TypeScript",
+  "type": "module",
+  "exports": {
+    "./vite.config.base.js": "./vite.config.base.js",
+    "./tsconfig.*.json": "./tsconfig.*.json",
+    "./biome.json": "./biome.json",
+    "./prettier.json": "./prettier.json",
+    "./tailwind.config.js": "./tailwind.config.js"
+  },
+  "files": [
+    "biome.json",
+    "prettier.json",
+    "tailwind.config.js",
+    "tsconfig.app.json",
+    "tsconfig.node.json",
+    "vite.config.base.js",
+    "README.md"
+  ],
+  "keywords": [
+    "config",
+    "vite",
+    "tailwind",
+    "biome",
+    "prettier",
+    "typescript",
+    "vue",
+    "shared-config"
+  ],
+  "scripts": {
+    "dev": "pnpm --filter playground dev",
+    "dev:lib": "pnpm --filter playground-lib dev",
+    "test:lib": "pnpm --filter playground-lib test",
+    "build:lib": "pnpm --filter playground-lib build",
+    "build:playground": "pnpm --filter playground build",
+    "preview": "pnpm --filter playground preview",
+    "prepublishOnly": "pnpm pack --dry-run"
+  },
+  "dependencies": {
+    "@tailwindcss/vite": "^4.1.18",
+    "@types/node": "^22.10.5",
+    "@vitejs/plugin-vue": "^6.0.3",
+    "@vue/tsconfig": "^0.7.0",
+    "unplugin-auto-import": "^20.3.0",
+    "unplugin-vue-components": "^30.0.0",
+    "unplugin-vue-router": "^0.19.2",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": "^2.2.6",
+    "prettier": "^3.7.4",
+    "tailwindcss": "^4.1.18",
+    "typescript": "~5.9.3",
+    "vite": "^7.3.1"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.0.0"
+  }
+}

package/prettier.json

@@ -0,0 +1,18 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "overrides": [
+    {
+      "files": "*.vue",
+      "options": {
+        "parser": "vue",
+        "vueIndentScriptAndStyle": false
+      }
+    }
+  ]
+}

package/tailwind.config.js

@@ -0,0 +1,11 @@
+/** @type {import('tailwindcss').Config} */
+export default {
+  content: [
+    "./index.html",
+    "./src/**/*.{vue,js,ts,jsx,tsx}",
+  ],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+}

package/tsconfig.app.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "types": ["vite/client", "unplugin-vue-router/client"],
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler"
+  }
+}

package/tsconfig.node.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "types": ["node"],
+    "skipLibCheck": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true,
+    "customConditions": ["node"]
+  }
+}

package/vite.config.base.js

@@ -0,0 +1,74 @@
+import path from 'node:path';
+import tailwindcss from '@tailwindcss/vite';
+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 dts from 'vite-plugin-dts';
+
+export function createBaseConfig(dirname, options = {}) {
+  const { mode = 'app', libOptions = {} } = options;
+
+  const baseConfig = {
+    resolve: {
+      alias: {
+        '@': path.resolve(dirname, './src'),
+      },
+      extensions: [
+        '.mjs',
+        '.js',
+        '.mts',
+        '.ts',
+        '.jsx',
+        '.tsx',
+        '.json',
+        '.vue',
+      ],
+    },
+    plugins: [],
+  };
+
+  // App mode: 包含 Vue 全家桶
+  if (mode === 'app') {
+    baseConfig.plugins.push(
+      VueRouter({
+        dts: './src/typed-router.d.ts',
+      }),
+      vue(),
+      tailwindcss(),
+      AutoImport({
+        imports: ['vue', 'vue-router'],
+        dts: './src/auto-imports.d.ts',
+      }),
+      Components({
+        directoryAsNamespace: true,
+        dts: './src/components.d.ts',
+      }),
+    );
+  }
+
+  // Lib mode: 纯 TypeScript，用于打包库
+  if (mode === 'lib') {
+    // 添加 lib 构建配置
+    baseConfig.build = {
+      lib: {
+        entry: path.resolve(dirname, 'src/index.ts'),
+        formats: ['es'],
+        fileName: 'index',
+        ...libOptions.lib,
+      },
+    };
+
+    // 添加 dts 插件
+    baseConfig.plugins.push(
+      dts({
+        include: ['src/**/*.ts'],
+        exclude: libOptions.dtsExclude || [],
+        rollupTypes: true,
+        ...libOptions.dts,
+      }),
+    );
+  }
+
+  return baseConfig;
+}