codemap-vue
A Vue Single File Component (
.vue) indexer for CodeMap, distributed as an independent PyPI package.
What it captures
Backed by a small regex-based SFC scanner + tree-sitter:
| SFC block | Indexed | Backed by |
|---|---|---|
<template> |
❌ Ignored | — |
<script> (lang="js" / default) |
✅ | tree-sitter-javascript (required) |
<script> (lang="jsx") |
✅ | tree-sitter-javascript (required) |
<script> (lang="ts") |
✅ (with [typescript] extra) |
tree-sitter-typescript (optional) |
<script> (lang="tsx") |
✅ (with [typescript] extra) |
tree-sitter-typescript (optional) |
<script setup> (lang="ts") |
✅ (with [typescript] extra) |
tree-sitter-typescript (optional) |
<style> |
❌ Ignored | — |
Inside the <script> block, the same symbol kinds as codemap-javascript
and codemap-typescript are surfaced:
| AST node | Symbol kind |
|---|---|
function_declaration |
function |
class_declaration |
class |
method_definition (inside class) |
method |
Top-level const / let / var |
variable (with extra.vue_block_lang) |
Line numbers are translated back to the original .vue file coordinate
space, so codemap get jumps to the correct line even when the script
block starts hundreds of lines below <template>.
Install
# JavaScript-only Vue projects (no <script lang="ts">):
pip install codemap-vue
# Vue projects that use TypeScript in <script setup lang="ts"> (the
# Vue 3 default):
pip install "codemap-vue[typescript]"
tree-sitter-typescript is an optional dependency because some Vue
projects (Vue 2 codebases, JS-only sites) do not need it. When you index
a .vue file with <script lang="ts"> and the extra is not installed,
the plugin emits a VUE003 warning instead of crashing.
Implementation notes
tree-sitter-vue is not currently published on PyPI. Rather than
bundle a hand-compiled grammar, this plugin uses a permissive regex
scanner (codemap_vue.sfc.extract_script_blocks) to locate every
top-level <script> block in the SFC, read its lang= attribute, and
slice out the inner bytes. The inner bytes are then handed to the
appropriate tree-sitter grammar.
The scanner is intentionally permissive about malformed input: a
missing </script> closing tag still produces a block that runs to
EOF, so indexing partial / in-progress files still yields useful
symbols.
SymbolID encoding
scip-vue . . . src/components/UserList.vue/fetchUser().
└──────┘ └────────────────────────────────────────┘
scheme file → namespaces / type / method
Tests
pip install -e ".[dev]"
pytest
Limits / next steps
<template>contents (directives, expressions,v-onhandlers) are not parsed. A futurecodemap-vueminor release could expose declared template refs (<input ref="emailRef" />) anddefineProps/defineEmitsmacros as symbols.<script setup>macros (defineProps,defineExpose, …) are surfaced only when they appear as ordinary function calls inside a variable declaration. Treating them as first-class component-shape symbols is a v0.2.x improvement.- Class-based component decorators (vue-class-component / vue-property-decorator) are not yet captured.
License
MIT — same as the host project.
Metadata
Release files for codemap-vue 0.4.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| codemap_vue-0.4.10.tar.gz | 10.4 kB | With provenance | Details for codemap_vue-0.4.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| codemap_vue-0.4.10-py3-none-any.whl | Python 3 | none | any | Details for codemap_vue-0.4.10-py3-none-any.whl |
Total release size: 19.9 kB
Release files / codemap_vue-0.4.10.tar.gz
| Download URL | codemap_vue-0.4.10.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e47c78a40f364d1f015bcfc9ed283b80eefe71c0a391f3010b147c885851991d
|
|
BLAKE2b-256 checksum How to use checksums |
321f37faa5ae4bdcaaee2b15cb05f14aeadab93c2955e13b36072cfa8c068449
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logRelease files / codemap_vue-0.4.10-py3-none-any.whl
| Download URL | codemap_vue-0.4.10-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c85d6b3a02d8ebf1ab70818fe40a152aa2d5bedd862742a00383c553ba27c93d
|
|
BLAKE2b-256 checksum How to use checksums |
c604b90a1b5f9117067737cb048a56affca6a56d122f510e6b52a21ad005e4b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logSecurity for codemap-vue 0.4.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for codemap_vue-0.4.10.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.