{"id":24063331,"url":"https://github.com/zcf0508/vue-scan","last_synced_at":"2026-04-01T16:34:28.217Z","repository":{"id":264824415,"uuid":"894363318","full_name":"zcf0508/vue-scan","owner":"zcf0508","description":"Flashing when components updating to troubleshoot performance issues.","archived":false,"fork":false,"pushed_at":"2026-03-13T11:01:01.000Z","size":372,"stargazers_count":272,"open_issues_count":1,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2026-03-13T22:59:59.412Z","etag":null,"topics":["javascript","vue"],"latest_commit_sha":null,"homepage":"https://discord.gg/Xdam3NGdH5","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zcf0508.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["antfu"],"ko_fi":"huali58081","custom":["https://afdian.com/a/huali08"]}},"created_at":"2024-11-26T08:21:27.000Z","updated_at":"2026-03-13T11:01:04.000Z","dependencies_parsed_at":"2026-03-13T13:07:28.430Z","dependency_job_id":null,"html_url":"https://github.com/zcf0508/vue-scan","commit_stats":null,"previous_names":["zcf0508/vue-scan"],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/zcf0508/vue-scan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcf0508%2Fvue-scan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcf0508%2Fvue-scan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcf0508%2Fvue-scan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcf0508%2Fvue-scan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zcf0508","download_url":"https://codeload.github.com/zcf0508/vue-scan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcf0508%2Fvue-scan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290531,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","vue"],"created_at":"2025-01-09T09:37:24.749Z","updated_at":"2026-04-01T16:34:28.208Z","avatar_url":"https://github.com/zcf0508.png","language":"TypeScript","readme":"# z-vue-scan\n\nA Vue scanning plugin that works with both Vue 2 and Vue 3. The component will flash with a red border when it will update.\n\n[![NPM version](https://img.shields.io/npm/v/z-vue-scan?color=a1b858\u0026label=)](https://www.npmjs.com/package/z-vue-scan)\n\n## Features\n\n- 🎯 Works with both Vue 2 and Vue 3\n- 🔄 Powered by [vue-demi](https://github.com/vueuse/vue-demi)\n- 📦 Lightweight\n- 💪 Written in TypeScript\n\n## Installation\n\n```bash\n# npm\nnpm install z-vue-scan\n\n# yarn\nyarn add z-vue-scan\n\n# pnpm\npnpm add z-vue-scan\n```\n\n## Usage\n\n```ts\ninterface Options {\n  enable?: boolean\n  hideCompnentName?: boolean\n}\n```\n\n### Vue 3\n\n```ts\n// vue3\nimport { createApp } from 'vue'\nimport VueScan, { type VueScanOptions } from 'z-vue-scan'\n\nimport App from './App.vue'\n\nconst isProduction = import.meta.env.PROD // or `process.env.NODE_ENV === 'production'`\n\nconst app = createApp(App)\n\nif (!isProduction) {\n  app.use\u003cVueScanOptions\u003e(VueScan, {})\n}\n\napp.mount('#app')\n```\n\n### Vue 2\n\n```ts\n// vue2\nimport Vue from 'vue'\nimport VueScan, { type VueScanBaseOptions } from 'z-vue-scan/vue2'\nimport App from './App.vue'\n\nconst isProduction = import.meta.env.PROD // or `process.env.NODE_ENV === 'production'`\n\nif (!isProduction) {\n  Vue.use\u003cVueScanBaseOptions\u003e(VueScan, {})\n}\n\nnew Vue({\n  render: h =\u003e h(App),\n}).$mount('#app')\n```\n\n### Nuxt Module\n\n```bash\n# npm\nnpm install z-vue-scan-nuxt-module\n\n# yarn\nyarn add z-vue-scan-nuxt-module\n\n# pnpm\npnpm add z-vue-scan-nuxt-module\n```\n\nYou can use z-vue-scan in your Nuxt project by adding it to the `modules` section in your `nuxt.config.ts`:\n\n```ts\nexport default defineNuxtConfig({\n  modules: ['z-vue-scan-nuxt-module'],\n  vueScan: {\n    // options\n    enable: true,\n    hideCompnentName: false\n  }\n})\n```\n\n### DevPilot Plugin (MCP for LLMs)\n\n```bash\npnpm add unplugin-devpilot devpilot-plugin-vue-scan -D\n```\n\nThe [DevPilot plugin](./packages/devpilot-plugin-vue-scan) exposes Vue component render performance data to LLMs via MCP. It tracks component re-renders in real time and provides a `queryVueScanData` tool that returns per-component aggregated summaries with source code locations — enabling LLMs to analyze render performance and pinpoint issues.\n\nSee [devpilot-plugin-vue-scan README](./packages/devpilot-plugin-vue-scan/README.md) for details.\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Run development server with Vue 3 example\npnpm dev\n\n# Run development server with Vue 2 example\npnpm dev:vue2\n\n# Build the package\npnpm build\n\n# Run type check\npnpm typecheck\n\n# Run linting\npnpm lint\n```\n\n## License\n\n[MIT](./LICENSE) License  2024 [zcf0508](https://github.com/zcf0508)\n","funding_links":["https://github.com/sponsors/antfu","https://ko-fi.com/huali58081","https://afdian.com/a/huali08"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcf0508%2Fvue-scan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzcf0508%2Fvue-scan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcf0508%2Fvue-scan/lists"}