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.4.3.tar.gz (5.1 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.4.3-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codemap_bash-0.4.3.tar.gz
  • Upload date:
  • Size: 5.1 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.4.3.tar.gz
Algorithm Hash digest
SHA256 1934c70dbf9b0629812b945b6fcd8d812e6cd8f02dc9cc01c7a81edb22b3cbd5
MD5 573b29c5c2403cdd8f320f30d8009b4e
BLAKE2b-256 e2c19e30670639ef7db0220075adf0df4d9ab331d49b71430e8bb89151f48466

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: codemap_bash-0.4.3-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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b5f17b5f3cceb7d5aba7b3d29fa91d7d94fa72d7e1c747fc40e0fc52f97f7392
MD5 c33938c2a85c47257cd4ee8adca208d2
BLAKE2b-256 7c3d3282572e5f8c400a26b3577a6051a9ffdf582e00e7a60bec7e44ecb438ae

See more details on using hashes here.

Provenance

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