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.0.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.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codemap_javascript-0.3.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2fe772099e5bfc46780e4661e6ac0837dce146edfc1de92955512680a9a5f304
MD5 771d7479cfee5caa9a7da0786aa7b452
BLAKE2b-256 a9b53fb1e880e7877d59de71bddeada115bbd89f8ade81f5f2f38b01d43bb76f

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_javascript-0.3.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for codemap_javascript-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f08d51ad4819200fe312e1f02ba324767021be5e156a543f681fe07dcc08d5c9
MD5 b1ed1dfc0e96c813257a6d24c89cc82b
BLAKE2b-256 2e52ebe9a64ffbb101e50ee4500cb58ed9ddd32397f97c7804e22023b50509f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for codemap_javascript-0.3.0-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