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

Uploaded Python 3

File details

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

File metadata

  • Download URL: codemap_bash-0.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 bd1d3a0e710fff3d86ca2a2f03d61725d3ed976c2e31a373a33ea21dc2c8a637
MD5 b6a07edeb8ad115e2be41e21f644d213
BLAKE2b-256 ac4bd6a8d9f88b6657aea40907e2b3455bd61bf929f8ea4d20b24cec0a35200c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: codemap_bash-0.3.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3fc970ba0e42bd2b6f8291eb1ff5f8c3fd25c8f4c939a17ce20d957ff91a34bb
MD5 2c0367f3dd464f8dfa6b96e193465871
BLAKE2b-256 e97a8b92aa7b11214c29319b2bb4bcea6e7446ed5e485b65fb53e93ad3f08da7

See more details on using hashes here.

Provenance

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