Skip to main content

JavaScript / JSX indexer plugin for CodeMap (https://github.com/qxbyte/codemap)

Project description

codemap-javascript

A JavaScript / JSX indexer for CodeMap, distributed as an independent PyPI package.

What this package covers

Extension Grammar Notes
.js tree-sitter-javascript Plain JavaScript
.jsx tree-sitter-javascript React-style JSX (the grammar handles JSX natively)
.mjs tree-sitter-javascript ES module
.cjs tree-sitter-javascript CommonJS module

A single grammar instance handles all four extensions — .jsx is not a separate grammar in tree-sitter-javascript.

Install

pip install codemap-javascript

After installation, codemap doctor lists javascript alongside the built-in indexers (ADR-004 + ADR-L001).

What it captures

Backed by tree-sitter-javascript. Single-file, no cross-file resolution:

AST node Symbol kind SymbolID descriptor
function_declaration function <path>/name().
class_declaration class <path>/Cls#
method_definition (inside class) method <path>/Cls#name().
Top-level const / let / var variable <path>/Name.

Edges:

  • import_statement is read for future cross-module bridge consumption, but no edge is emitted at the module top-level (parity with the TypeScript plugin).

SymbolID encoding

scip-javascript . . . src/app/Service.js/UserService#login().
└─────────────┘     └──────────────────────────────────────┘
     scheme              file → namespaces / type / method

Why a separate plugin (vs. extending codemap-typescript)

TypeScript is a syntactic superset of JavaScript, so tree-sitter-typescript can parse most .js / .jsx files. We ship a dedicated plugin instead for three reasons:

  1. Clean dependency: codemap-javascript does not depend on tree-sitter-typescript. Users who only have JavaScript code do not need the larger grammar.
  2. JS-specific error recovery: when a .js file has a syntax error, the JavaScript grammar's error nodes point at JS-shaped tokens rather than TS-shaped ones, which produces tighter diagnostics.
  3. Independent versioning: JS language updates (decorators, class fields, RegExp v flag) can ship at their own cadence without bumping the TypeScript plugin.

For pure type-extraction purposes the two plugins produce equivalent symbol output for .js / .jsx files. Install whichever matches your codebase; install both if you have a mixed code-base.

Tests

pip install -e ".[dev]"
pytest

Limits / next steps

  • No cross-file import resolution. A javascript_cross_module bridge, sibling to python_cross_module, would be a future addition.
  • Arrow functions assigned to top-level const are indexed as variable, not function — matching the TypeScript plugin. Named arrow detection across both plugins is a v0.2.x improvement.
  • JSX-specific component patterns are not yet captured beyond the underlying function/class symbols.

License

MIT — same as the host project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codemap_javascript-0.3.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codemap_javascript-0.3.2-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file codemap_javascript-0.3.2.tar.gz.

File metadata

  • Download URL: codemap_javascript-0.3.2.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codemap_javascript-0.3.2.tar.gz
Algorithm Hash digest
SHA256 8f840cfd1f1821db32b53952903c0306fb1e64704c74ab512ba373fde7280905
MD5 564d8fb71db19d3f7664919702254162
BLAKE2b-256 d1556c0a98fe7ab21abb3e7070d5458327edc2618aed3a88e7cb7a737a741fc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_javascript-0.3.2.tar.gz:

Publisher: publish.yml on qxbyte/codemap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codemap_javascript-0.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for codemap_javascript-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea06e70952004d6c9de40232aa39a8f758e24ed5d0b3d74ff3b59b9eff8f59c0
MD5 4b09ec6c4cb7c567c5a062239a78e61d
BLAKE2b-256 6be678fb0f2c654b4f26e3f8b62d1adcbdbd20b3add6cb4aff9691e1c375681d

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_javascript-0.3.2-py3-none-any.whl:

Publisher: publish.yml on qxbyte/codemap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page