vite-plugin-vue-template-inspector 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Leadgq
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # vite-plugin-vue-template-inspector
2
2
 
3
+ [GitHub](https://github.com/Leadgq/vite-plugin-vue-template-inspector)
4
+
3
5
  Vite 开发插件:在页面上 **Alt + 左键** 点击 Vue 模板节点,弹出源码路径,可复制或在本地编辑器中打开。
4
6
 
5
7
  仅在 `vite serve` 下生效,不会进入生产构建。
@@ -26,10 +28,22 @@ import vue from '@vitejs/plugin-vue'
26
28
  import { vueTemplateInspector } from 'vite-plugin-vue-template-inspector'
27
29
 
28
30
  export default defineConfig({
29
- plugins: [vueTemplateInspector(), vue()],
31
+ plugins: [
32
+ vueTemplateInspector({
33
+ enable: true,
34
+ // 命令名,或编辑器 exe 的绝对路径
35
+ start: 'code',
36
+ }),
37
+ vue(),
38
+ ],
30
39
  })
31
40
  ```
32
41
 
42
+ | 选项 | 默认 | 说明 |
43
+ | --- | --- | --- |
44
+ | `enable` | `true` | 为 `false` 时完全关闭插件 |
45
+ | `start` | 自动检测 | 传给 [launch-editor](https://github.com/yyx990803/launch-editor) 的编辑器。可用 `code`、`trae`、`webstorm` 等命令名;Windows 上若命令找不到,可改成 exe 绝对路径 |
46
+
33
47
  ## 本地调试
34
48
 
35
49
  ```bash
package/dist/client.js CHANGED
@@ -1 +1,36 @@
1
- "use strict";(()=>{const y=window.__VUE_INSPECTOR_CONFIG__||{},i=y.ATTR||"data-v-inspector",v=y.REQ_PATH||"/__vue-template-inspector/open-in-editor",g=Symbol.for("vue-template-inspector.initialized");if(window[g])return;window[g]=!0;const x=new WeakMap;let n=null;const s=t=>{if(!(t instanceof Element))return;const e=t.getAttribute(i);e&&(x.set(t,e),t.removeAttribute(i))},A=t=>{t instanceof Element&&(s(t),t.querySelectorAll("["+i+"]").forEach(s))},P=t=>{let e=t instanceof Element?t:null;for(;e;){if(x.has(e)||e.hasAttribute(i))return e;e=e.parentElement}return null},_=t=>{const e=x.get(t)||t.getAttribute(i);return t.hasAttribute(i)&&s(t),e};document.querySelectorAll("["+i+"]").forEach(s),new MutationObserver(t=>t.forEach(e=>{e.type==="attributes"?s(e.target):e.addedNodes.forEach(A)})).observe(document.documentElement,{attributes:!0,attributeFilter:[i],childList:!0,subtree:!0});const l=()=>{n?.remove(),n=null},R=async t=>{try{return await navigator.clipboard.writeText(t),!0}catch{const e=document.createElement("textarea");e.value=t,e.style.cssText="position:fixed;left:-9999px;opacity:0",document.body.appendChild(e),e.select();const a=document.execCommand("copy");return e.remove(),a}},L=async(t,e,a)=>{const f=new URLSearchParams({file:t,line:e,column:a}),r=await fetch(v+"?"+f,{method:"POST"});if(!r.ok)throw new Error(await r.text())};function M(t,e,a){l();const f=t.match(/^(.*):(\d+):(\d+)$/),[,r,E,T]=f||[null,t,"-","-"];n=document.createElement("div"),n.style.cssText="position:fixed;z-index:2147483647;max-width:min(520px,calc(100vw - 24px));padding:12px 14px;border-radius:8px;background:#111827;color:#f9fafb;font:13px/1.5 ui-sans-serif,system-ui,sans-serif;box-shadow:0 10px 30px rgba(0,0,0,.35)";const p=document.createElement("div");p.textContent=r,p.title=r,p.style.cssText="word-break:break-all;margin-bottom:10px;color:#e5e7eb";const b=document.createElement("div");b.style.cssText="display:flex;gap:8px;justify-content:flex-end";const h=document.createElement("div");h.style.cssText="display:flex;align-items:center;gap:6px;margin-right:auto";for(const o of["\u884C "+E,"\u5217 "+T]){const d=document.createElement("span");d.textContent=o,d.style.cssText="padding:2px 7px;border:1px solid #4b5563;border-radius:4px;background:#1f2937;color:#d1d5db;font-size:12px;white-space:nowrap",h.append(d)}const w=(o,d)=>{const m=document.createElement("button");return m.type="button",m.textContent=o,m.style.cssText=`cursor:pointer;border:0;border-radius:6px;padding:6px 10px;background:${d};color:#fff`,m},u=w("\u590D\u5236\u8DEF\u5F84","#2563eb"),c=w("\u6253\u5F00\u7F16\u8F91\u5668","#059669"),k=w("\u5173\u95ED","#374151");u.onclick=async o=>{o.stopPropagation(),u.textContent=await R(r)?"\u5DF2\u590D\u5236":"\u590D\u5236\u5931\u8D25",setTimeout(()=>{u.textContent="\u590D\u5236\u8DEF\u5F84"},1200)},c.onclick=async o=>{o.stopPropagation(),c.disabled=!0;try{await L(r,E,T),c.textContent="\u5DF2\u6253\u5F00"}catch{c.textContent="\u6253\u5F00\u5931\u8D25"}setTimeout(()=>{c.textContent="\u6253\u5F00\u7F16\u8F91\u5668",c.disabled=!1},1200)},k.onclick=o=>{o.stopPropagation(),l()},b.append(h,u,c,k),n.append(p,b),document.body.appendChild(n);const C=n.getBoundingClientRect();n.style.left=`${Math.min(Math.max(8,e+8),window.innerWidth-C.width-8)}px`,n.style.top=`${Math.min(Math.max(8,a+8),window.innerHeight-C.height-8)}px`}window.addEventListener("click",t=>{if(t.button!==0||!t.altKey)return;const e=P(t.target),a=e&&_(e);a&&(t.preventDefault(),t.stopPropagation(),M(a,t.clientX,t.clientY))},!0),window.addEventListener("keydown",t=>{t.key==="Escape"&&l()}),window.addEventListener("click",t=>{n&&!t.altKey&&!n.contains(t.target)&&l()})})();
1
+ "use strict";(()=>{const y=window.__VUE_INSPECTOR_CONFIG__||{},i=y.ATTR||"data-v-inspector",v=y.REQ_PATH||"/__vue-template-inspector/open-in-editor",g=Symbol.for("vue-template-inspector.initialized");if(window[g])return;window[g]=!0;const x=new WeakMap;let n=null;const s=t=>{if(!(t instanceof Element))return;const e=t.getAttribute(i);e&&(x.set(t,e),t.removeAttribute(i))},A=t=>{t instanceof Element&&(s(t),t.querySelectorAll("["+i+"]").forEach(s))},P=t=>{let e=t instanceof Element?t:null;for(;e;){if(x.has(e)||e.hasAttribute(i))return e;e=e.parentElement}return null},_=t=>{const e=x.get(t)||t.getAttribute(i);return t.hasAttribute(i)&&s(t),e};document.querySelectorAll("["+i+"]").forEach(s),new MutationObserver(t=>t.forEach(e=>{e.type==="attributes"?s(e.target):e.addedNodes.forEach(A)})).observe(document.documentElement,{attributes:!0,attributeFilter:[i],childList:!0,subtree:!0});const l=()=>{n?.remove(),n=null},R=async t=>{try{return await navigator.clipboard.writeText(t),!0}catch{const e=document.createElement("textarea");e.value=t,e.style.cssText="position:fixed;left:-9999px;opacity:0",document.body.appendChild(e),e.select();const a=document.execCommand("copy");return e.remove(),a}},L=async(t,e,a)=>{const f=new URLSearchParams({file:t,line:e,column:a}),r=await fetch(v+"?"+f,{method:"POST"});if(!r.ok)throw new Error(await r.text())};function M(t,e,a){l();const f=t.match(/^(.*):(\d+):(\d+)$/),[,r,E,T]=f||[null,t,"-","-"];n=document.createElement("div"),n.style.cssText=`
2
+ position:fixed;
3
+ z-index:2147483647;
4
+ max-width:min(520px,calc(100vw - 24px));
5
+ padding:12px 14px;
6
+ border-radius:8px;
7
+ background:#111827;
8
+ color:#f9fafb;
9
+ font:13px/1.5 ui-sans-serif,system-ui,sans-serif;
10
+ box-shadow:0 10px 30px rgba(0,0,0,.35);
11
+ `;const p=document.createElement("div");p.textContent=r,p.title=r,p.style.cssText=`
12
+ word-break:break-all;
13
+ margin-bottom:10px;
14
+ color:#e5e7eb;
15
+ `;const b=document.createElement("div");b.style.cssText=`
16
+ display:flex;
17
+ gap:8px;
18
+ justify-content:flex-end;
19
+ `;const h=document.createElement("div");h.style.cssText=`
20
+ display:flex;
21
+ align-items:center;
22
+ gap:6px;
23
+ margin-right:auto;
24
+ `;for(const o of["\u884C "+E,"\u5217 "+T]){const d=document.createElement("span");d.textContent=o,d.style.cssText=`padding:2px 7px;
25
+ border:1px solid #4b5563;
26
+ border-radius:4px;
27
+ background:#1f2937;
28
+ color:#d1d5db;
29
+ font-size:12px;
30
+ white-space:nowrap`,h.append(d)}const w=(o,d)=>{const m=document.createElement("button");return m.type="button",m.textContent=o,m.style.cssText=`cursor:pointer;
31
+ border:0;
32
+ border-radius:6px;
33
+ padding:6px 10px;
34
+ background:${d};
35
+ color:#fff;
36
+ `,m},u=w("\u590D\u5236\u8DEF\u5F84","#2563eb"),c=w("\u6253\u5F00\u7F16\u8F91\u5668","#059669"),k=w("\u5173\u95ED","#374151");u.onclick=async o=>{o.stopPropagation(),u.textContent=await R(r)?"\u5DF2\u590D\u5236":"\u590D\u5236\u5931\u8D25",setTimeout(()=>{u.textContent="\u590D\u5236\u8DEF\u5F84"},1200)},c.onclick=async o=>{o.stopPropagation(),c.disabled=!0;try{await L(r,E,T),c.textContent="\u5DF2\u6253\u5F00"}catch{c.textContent="\u6253\u5F00\u5931\u8D25"}setTimeout(()=>{c.textContent="\u6253\u5F00\u7F16\u8F91\u5668",c.disabled=!1},1200)},k.onclick=o=>{o.stopPropagation(),l()},b.append(h,u,c,k),n.append(p,b),document.body.appendChild(n);const C=n.getBoundingClientRect();n.style.left=`${Math.min(Math.max(8,e+8),window.innerWidth-C.width-8)}px`,n.style.top=`${Math.min(Math.max(8,a+8),window.innerHeight-C.height-8)}px`}window.addEventListener("click",t=>{if(t.button!==0||!t.altKey)return;const e=P(t.target),a=e&&_(e);a&&(t.preventDefault(),t.stopPropagation(),M(a,t.clientX,t.clientY))},!0),window.addEventListener("keydown",t=>{t.key==="Escape"&&l()}),window.addEventListener("click",t=>{n&&!t.altKey&&!n.contains(t.target)&&l()})})();
package/dist/index.d.ts CHANGED
@@ -1,5 +1,11 @@
1
1
  import { Plugin } from 'vite';
2
2
 
3
- declare function vueTemplateInspector(): Plugin;
3
+ interface VueTemplateInspectorOptions {
4
+ /** 是否启用,默认 true。为 false 时不注入属性、不挂编辑器中间件 */
5
+ enable?: boolean;
6
+ /** launch-editor 使用的编辑器:命令名(如 `code`、`trae`)或编辑器可执行文件的绝对路径 */
7
+ start?: string;
8
+ }
9
+ declare function vueTemplateInspector(options?: VueTemplateInspectorOptions): Plugin;
4
10
 
5
- export { vueTemplateInspector };
11
+ export { type VueTemplateInspectorOptions, vueTemplateInspector };
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
- import N from"fs";import a from"path";import C from"process";import{fileURLToPath as E}from"url";import{NodeTypes as f,parse as R}from"@vue/compiler-dom";import S from"launch-editor";import _ from"magic-string";import{parse as b}from"vue/compiler-sfc";var g="data-v-inspector",v="/__vue-template-inspector/open-in-editor",w=E(new URL("./client.js",import.meta.url));function d(n,e){for(let t of n)if(t.type===f.ELEMENT)e(t),d(t.children,e);else if(t.type===f.IF)for(let o of t.branches)d(o.children,e);else t.type===f.FOR&&d(t.children,e)}function I(n,e,t){let{descriptor:o}=b(n,{filename:e});if(!o.template)return null;let s=o.template,i=R(s.content),l=a.relative(t,e).replace(/\\/g,"/"),p=s.loc.start.line-1,c=s.loc.start.offset,m=new _(n),u=!1;return d(i.children,r=>{if(r.props.some(y=>y.type===f.ATTRIBUTE&&y.name===g))return;let h=r.loc.start.line+p,P=r.loc.start.column,$=c+r.loc.start.offset+1+r.tag.length;m.appendLeft($,` ${g}="${l}:${h}:${P}"`),u=!0}),u?{code:m.toString(),map:m.generateMap({source:e,includeContent:!0,hires:!0})}:null}function M(){let n=N.readFileSync(w,"utf8");return`<script>
2
- window.__VUE_INSPECTOR_CONFIG__=${JSON.stringify({ATTR:g,REQ_PATH:v}).replace(/</g,"\\u003c")};
3
- ${n};
4
- </script>`}function W(){let n=C.cwd();return{name:"vue-template-inspector",apply:"serve",enforce:"pre",configResolved(e){n=e.root},configureServer(e){e.middlewares.use((t,o,s)=>{if(!t.url)return s();let i=new URL(t.url,"http://localhost");if(i.pathname!==v)return s();if(t.method!=="POST"){o.statusCode=405,o.end("Method Not Allowed");return}let l=i.searchParams.get("file");if(!l){o.statusCode=400,o.end("Missing file");return}let p=a.resolve(n,l),c=a.relative(n,p);if(c===".."||c.startsWith(`..${a.sep}`)||a.isAbsolute(c)){o.statusCode=403,o.end("Forbidden");return}let u=Math.max(1,Number.parseInt(i.searchParams.get("line")??"",10)||1),r=Math.max(1,Number.parseInt(i.searchParams.get("column")??"",10)||1);S(`${p}:${u}:${r}`,void 0,(T,h)=>{console.error(`[vue-template-inspector] \u65E0\u6CD5\u6253\u5F00 ${T}: ${h}`)}),o.statusCode=204,o.end()})},transform(e,t){let o=t.split("?")[0]??t;if(!(t.includes("node_modules")||!o.endsWith(".vue")))return I(e,o,n)||void 0},transformIndexHtml(e){return e.replace("</body>",`${M()}</body>`)}}}export{W as vueTemplateInspector};
1
+ import S from"fs";import p from"path";import $ from"process";import{fileURLToPath as E}from"url";import{NodeTypes as h,parse as C}from"@vue/compiler-dom";import I from"launch-editor";import R from"magic-string";import{parse as O}from"vue/compiler-sfc";var v="data-v-inspector",N="/__vue-template-inspector/open-in-editor",_=E(new URL("./client.js",import.meta.url));function g(e,n){for(let o of e)if(o.type===h.ELEMENT)n(o),g(o.children,n);else if(o.type===h.IF)for(let l of o.branches)g(l.children,n);else o.type===h.FOR&&g(o.children,n)}function w(e,n,o){let{descriptor:l}=O(e,{filename:n});if(!l.template)return null;let i=l.template,r=C(i.content),s=p.relative(o,n).replace(/\\/g,"/"),t=i.loc.start.line-1,m=i.loc.start.offset,a=new R(e),u=!1;return g(r.children,c=>{if(c.props.some(d=>d.type===h.ATTRIBUTE&&d.name===v))return;let b=c.loc.start.line+t,T=c.loc.start.column,y=m+c.loc.start.offset+1+c.tag.length;a.appendLeft(y,` ${v}="${s}:${b}:${T}"`),u=!0}),u?{code:a.toString(),map:a.generateMap({source:n,includeContent:!0,hires:!0})}:null}function M(){let e=S.readFileSync(_,"utf8");return`<script>
2
+ window.__VUE_INSPECTOR_CONFIG__=${JSON.stringify({ATTR:v,REQ_PATH:N}).replace(/</g,"\\u003c")};
3
+ ${e};
4
+ </script>`}function A(e){if(e)return p.isAbsolute(e)?JSON.stringify(e):e}function W(e={}){let{enable:n=!0,start:o=""}=e,l=A(o),i=$.cwd();return n?{name:"vue-template-inspector",apply:"serve",enforce:"pre",configResolved(r){i=r.root},configureServer(r){r.middlewares.use((s,t,m)=>{if(!s.url)return m();let a=new URL(s.url,"http://localhost");if(a.pathname!==N)return m();if(s.method!=="POST"){t.statusCode=405,t.end("Method Not Allowed");return}let u=a.searchParams.get("file");if(!u){t.statusCode=400,t.end("Missing file");return}let c=p.resolve(i,u),f=p.relative(i,c);if(f===".."||f.startsWith(`..${p.sep}`)||p.isAbsolute(f)){t.statusCode=403,t.end("Forbidden");return}let T=Math.max(1,Number.parseInt(a.searchParams.get("line")??"",10)||1),y=Math.max(1,Number.parseInt(a.searchParams.get("column")??"",10)||1);I(`${c}:${T}:${y}`,l,(d,P)=>{console.error(`[vue-template-inspector] \u65E0\u6CD5\u6253\u5F00 ${d}: ${P}`)}),t.statusCode=204,t.end()})},transform(r,s){let t=s.split("?")[0]??s;if(!(s.includes("node_modules")||!t.endsWith(".vue")))return w(r,t,i)||void 0},transformIndexHtml(r){return r.replace("</body>",`${M()}</body>`)}}:{name:"vue-template-inspector",apply:"serve"}}export{W as vueTemplateInspector};
5
5
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fs from 'node:fs'\r\nimport path from 'node:path'\r\nimport process from 'node:process'\r\nimport { fileURLToPath } from 'node:url'\r\nimport { NodeTypes, parse as parseTemplate } from '@vue/compiler-dom'\r\nimport type { ElementNode, TemplateChildNode } from '@vue/compiler-dom'\r\nimport launchEditor from 'launch-editor'\r\nimport MagicString from 'magic-string'\r\nimport type { Plugin } from 'vite'\r\nimport { parse as parseSFC } from 'vue/compiler-sfc'\r\n\r\nconst ATTR = 'data-v-inspector'\r\nconst REQ_PATH = '/__vue-template-inspector/open-in-editor'\r\nconst clientScriptPath = fileURLToPath(new URL('./client.js', import.meta.url))\r\n\r\nfunction walkElements(nodes: TemplateChildNode[], visit: (el: ElementNode) => void) {\r\n for (const node of nodes) {\r\n if (node.type === NodeTypes.ELEMENT) {\r\n visit(node)\r\n walkElements(node.children, visit)\r\n } else if (node.type === NodeTypes.IF) {\r\n for (const branch of node.branches) walkElements(branch.children, visit)\r\n } else if (node.type === NodeTypes.FOR) {\r\n walkElements(node.children, visit)\r\n }\r\n }\r\n}\r\n\r\nfunction injectInspector(code: string, filename: string, root: string) {\r\n const { descriptor } = parseSFC(code, { filename })\r\n if (!descriptor.template) return null\r\n\r\n const template = descriptor.template\r\n const ast = parseTemplate(template.content)\r\n const rel = path.relative(root, filename).replace(/\\\\/g, '/')\r\n const lineOffset = template.loc.start.line - 1\r\n const templateOffset = template.loc.start.offset\r\n const magicString = new MagicString(code)\r\n let changed = false\r\n\r\n walkElements(ast.children, (el) => {\r\n const already = el.props.some(\r\n (prop) => prop.type === NodeTypes.ATTRIBUTE && prop.name === ATTR,\r\n )\r\n if (already) return\r\n const line = el.loc.start.line + lineOffset\r\n const column = el.loc.start.column\r\n const insertPosition = templateOffset + el.loc.start.offset + 1 + el.tag.length\r\n magicString.appendLeft(insertPosition, ` ${ATTR}=\"${rel}:${line}:${column}\"`)\r\n changed = true\r\n })\r\n\r\n if (!changed) return null\r\n return {\r\n code: magicString.toString(),\r\n map: magicString.generateMap({\r\n source: filename,\r\n includeContent: true,\r\n hires: true,\r\n }),\r\n }\r\n}\r\n\r\nfunction clientScript() {\r\n const clientCode = fs.readFileSync(clientScriptPath, 'utf8')\r\n const config = JSON.stringify({ ATTR, REQ_PATH }).replace(/</g, '\\\\u003c')\r\n return `<script>\r\n window.__VUE_INSPECTOR_CONFIG__=${config};\r\n ${clientCode};\r\n </script>`\r\n}\r\n\r\nexport function vueTemplateInspector(): Plugin {\r\n let root = process.cwd()\r\n\r\n return {\r\n name: 'vue-template-inspector',\r\n apply: 'serve',\r\n enforce: 'pre',\r\n configResolved(config) {\r\n root = config.root\r\n },\r\n configureServer(server) {\r\n server.middlewares.use((req, res, next) => {\r\n if (!req.url) return next()\r\n\r\n const url = new URL(req.url, 'http://localhost')\r\n if (url.pathname !== REQ_PATH) return next()\r\n\r\n if (req.method !== 'POST') {\r\n res.statusCode = 405\r\n res.end('Method Not Allowed')\r\n return\r\n }\r\n\r\n const file = url.searchParams.get('file')\r\n if (!file) {\r\n res.statusCode = 400\r\n res.end('Missing file')\r\n return\r\n }\r\n\r\n const absolutePath = path.resolve(root, file)\r\n const relativePath = path.relative(root, absolutePath)\r\n const outsideRoot =\r\n relativePath === '..' ||\r\n relativePath.startsWith(`..${path.sep}`) ||\r\n path.isAbsolute(relativePath)\r\n\r\n if (outsideRoot) {\r\n res.statusCode = 403\r\n res.end('Forbidden')\r\n return\r\n }\r\n\r\n const line = Math.max(1, Number.parseInt(url.searchParams.get('line') ?? '', 10) || 1)\r\n const column = Math.max(1, Number.parseInt(url.searchParams.get('column') ?? '', 10) || 1)\r\n\r\n launchEditor(`${absolutePath}:${line}:${column}`, undefined, (fileName, errorMessage) => {\r\n console.error(`[vue-template-inspector] 无法打开 ${fileName}: ${errorMessage}`)\r\n })\r\n res.statusCode = 204\r\n res.end()\r\n })\r\n },\r\n transform(code, id) {\r\n const filename = id.split('?')[0] ?? id\r\n if (id.includes('node_modules') || !filename.endsWith('.vue')) return\r\n return injectInspector(code, filename, root) || undefined\r\n },\r\n transformIndexHtml(html) {\r\n return html.replace('</body>', `${clientScript()}</body>`)\r\n },\r\n }\r\n}\r\n"],"mappings":"AAAA,OAAOA,MAAQ,KACf,OAAOC,MAAU,OACjB,OAAOC,MAAa,UACpB,OAAS,iBAAAC,MAAqB,MAC9B,OAAS,aAAAC,EAAW,SAASC,MAAqB,oBAElD,OAAOC,MAAkB,gBACzB,OAAOC,MAAiB,eAExB,OAAS,SAASC,MAAgB,mBAElC,IAAMC,EAAO,mBACPC,EAAW,2CACXC,EAAmBR,EAAc,IAAI,IAAI,cAAe,YAAY,GAAG,CAAC,EAE9E,SAASS,EAAaC,EAA4BC,EAAkC,CAClF,QAAWC,KAAQF,EACjB,GAAIE,EAAK,OAASX,EAAU,QAC1BU,EAAMC,CAAI,EACVH,EAAaG,EAAK,SAAUD,CAAK,UACxBC,EAAK,OAASX,EAAU,GACjC,QAAWY,KAAUD,EAAK,SAAUH,EAAaI,EAAO,SAAUF,CAAK,OAC9DC,EAAK,OAASX,EAAU,KACjCQ,EAAaG,EAAK,SAAUD,CAAK,CAGvC,CAEA,SAASG,EAAgBC,EAAcC,EAAkBC,EAAc,CACrE,GAAM,CAAE,WAAAC,CAAW,EAAIb,EAASU,EAAM,CAAE,SAAAC,CAAS,CAAC,EAClD,GAAI,CAACE,EAAW,SAAU,OAAO,KAEjC,IAAMC,EAAWD,EAAW,SACtBE,EAAMlB,EAAciB,EAAS,OAAO,EACpCE,EAAMvB,EAAK,SAASmB,EAAMD,CAAQ,EAAE,QAAQ,MAAO,GAAG,EACtDM,EAAaH,EAAS,IAAI,MAAM,KAAO,EACvCI,EAAiBJ,EAAS,IAAI,MAAM,OACpCK,EAAc,IAAIpB,EAAYW,CAAI,EACpCU,EAAU,GAcd,OAZAhB,EAAaW,EAAI,SAAWM,GAAO,CAIjC,GAHgBA,EAAG,MAAM,KACtBC,GAASA,EAAK,OAAS1B,EAAU,WAAa0B,EAAK,OAASrB,CAC/D,EACa,OACb,IAAMsB,EAAOF,EAAG,IAAI,MAAM,KAAOJ,EAC3BO,EAASH,EAAG,IAAI,MAAM,OACtBI,EAAiBP,EAAiBG,EAAG,IAAI,MAAM,OAAS,EAAIA,EAAG,IAAI,OACzEF,EAAY,WAAWM,EAAgB,IAAIxB,CAAI,KAAKe,CAAG,IAAIO,CAAI,IAAIC,CAAM,GAAG,EAC5EJ,EAAU,EACZ,CAAC,EAEIA,EACE,CACL,KAAMD,EAAY,SAAS,EAC3B,IAAKA,EAAY,YAAY,CAC3B,OAAQR,EACR,eAAgB,GAChB,MAAO,EACT,CAAC,CACH,EARqB,IASvB,CAEA,SAASe,GAAe,CACtB,IAAMC,EAAanC,EAAG,aAAaW,EAAkB,MAAM,EAE3D,MAAO;AAAA,wCADQ,KAAK,UAAU,CAAE,KAAAF,EAAM,SAAAC,CAAS,CAAC,EAAE,QAAQ,KAAM,SAAS,CAE7B;AAAA,QACtCyB,CAAU;AAAA,cAElB,CAEO,SAASC,GAA+B,CAC7C,IAAIhB,EAAOlB,EAAQ,IAAI,EAEvB,MAAO,CACL,KAAM,yBACN,MAAO,QACP,QAAS,MACT,eAAemC,EAAQ,CACrBjB,EAAOiB,EAAO,IAChB,EACA,gBAAgBC,EAAQ,CACtBA,EAAO,YAAY,IAAI,CAACC,EAAKC,EAAKC,IAAS,CACzC,GAAI,CAACF,EAAI,IAAK,OAAOE,EAAK,EAE1B,IAAMC,EAAM,IAAI,IAAIH,EAAI,IAAK,kBAAkB,EAC/C,GAAIG,EAAI,WAAahC,EAAU,OAAO+B,EAAK,EAE3C,GAAIF,EAAI,SAAW,OAAQ,CACzBC,EAAI,WAAa,IACjBA,EAAI,IAAI,oBAAoB,EAC5B,MACF,CAEA,IAAMG,EAAOD,EAAI,aAAa,IAAI,MAAM,EACxC,GAAI,CAACC,EAAM,CACTH,EAAI,WAAa,IACjBA,EAAI,IAAI,cAAc,EACtB,MACF,CAEA,IAAMI,EAAe3C,EAAK,QAAQmB,EAAMuB,CAAI,EACtCE,EAAe5C,EAAK,SAASmB,EAAMwB,CAAY,EAMrD,GAJEC,IAAiB,MACjBA,EAAa,WAAW,KAAK5C,EAAK,GAAG,EAAE,GACvCA,EAAK,WAAW4C,CAAY,EAEb,CACfL,EAAI,WAAa,IACjBA,EAAI,IAAI,WAAW,EACnB,MACF,CAEA,IAAMT,EAAO,KAAK,IAAI,EAAG,OAAO,SAASW,EAAI,aAAa,IAAI,MAAM,GAAK,GAAI,EAAE,GAAK,CAAC,EAC/EV,EAAS,KAAK,IAAI,EAAG,OAAO,SAASU,EAAI,aAAa,IAAI,QAAQ,GAAK,GAAI,EAAE,GAAK,CAAC,EAEzFpC,EAAa,GAAGsC,CAAY,IAAIb,CAAI,IAAIC,CAAM,GAAI,OAAW,CAACc,EAAUC,IAAiB,CACvF,QAAQ,MAAM,qDAAiCD,CAAQ,KAAKC,CAAY,EAAE,CAC5E,CAAC,EACDP,EAAI,WAAa,IACjBA,EAAI,IAAI,CACV,CAAC,CACH,EACA,UAAUtB,EAAM8B,EAAI,CAClB,IAAM7B,EAAW6B,EAAG,MAAM,GAAG,EAAE,CAAC,GAAKA,EACrC,GAAI,EAAAA,EAAG,SAAS,cAAc,GAAK,CAAC7B,EAAS,SAAS,MAAM,GAC5D,OAAOF,EAAgBC,EAAMC,EAAUC,CAAI,GAAK,MAClD,EACA,mBAAmB6B,EAAM,CACvB,OAAOA,EAAK,QAAQ,UAAW,GAAGf,EAAa,CAAC,SAAS,CAC3D,CACF,CACF","names":["fs","path","process","fileURLToPath","NodeTypes","parseTemplate","launchEditor","MagicString","parseSFC","ATTR","REQ_PATH","clientScriptPath","walkElements","nodes","visit","node","branch","injectInspector","code","filename","root","descriptor","template","ast","rel","lineOffset","templateOffset","magicString","changed","el","prop","line","column","insertPosition","clientScript","clientCode","vueTemplateInspector","config","server","req","res","next","url","file","absolutePath","relativePath","fileName","errorMessage","id","html"]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import fs from 'node:fs'\r\nimport path from 'node:path'\r\nimport process from 'node:process'\r\nimport { fileURLToPath } from 'node:url'\r\nimport { NodeTypes, parse as parseTemplate } from '@vue/compiler-dom'\r\nimport type { ElementNode, TemplateChildNode } from '@vue/compiler-dom'\r\nimport launchEditor from 'launch-editor'\r\nimport MagicString from 'magic-string'\r\nimport type { Plugin } from 'vite'\r\nimport { parse as parseSFC } from 'vue/compiler-sfc'\r\n\r\nconst ATTR = 'data-v-inspector'\r\nconst REQ_PATH = '/__vue-template-inspector/open-in-editor'\r\nconst clientScriptPath = fileURLToPath(new URL('./client.js', import.meta.url))\r\n\r\nfunction walkElements(nodes: TemplateChildNode[], visit: (el: ElementNode) => void) {\r\n for (const node of nodes) {\r\n if (node.type === NodeTypes.ELEMENT) {\r\n visit(node)\r\n walkElements(node.children, visit)\r\n } else if (node.type === NodeTypes.IF) {\r\n for (const branch of node.branches) walkElements(branch.children, visit)\r\n } else if (node.type === NodeTypes.FOR) {\r\n walkElements(node.children, visit)\r\n }\r\n }\r\n}\r\n\r\nfunction injectInspector(code: string, filename: string, root: string) {\r\n const { descriptor } = parseSFC(code, { filename })\r\n if (!descriptor.template) return null\r\n\r\n const template = descriptor.template\r\n const ast = parseTemplate(template.content)\r\n const rel = path.relative(root, filename).replace(/\\\\/g, '/')\r\n const lineOffset = template.loc.start.line - 1\r\n const templateOffset = template.loc.start.offset\r\n const magicString = new MagicString(code)\r\n let changed = false\r\n\r\n walkElements(ast.children, (el) => {\r\n const already = el.props.some(\r\n (prop) => prop.type === NodeTypes.ATTRIBUTE && prop.name === ATTR,\r\n )\r\n if (already) return\r\n const line = el.loc.start.line + lineOffset\r\n const column = el.loc.start.column\r\n const insertPosition = templateOffset + el.loc.start.offset + 1 + el.tag.length\r\n magicString.appendLeft(insertPosition, ` ${ATTR}=\"${rel}:${line}:${column}\"`)\r\n changed = true\r\n })\r\n\r\n if (!changed) return null\r\n return {\r\n code: magicString.toString(),\r\n map: magicString.generateMap({\r\n source: filename,\r\n includeContent: true,\r\n hires: true,\r\n }),\r\n }\r\n}\r\n\r\nfunction clientScript() {\r\n const clientCode = fs.readFileSync(clientScriptPath, 'utf8')\r\n const config = JSON.stringify({ ATTR, REQ_PATH }).replace(/</g, '\\\\u003c')\r\n return `<script>\r\n window.__VUE_INSPECTOR_CONFIG__=${config};\r\n ${clientCode};\r\n </script>`\r\n}\r\n\r\nexport interface VueTemplateInspectorOptions {\r\n /** 是否启用,默认 true。为 false 时不注入属性、不挂编辑器中间件 */\r\n enable?: boolean\r\n /** launch-editor 使用的编辑器:命令名(如 `code`、`trae`)或编辑器可执行文件的绝对路径 */\r\n start?: string\r\n}\r\n\r\nfunction normalizeEditorStart(start: string | undefined) {\r\n if (!start) return undefined\r\n return path.isAbsolute(start) ? JSON.stringify(start) : start\r\n}\r\n\r\nexport function vueTemplateInspector(options: VueTemplateInspectorOptions = {}): Plugin {\r\n const { enable = true, start = '' } = options\r\n const editor = normalizeEditorStart(start)\r\n let root = process.cwd()\r\n\r\n if (!enable) {\r\n return {\r\n name: 'vue-template-inspector',\r\n apply: 'serve',\r\n }\r\n }\r\n\r\n return {\r\n name: 'vue-template-inspector',\r\n apply: 'serve',\r\n enforce: 'pre',\r\n configResolved(config) {\r\n root = config.root\r\n },\r\n configureServer(server) {\r\n server.middlewares.use((req, res, next) => {\r\n if (!req.url) return next()\r\n\r\n const url = new URL(req.url, 'http://localhost')\r\n if (url.pathname !== REQ_PATH) return next()\r\n\r\n if (req.method !== 'POST') {\r\n res.statusCode = 405\r\n res.end('Method Not Allowed')\r\n return\r\n }\r\n\r\n const file = url.searchParams.get('file')\r\n if (!file) {\r\n res.statusCode = 400\r\n res.end('Missing file')\r\n return\r\n }\r\n\r\n const absolutePath = path.resolve(root, file)\r\n const relativePath = path.relative(root, absolutePath)\r\n const outsideRoot =\r\n relativePath === '..' ||\r\n relativePath.startsWith(`..${path.sep}`) ||\r\n path.isAbsolute(relativePath)\r\n\r\n if (outsideRoot) {\r\n res.statusCode = 403\r\n res.end('Forbidden')\r\n return\r\n }\r\n\r\n const line = Math.max(1, Number.parseInt(url.searchParams.get('line') ?? '', 10) || 1)\r\n const column = Math.max(1, Number.parseInt(url.searchParams.get('column') ?? '', 10) || 1)\r\n\r\n launchEditor(`${absolutePath}:${line}:${column}`, editor, (fileName, errorMessage) => {\r\n console.error(`[vue-template-inspector] 无法打开 ${fileName}: ${errorMessage}`)\r\n })\r\n res.statusCode = 204\r\n res.end()\r\n })\r\n },\r\n transform(code, id) {\r\n const filename = id.split('?')[0] ?? id\r\n if (id.includes('node_modules') || !filename.endsWith('.vue')) return\r\n return injectInspector(code, filename, root) || undefined\r\n },\r\n transformIndexHtml(html) {\r\n return html.replace('</body>', `${clientScript()}</body>`)\r\n },\r\n }\r\n}\r\n"],"mappings":"AAAA,OAAOA,MAAQ,KACf,OAAOC,MAAU,OACjB,OAAOC,MAAa,UACpB,OAAS,iBAAAC,MAAqB,MAC9B,OAAS,aAAAC,EAAW,SAASC,MAAqB,oBAElD,OAAOC,MAAkB,gBACzB,OAAOC,MAAiB,eAExB,OAAS,SAASC,MAAgB,mBAElC,IAAMC,EAAO,mBACPC,EAAW,2CACXC,EAAmBR,EAAc,IAAI,IAAI,cAAe,YAAY,GAAG,CAAC,EAE9E,SAASS,EAAaC,EAA4BC,EAAkC,CAClF,QAAWC,KAAQF,EACjB,GAAIE,EAAK,OAASX,EAAU,QAC1BU,EAAMC,CAAI,EACVH,EAAaG,EAAK,SAAUD,CAAK,UACxBC,EAAK,OAASX,EAAU,GACjC,QAAWY,KAAUD,EAAK,SAAUH,EAAaI,EAAO,SAAUF,CAAK,OAC9DC,EAAK,OAASX,EAAU,KACjCQ,EAAaG,EAAK,SAAUD,CAAK,CAGvC,CAEA,SAASG,EAAgBC,EAAcC,EAAkBC,EAAc,CACrE,GAAM,CAAE,WAAAC,CAAW,EAAIb,EAASU,EAAM,CAAE,SAAAC,CAAS,CAAC,EAClD,GAAI,CAACE,EAAW,SAAU,OAAO,KAEjC,IAAMC,EAAWD,EAAW,SACtBE,EAAMlB,EAAciB,EAAS,OAAO,EACpCE,EAAMvB,EAAK,SAASmB,EAAMD,CAAQ,EAAE,QAAQ,MAAO,GAAG,EACtDM,EAAaH,EAAS,IAAI,MAAM,KAAO,EACvCI,EAAiBJ,EAAS,IAAI,MAAM,OACpCK,EAAc,IAAIpB,EAAYW,CAAI,EACpCU,EAAU,GAcd,OAZAhB,EAAaW,EAAI,SAAWM,GAAO,CAIjC,GAHgBA,EAAG,MAAM,KACtBC,GAASA,EAAK,OAAS1B,EAAU,WAAa0B,EAAK,OAASrB,CAC/D,EACa,OACb,IAAMsB,EAAOF,EAAG,IAAI,MAAM,KAAOJ,EAC3BO,EAASH,EAAG,IAAI,MAAM,OACtBI,EAAiBP,EAAiBG,EAAG,IAAI,MAAM,OAAS,EAAIA,EAAG,IAAI,OACzEF,EAAY,WAAWM,EAAgB,IAAIxB,CAAI,KAAKe,CAAG,IAAIO,CAAI,IAAIC,CAAM,GAAG,EAC5EJ,EAAU,EACZ,CAAC,EAEIA,EACE,CACL,KAAMD,EAAY,SAAS,EAC3B,IAAKA,EAAY,YAAY,CAC3B,OAAQR,EACR,eAAgB,GAChB,MAAO,EACT,CAAC,CACH,EARqB,IASvB,CAEA,SAASe,GAAe,CACtB,IAAMC,EAAanC,EAAG,aAAaW,EAAkB,MAAM,EAE3D,MAAO;AAAA,wCADQ,KAAK,UAAU,CAAE,KAAAF,EAAM,SAAAC,CAAS,CAAC,EAAE,QAAQ,KAAM,SAAS,CAE7B;AAAA,QACtCyB,CAAU;AAAA,cAElB,CASA,SAASC,EAAqBC,EAA2B,CACvD,GAAKA,EACL,OAAOpC,EAAK,WAAWoC,CAAK,EAAI,KAAK,UAAUA,CAAK,EAAIA,CAC1D,CAEO,SAASC,EAAqBC,EAAuC,CAAC,EAAW,CACtF,GAAM,CAAE,OAAAC,EAAS,GAAM,MAAAH,EAAQ,EAAG,EAAIE,EAChCE,EAASL,EAAqBC,CAAK,EACrCjB,EAAOlB,EAAQ,IAAI,EAEvB,OAAKsC,EAOE,CACL,KAAM,yBACN,MAAO,QACP,QAAS,MACT,eAAeE,EAAQ,CACrBtB,EAAOsB,EAAO,IAChB,EACA,gBAAgBC,EAAQ,CACtBA,EAAO,YAAY,IAAI,CAACC,EAAKC,EAAKC,IAAS,CACzC,GAAI,CAACF,EAAI,IAAK,OAAOE,EAAK,EAE1B,IAAMC,EAAM,IAAI,IAAIH,EAAI,IAAK,kBAAkB,EAC/C,GAAIG,EAAI,WAAarC,EAAU,OAAOoC,EAAK,EAE3C,GAAIF,EAAI,SAAW,OAAQ,CACzBC,EAAI,WAAa,IACjBA,EAAI,IAAI,oBAAoB,EAC5B,MACF,CAEA,IAAMG,EAAOD,EAAI,aAAa,IAAI,MAAM,EACxC,GAAI,CAACC,EAAM,CACTH,EAAI,WAAa,IACjBA,EAAI,IAAI,cAAc,EACtB,MACF,CAEA,IAAMI,EAAehD,EAAK,QAAQmB,EAAM4B,CAAI,EACtCE,EAAejD,EAAK,SAASmB,EAAM6B,CAAY,EAMrD,GAJEC,IAAiB,MACjBA,EAAa,WAAW,KAAKjD,EAAK,GAAG,EAAE,GACvCA,EAAK,WAAWiD,CAAY,EAEb,CACfL,EAAI,WAAa,IACjBA,EAAI,IAAI,WAAW,EACnB,MACF,CAEA,IAAMd,EAAO,KAAK,IAAI,EAAG,OAAO,SAASgB,EAAI,aAAa,IAAI,MAAM,GAAK,GAAI,EAAE,GAAK,CAAC,EAC/Ef,EAAS,KAAK,IAAI,EAAG,OAAO,SAASe,EAAI,aAAa,IAAI,QAAQ,GAAK,GAAI,EAAE,GAAK,CAAC,EAEzFzC,EAAa,GAAG2C,CAAY,IAAIlB,CAAI,IAAIC,CAAM,GAAIS,EAAQ,CAACU,EAAUC,IAAiB,CACpF,QAAQ,MAAM,qDAAiCD,CAAQ,KAAKC,CAAY,EAAE,CAC5E,CAAC,EACDP,EAAI,WAAa,IACjBA,EAAI,IAAI,CACV,CAAC,CACH,EACA,UAAU3B,EAAMmC,EAAI,CAClB,IAAMlC,EAAWkC,EAAG,MAAM,GAAG,EAAE,CAAC,GAAKA,EACrC,GAAI,EAAAA,EAAG,SAAS,cAAc,GAAK,CAAClC,EAAS,SAAS,MAAM,GAC5D,OAAOF,EAAgBC,EAAMC,EAAUC,CAAI,GAAK,MAClD,EACA,mBAAmBkC,EAAM,CACvB,OAAOA,EAAK,QAAQ,UAAW,GAAGpB,EAAa,CAAC,SAAS,CAC3D,CACF,EAhES,CACL,KAAM,yBACN,MAAO,OACT,CA8DJ","names":["fs","path","process","fileURLToPath","NodeTypes","parseTemplate","launchEditor","MagicString","parseSFC","ATTR","REQ_PATH","clientScriptPath","walkElements","nodes","visit","node","branch","injectInspector","code","filename","root","descriptor","template","ast","rel","lineOffset","templateOffset","magicString","changed","el","prop","line","column","insertPosition","clientScript","clientCode","normalizeEditorStart","start","vueTemplateInspector","options","enable","editor","config","server","req","res","next","url","file","absolutePath","relativePath","fileName","errorMessage","id","html"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vite-plugin-vue-template-inspector",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Vite plugin: Alt+click Vue template elements to copy the source path or open it in your editor.",
5
5
  "keywords": [
6
6
  "vite",
@@ -10,6 +10,15 @@
10
10
  "devtools"
11
11
  ],
12
12
  "license": "MIT",
13
+ "author": "Leadgq",
14
+ "homepage": "https://github.com/Leadgq/vite-plugin-vue-template-inspector#readme",
15
+ "bugs": {
16
+ "url": "https://github.com/Leadgq/vite-plugin-vue-template-inspector/issues"
17
+ },
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "git+https://github.com/Leadgq/vite-plugin-vue-template-inspector.git"
21
+ },
13
22
  "type": "module",
14
23
  "files": [
15
24
  "dist"