feima-vite-plugins 0.0.1

package/README.md

@@ -0,0 +1,98 @@
+# feima-vite-plugins
+
+Vite 插件集合，提供多个实用的 Vite 插件。
+
+## 插件列表
+
+- `fvxeTableIdCheck` - FVxeTable ID 检查插件
+
+## 安装
+
+```bash
+npm install feima-vite-plugins
+# 或
+pnpm add feima-vite-plugins
+# 或
+yarn add feima-vite-plugins
+```
+
+## 使用
+
+### fvxeTableIdCheck
+
+在开发环境中自动检查 FVxeTable 组件的 ID 是否重复或包含中文。
+
+#### 功能
+
+- ✅ 检查 FVxeTable 组件的 `id` 属性是否重复
+- ✅ 检查 `id` 属性是否包含中文
+- ✅ 实时监听文件变化，自动更新检查结果
+- ✅ 在浏览器中显示错误覆盖层
+- ✅ 仅在开发环境生效
+
+#### 配置
+
+在 `vite.config.ts` 中引入并配置：
+
+```typescript
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { fvxeTableIdCheck } from 'feima-vite-plugins'
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    fvxeTableIdCheck()
+  ]
+})
+```
+
+#### 检查规则
+
+插件会扫描项目中所有 `.vue` 文件，查找以下格式的组件：
+
+```vue
+<f-vxe-table id="table1" />
+<!-- 或 -->
+<FVxeTable id="table1" />
+```
+
+**错误示例：**
+
+1. **ID 重复**：
+```vue
+<!-- 文件 A.vue -->
+<f-vxe-table id="table1" />
+
+<!-- 文件 B.vue -->
+<f-vxe-table id="table1" />  <!-- ❌ 错误：ID 重复 -->
+```
+
+2. **ID 包含中文**：
+```vue
+<f-vxe-table id="表格1" />  <!-- ❌ 错误：ID 不能包含中文 -->
+```
+
+#### 错误提示
+
+当检测到错误时，插件会：
+- 在控制台输出详细的错误信息
+- 在浏览器中显示错误覆盖层
+- 列出所有包含重复 ID 的文件路径
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 构建
+pnpm build
+
+# 发布前会自动构建
+pnpm publish
+```
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from "vite";
+export declare function fvxeTableIdCheck(): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,MAAM,CAAC;AAOlD,wBAAgB,gBAAgB,IAAI,MAAM,CAwIzC"}

package/dist/index.js

@@ -0,0 +1,118 @@
+import fs from "fs";
+import path from "path";
+const TABLE_REG = /<(f-vxe-table|FVxeTable)[^>]*\s+id\s*=\s*["']([^"']+)["'][^>]*>/g;
+export function fvxeTableIdCheck() {
+    const idMap = new Map();
+    let root = "";
+    let errorMsgs = [];
+    function containsChinese(str) {
+        return /[\u4e00-\u9fa5]/.test(str);
+    }
+    function clearFile(file) {
+        for (const [, files] of idMap) {
+            files.delete(file);
+        }
+    }
+    function collectFromFile(file) {
+        if (!file.endsWith(".vue"))
+            return;
+        const code = fs.readFileSync(file, "utf-8");
+        let match;
+        while ((match = TABLE_REG.exec(code))) {
+            const id = match[2];
+            if (containsChinese(id)) {
+                errorMsgs.push(`FVxeTable id 不能包含中文: "${id}"  (文件: ${path.relative(root, file)})`);
+                continue;
+            }
+            if (!idMap.has(id))
+                idMap.set(id, new Set());
+            idMap.get(id).add(file);
+        }
+    }
+    function showErrorOverlay(server, message) {
+        server.ws.send({
+            type: "error",
+            err: {
+                message,
+                stack: "",
+            },
+        });
+    }
+    function clearErrorOverlay(server) {
+        server.ws.send({ type: "full-reload" });
+    }
+    function report(server) {
+        let hasDuplicate = false;
+        let message = "";
+        if (errorMsgs.length) {
+            message += errorMsgs.join("\n") + "\n\n";
+        }
+        for (const [id, files] of idMap) {
+            if (files.size > 1) {
+                hasDuplicate = true;
+                message +=
+                    `FVxeTable id 重复: "${id}"\n` +
+                        [...files].map((f) => `  - ${path.relative(root, f)}`).join("\n") +
+                        "\n\n";
+            }
+        }
+        if ((hasDuplicate || errorMsgs.length) && server) {
+            console.error("\n🚨 " + message);
+            showErrorOverlay(server, message);
+        }
+        if (!hasDuplicate && errorMsgs.length === 0 && server) {
+            clearErrorOverlay(server);
+        }
+        errorMsgs = [];
+        return hasDuplicate || errorMsgs.length > 0;
+    }
+    function scanAll(dir) {
+        const entries = fs.readdirSync(dir, { withFileTypes: true });
+        for (const entry of entries) {
+            const full = path.join(dir, entry.name);
+            if (entry.isDirectory()) {
+                scanAll(full);
+            }
+            else if (full.endsWith(".vue")) {
+                collectFromFile(full);
+            }
+        }
+    }
+    return {
+        name: "vite-plugin-fvxe-table-id-check",
+        configResolved(config) {
+            root = config.root;
+        },
+        configureServer(server) {
+            // 仅在开发环境生效
+            if (process.env.NODE_ENV !== "development") {
+                return;
+            }
+            // 1️⃣ 启动时全量扫描
+            scanAll(path.join(root, "src"));
+            report(server);
+            // 2️⃣ 监听文件修改
+            server.watcher.on("change", (file) => {
+                if (!file.endsWith(".vue"))
+                    return;
+                clearFile(file);
+                collectFromFile(file);
+                report(server);
+            });
+            // 3️⃣ 监听新增文件
+            server.watcher.on("add", (file) => {
+                if (!file.endsWith(".vue"))
+                    return;
+                collectFromFile(file);
+                report(server);
+            });
+            // 4️⃣ 监听删除文件
+            server.watcher.on("unlink", (file) => {
+                if (!file.endsWith(".vue"))
+                    return;
+                clearFile(file);
+                report(server);
+            });
+        },
+    };
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "feima-vite-plugins",
+  "version": "0.0.1",
+  "description": "Vite 插件集合 - 包含 FVxeTable ID 检查插件",
+  "repository": {
+    "type": "git",
+    "url": "https://git.fmszh.com/feima/feima-vite-plugins.git"
+  },
+  "license": "ISC",
+  "author": "",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "fvxe-table",
+    "id-check"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "pnpm build"
+  },
+  "dependencies": {
+    "vite": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "vite": "^4.0.0 || ^5.0.0"
+  },
+  "packageManager": "pnpm@10.8.0+sha512.0e82714d1b5b43c74610193cb20734897c1d00de89d0e18420aebc5977fa13d780a9cb05734624e81ebd81cc876cd464794850641c48b9544326b5622ca29971"
+}