scriptize

➕ Improve maintainability, readability, and efficiency of your scripts by standardize your scripting environment.

Requirements

On Debian/Ubuntu

sudo apt update
sudo apt install shellcheck bats shell-format

On Fedora

sudo dnf install ShellCheck bats shfmt

On macOS (using Homebrew)

brew install shellcheck bats shfmt

How to use

1. Clone the Repo: git clone script-templates
2. Run Installer: cd script-templates && sudo ./install.sh
3. Create a New Script:
   • new-script bash my-awesome-tool: This creates ./my-awesome-tool.sh, makes it executable, and you're ready to add your logic.
   • new-script python my-data-processor: This creates ./my-data-processor.py for your Python project.

If keep .pre-commit-config.yaml

Install pre-commit (once per system)

pip install pre-commit

Install the hooks into your git repo (run inside the repo)

pre-commit install

Generating Bash Docs

Run It: Now you can run this script from the root of your repository without any installation. It will behave exactly like the original shdoc. Bash

Generate documentation for a single file

./scriptize/utils/shdoc < ./bash/utilities/alerts.bash > docs/alerts_api.md

Generate a single documentation file for all utilities

./scriptize/utils/shdoc < ./bash/utilities/*.bash > docs/BASH_API_REFERENCE.md