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 "git+https://github.com/qxbyte/codemap.git#subdirectory=plugins/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.1.0a1.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.1.0a1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file codemap_bash-0.1.0a1.tar.gz.

File metadata

  • Download URL: codemap_bash-0.1.0a1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for codemap_bash-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 adcd5c579e63282e488c677d52cea19bdaddfe6573fdc65aff5f1309b221d98f
MD5 f277a2e6a5a09571b055a34581b74100
BLAKE2b-256 a8adfdb0b90ebc4c346c5fd0eea837234dff2fb88848f57178315a730ce1da23

See more details on using hashes here.

File details

Details for the file codemap_bash-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: codemap_bash-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for codemap_bash-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 efc8074dcf0694ee5a1c049419570db4582b1b605020855901961f4f30e5be92
MD5 e1f80a42656c3548bfa6c29ae9261c80
BLAKE2b-256 bd3dcc456ca469654466f98e9bdeba743457c637eef4c5506efa567c6998d535

See more details on using hashes here.

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