Skip to main content

Bash / shell-script indexer plugin for CodeMap

Project description

codemap-bash

A Bash / shell-script indexer for CodeMap, shipped as an independent PyPI package.

What it captures

Backed by tree-sitter-bash:

AST node Symbol kind
function_definition function
Top-level variable_assignment variable
declaration_command (readonly/declare/export/local) at top level variable (with extra.bash_kind=<keyword>)

Function bodies are not walked for inner assignments — anything declared inside a function is local state, not a script-level symbol.

Install

pip install codemap-bash

SymbolID encoding

scip-bash . . . scripts/deploy.sh/greet().
scip-bash . . . scripts/deploy.sh/MAX_RETRIES.

File patterns

  • *.sh, *.bash, *.bats
  • Files without an extension whose shebang starts with #!/bin/bash or #!/usr/bin/env bash are matched via supports().

Limits

  • source / . includes are not turned into edges.
  • Aliases (alias ll='ls -la') are not captured.
  • getopts argument schemas aren't structured.
  • POSIX sh / Zsh / Fish dialects parse, but constructs unique to them may degrade to syntax-error diagnostics.

License

MIT.

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_bash-0.3.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

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

codemap_bash-0.3.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for codemap_bash-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fe2d43d57210d1f6d54bc2b0bb1dfd5aba408e0c7092664649768f4eb9d5bc0f
MD5 490c51d6b3027c40bf66190c702922fe
BLAKE2b-256 67876f323273ae826e8ab305eb59c1f93fc9cc222edbd9de0fd0f75006a7d5a9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: codemap_bash-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for codemap_bash-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49baccae287f5154e26b5c352eb963ce58e6cba7fb5696a9afdafffb336b139c
MD5 02cf4e8c9192f28ee0d1fbe411f119ba
BLAKE2b-256 3cf053d3d96b083ab5349c7e8dca08a105689dae9e48cc2c4d72bd9b786b6158

See more details on using hashes here.

Provenance

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