feat: 新增 plugin/ 插件化形态(funjia.print-tag)+ 可选 SN 条码/二维码
把本工程的标签排版能力改造成 FunjiaUI 远端插件,放进 plugin/ 子目录, 与原独立 Web 版并存(两者功能一致,模板/版面/打印行为逐项对齐)。 - 入口从 createApp().mount() 改为 activate(ctx) + ctx.addRoute,注册 1 菜单 / 1 路由 / 2 命令 - 11 个模板的渲染收敛成 SpecTag,差异集中到 templates/registry.ts(字段/选项/默认值原样保留) - 店铺名 / 电话从写死改为可配置,记忆在插件私有存储 - 内置二维码图片改为打包 data URL —— 远端插件没有自己的 public/ - 去掉 @headlessui/vue(换原生 select)与 Tailwind,样式类名统一 pt- 前缀避免污染宿主 - 可选接入宿主 api::sn-code:按 SN 生成真 Code 128 条码与可扫二维码; 关闭时(默认)完全保持原静态二维码行为。领码优先贴到已排版的格子,不够才新建 - 新增 commands: print-tag:issue-sn / print-tag:render-svg(后者纯本地出图,供其它插件复用) - code128.ts 实现真 Code 128 Set B(含校验位);二维码走 qrcode-generator(真 QR) - 自带本地预览器(preview/mock-api.ts 补了 /api/sn-codes mock)与 deploy / verify 脚本 - verify.mjs 修掉一处误报:源码边界判据改为「解析后是否逃出工程根」, 而不是「说明符是否以 .. 开头」(后者会把 src/components/X.vue → ../codes 误判为越界) 已发布到插件仓库:funjia.print-tag@1.0.0
This commit is contained in:
@@ -0,0 +1,172 @@
|
||||
/**
|
||||
* 预览服务器配置(`npm run dev` / `npm run preview`)。
|
||||
*
|
||||
* ## 与 `vite.config.ts` 的分工
|
||||
*
|
||||
* | 配置 | 干什么 | 形态 |
|
||||
* | ---- | ------ | ---- |
|
||||
* | `vite.config.ts` | **构建**产物 | lib 模式,`vue` / `funjiaui` 必须 external |
|
||||
* | `vite.preview.config.ts` | **预览**插件 | 应用模式,root 指向 `preview/` |
|
||||
*
|
||||
* 两者不能合并。构建时必须把 `vue` external 掉,产物才能交给宿主的 Vue 跑;
|
||||
* 而预览时必须把 `vue` 真正打进来,页面才能渲染。同一个 Vite 进程做不到两种
|
||||
* 相反的依赖策略,所以分两个配置 —— 这也是为什么 `npm run build` 与
|
||||
* `npm run dev` 用的是不同的配置文件。
|
||||
*
|
||||
* ## 预览服务器多了什么
|
||||
*
|
||||
* 两个中间件,都是为了让「预览」尽量接近「真宿主」:
|
||||
*
|
||||
* 1. **静态中间件**:把 `/artifact/<文件名>` 映射到工程的 `dist/`。
|
||||
* 产物模式(`npm run preview`)要靠它按**真实 URL** 加载产物 ——
|
||||
* IIFE 走 `<script src>`、ESM 走 `import()`,和宿主装载时是同一套路径规则。
|
||||
* 2. **`/api` 后端**:见下。
|
||||
*
|
||||
* ## `/api` 从哪来(这就是「预览里能不能调接口」的答案)
|
||||
*
|
||||
* | 情况 | `/api/**` 去哪 | 什么时候用 |
|
||||
* | ---- | ------------- | ---------- |
|
||||
* | 默认 | 内置 mock 后端(`preview/mock-api.ts`) | 平时开发:不依赖任何外部服务,`ctx.http` 立刻有数据 |
|
||||
* | 设了 `PREVIEW_API_TARGET` | **代理到那个地址** | 真后端(或宿主的 dev server)已经起来了,想连它调 |
|
||||
*
|
||||
* ```bash
|
||||
* # 连本机跑着的宿主 dev server(它有完整的 /api mock)
|
||||
* PREVIEW_API_TARGET=http://127.0.0.1:5180 npm run dev
|
||||
* ```
|
||||
*
|
||||
* 走代理而不是让页面直连,是为了**绕开跨域**:浏览器眼里请求始终是发给
|
||||
* `127.0.0.1:5310` 的同源请求,CORS 与 Cookie 的 SameSite 规则都不会插一脚。
|
||||
* 这与宿主里 dev 阶段的代理做法是同一个套路。
|
||||
*
|
||||
* ⚠️ 两个后端给出的数据**不会一致**:内置 mock 是几个固定行,
|
||||
* 宿主 mock 有它自己那套种子数据。别拿预览看到的数据去对宿主的账。
|
||||
*/
|
||||
|
||||
import { defineConfig } from "vite";
|
||||
import type { Plugin } from "vite";
|
||||
import vue from "@vitejs/plugin-vue";
|
||||
import { createReadStream, existsSync, statSync } from "node:fs";
|
||||
import { extname, resolve, sep } from "node:path";
|
||||
import { createPreviewApi } from "./preview/mock-api";
|
||||
|
||||
const projectRoot = __dirname;
|
||||
/** 预览页的根目录:`/` 就是工程里的 `preview/` */
|
||||
const previewRoot = resolve(projectRoot, "preview");
|
||||
/** 构建产物目录(`vite.config.ts` 里 `outDir` 指的是同一处) */
|
||||
const artifactDir = resolve(projectRoot, "dist");
|
||||
|
||||
/**
|
||||
* 真后端地址。**设了就停用内置 mock**,把 `/api/**` 整个转过去。
|
||||
*
|
||||
* 只认 `http://` / `https://` 开头的值:写错了(比如少个协议)就直接忽略并
|
||||
* 在内置 mock 的响应里说明,而不是让 Vite 的 proxy 在启动时报一句难懂的话。
|
||||
* 一个空的/半截的配置是这里最容易犯的错。
|
||||
*/
|
||||
const apiTarget = (process.env.PREVIEW_API_TARGET || "").trim();
|
||||
const hasApiTarget = /^https?:\/\//i.test(apiTarget);
|
||||
|
||||
/** 端口。刻意避开宿主链路上的三个端口,这样插件预览、宿主 dev、插件仓库可以同时开着 */
|
||||
const PREVIEW_PORT = 5310;
|
||||
|
||||
const MIME: Record<string, string> = {
|
||||
".js": "text/javascript; charset=utf-8",
|
||||
".mjs": "text/javascript; charset=utf-8",
|
||||
".css": "text/css; charset=utf-8",
|
||||
".json": "application/json; charset=utf-8",
|
||||
".map": "application/json; charset=utf-8",
|
||||
};
|
||||
|
||||
/**
|
||||
* `/artifact/*` → `dist/*`。
|
||||
*
|
||||
* 不把这个目录放进 `publicDir` 是有意的:`publicDir` 里的东西会被当作
|
||||
* 工程的静态资源被 Vite 处理(比如 ts 会被转译、import 会被重写),
|
||||
* 而产物必须**原样**送出 —— 预览的意义就在于看到「浏览器拿到的那几个字节」。
|
||||
*/
|
||||
function artifactServer(): Plugin {
|
||||
return {
|
||||
name: "preview:artifact-server",
|
||||
configureServer(server) {
|
||||
server.middlewares.use((req, res, next) => {
|
||||
const url = (req.url || "").split("?")[0];
|
||||
if (!url.startsWith("/artifact/")) return next();
|
||||
|
||||
const rel = decodeURIComponent(url.slice("/artifact/".length));
|
||||
const file = resolve(artifactDir, rel);
|
||||
|
||||
// 路径穿越防护:解析之后再确认仍在 dist 内,比过滤 ".." 字符串可靠
|
||||
if (file !== artifactDir && !file.startsWith(artifactDir + sep)) {
|
||||
res.statusCode = 403;
|
||||
res.end("forbidden");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!existsSync(file) || !statSync(file).isFile()) {
|
||||
// 给出可执行的下一步,而不是一个干巴巴的 404 —— 这是预览时最常见的卡点
|
||||
res.statusCode = 404;
|
||||
res.setHeader("Content-Type", "text/plain; charset=utf-8");
|
||||
res.end(`产物不存在:dist/${rel}\n跑一次 npm run build(npm run preview 会自动先构建)。\n`);
|
||||
return;
|
||||
}
|
||||
|
||||
res.setHeader("Content-Type", MIME[extname(file)] || "application/octet-stream");
|
||||
// 开发期不缓存:否则改了产物刷新页面还是旧的,会误判成「构建没生效」
|
||||
res.setHeader("Cache-Control", "no-store");
|
||||
createReadStream(file).pipe(res);
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* 内置的 `/api` 后端。
|
||||
*
|
||||
* 只在**没有**配 `PREVIEW_API_TARGET` 时装上。这个判断不能省:
|
||||
* Vite 的 proxy 中间件排在所有插件中间件**之后**(插件 `configureServer`
|
||||
* 是前置钩子,proxy 是内部中间件),所以内置 mock 一旦装上就会**抢在代理前面**
|
||||
* 把 `/api/**` 全部吃掉 —— 于是「配了真后端地址却还是 mock 数据」,
|
||||
* 而且看不出原因。宁可在这里少装一个中间件。
|
||||
*/
|
||||
function apiServer(): Plugin {
|
||||
return {
|
||||
name: "preview:api-server",
|
||||
configureServer(server) {
|
||||
if (hasApiTarget) {
|
||||
server.config.logger.info(
|
||||
`\n \x1b[36m[preview]\x1b[0m /api → 代理到 ${apiTarget}(内置 mock 已停用)\n`
|
||||
);
|
||||
return;
|
||||
}
|
||||
server.config.logger.info(
|
||||
"\n \x1b[36m[preview]\x1b[0m /api → 内置 mock 后端(preview/mock-api.ts;" +
|
||||
"连真后端设 PREVIEW_API_TARGET=http://host:port)\n"
|
||||
);
|
||||
server.middlewares.use(createPreviewApi());
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export default defineConfig({
|
||||
root: previewRoot,
|
||||
plugins: [vue(), artifactServer(), apiServer()],
|
||||
resolve: {
|
||||
// element-plus 会带上自己依赖的 vue,dedupe 保证全站只有一份 Vue 实例
|
||||
dedupe: ["vue"],
|
||||
},
|
||||
optimizeDeps: {
|
||||
// 预先打包,避免首屏「发现新依赖 → 重新预构建 → 整页刷新」的抖动
|
||||
include: ["vue", "element-plus", "@element-plus/icons-vue"],
|
||||
},
|
||||
server: {
|
||||
host: "127.0.0.1",
|
||||
port: PREVIEW_PORT,
|
||||
// 预览页要 import 工程根下的 ../src/**。默认的 allow 列表不一定覆盖到,
|
||||
// 显式放行工程根,否则会被 dev server 的文件服务策略拦掉
|
||||
fs: { allow: [projectRoot] },
|
||||
// 只有配了合法地址才装代理。路径**原样转发**(不剥掉 /api),
|
||||
// 这样后端的挂载点与生产环境一致,不用为预览额外加一条重写规则
|
||||
...(hasApiTarget
|
||||
? { proxy: { "/api": { target: apiTarget, changeOrigin: true } } }
|
||||
: {}),
|
||||
},
|
||||
});
|
||||
Reference in New Issue
Block a user