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

Uploaded Python 3

File details

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

File metadata

  • Download URL: codemap_bash-0.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 c3b119c4ddcf86dfe533ddf37e12c33da56f2a08a9c007554a7c1cd4ef213ea4
MD5 19fa3718e3e64665077bc944ad79e1ba
BLAKE2b-256 de0f9dab52761d976205d3b555777c01146b42e0c228bf1015bfaac244e9b6cc

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: codemap_bash-0.3.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.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a8361fa643cb95854f546bc746e2cbe5487c6bc2f1c41de6f069b0514b3cd9
MD5 8ba07f529c9c771aba030ea420736724
BLAKE2b-256 a5e6006d51cf3892cde8370ae805d8e99991d946bed46675fab3cd8f82728559

See more details on using hashes here.

Provenance

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