TODO: Current state:** code_review
Suggestions
Stopped here

“Bash Script Template Framework” for

script_template.sh

in minimal configuration

This project provides a modular, test-driven Bash script framework for writing robust, maintainable, and production-ready shell scripts. It includes best practices like strict mode, safe variable initialization, debug toggling, error trapping, and optional environment configuration support.

---

📁 Project Structure

Guides

LLM assisted refactoring

To automate prompting and better understand the context of the current workflow use

.

The code review generator should be located at the root of the working directory in the

folder (e.g. for the development of the sections). It is advisable to add a new one for each new project or task.

To start new task or subproject - start a new version. For that copy the root with the version up, clean up old unnecessary files and iterate the code review process (e.g.

).

Actual state of the conversation must be indicated in the function

of the

code_review_query_generator.sh

, so conversation log would be actual. To generate nice

tree

output, use test-tree.

For debugging or precision part development, use debugger. It keeps versioned logs of the conversations and captures file changes.

TODO: Assembling

TODO: Testing

Scripts related to

script_template.sh

assembled from parts

• TODO:
  README.md
  generator. Code review for
  md_generator.sh
  .
• TODO: Draft of the
  validate_script.sh

Sources

• Script for the refactoring.
• Snippets for validation:
  • bash_function.code-snippets
  • bash_head.code-snippets
  • bash_section.code-snippets
• Result:
  script_template.sh
  • It's
    README.md
  • Tests (BATS-based).
• Markup example
• Region types

Parts

head

• bash_head.code-snippets
• script_template_head.sh

sections

• Result:
  script_template.sh
• Config:
  script_template.sh.config
• Documentation:
  • Draft of the
    README.md
  • Code review of the “Bash Script Template Framework” (code base in the state of development finalization of the “Sections” part)
• Sources:
  • Makefile
  • Scripts:
    • script_collector.sh
    • tests_controller.sh
    • tests_generator.sh
  • Parts for assembly
    • BASH_MODE_CONFIGURATION.sh
    • DOT_ENV_FILE.sh
    • GLOBAL_VARIABLES_INIT_STATUS.sh
    • LOG_FILE_INIT_STATUS.sh
    • PATH_NORMALIZATION_STATUS.sh
    • SCRIPT_DEBUG_SWITCH.sh
    • SCRIPT_SOURCING_SWITCH.sh
    • TRAPS.sh
  • Tests for the "sections"
• Etc.:
  • Suggestions
  • Scripts:
    • Debugger for
      tests_controller.sh

functions

• Result:
  script_template.sh
• Config:
  script_template.sh.config
• Documentation:
  • List of the functions in
    sources/
    with links to their detailed code reviews.
  • "Functions" code review dialog
• Sources:
  • Makefile
  • Scripts:
  • tests
    • script_collector.sh
    • tests_controller.sh
    • tests_generator.sh
  • Parts for assembly
    • basic_argument_parsing.sh
    • clean_temp_and_log_init.sh
    • global_variables_initialization.sh
    • logging.sh
    • main.sh
    • new_function.sh
    • path_normalization.sh
    • script_initialization.sh
    • source_dot_env.sh
    • trap_error.sh
    • trap_exit.sh
    • unsetting_global_variables.sh
    • usage.sh
• Etc.:
  • Suggestions
  • Scripts:
    • Debugger for
      script_collector.sh
      .
    • Query generator for code review of the functions files stored in the ‘./sources’ folder.
    • A script to extract functions from a script for refactoring (copy
      donor.sh
      ).
    • Runner for
      function_template_validator.sh
      . Validates all function files in
      ./source
      .