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

Uploaded Python 3

File details

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

File metadata

  • Download URL: codemap_bash-0.4.6.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.6.tar.gz
Algorithm Hash digest
SHA256 3dcbe82bd84dd0e6f9e7105d5728e2bb08c5325e311fc911a3601ff37d726abc
MD5 3996ab901fc7a69741f3767c4234f3ad
BLAKE2b-256 b769a2e1191cacd8b98df805d218fb8f53a210e1aaf5568072f69364f21b5e42

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: codemap_bash-0.4.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 00376c13cee0e5c3ec71680890ed65678b57d7a5b254e163e3e4e2f742580cbc
MD5 692be2062f9af34d62bcfb5049463b9d
BLAKE2b-256 7d2f56190489c257bdd52cae2a7aba01ec6f4ab21c8237c72baf000c93be351e

See more details on using hashes here.

Provenance

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