Create `generateArchitectureDiagram` - Function That Produces Architectural ASCii Diagrams

[ReedClanton]

Overview

Create the structure for a function that produces ASCii diagrams of the architecture of a shell script/function.

Details

This work should be merged into the feature/generateArchitectureDiagram branch rather than main so it can be worked on across multiple issues prior to being merged to main.

Create the directory, the .sh file, the util directory, and the file(s) that are known to be needed. They do not need to be fully filled out.

Part of the work here will be choosing a name for this function.

Testing

Because this will be skeleton code, it won't be final or complete. As a result, full coverage is not needed. However, an outline of what will be needed, including the directories, README.md files, and some of the unit testing files should be included.

Artifact(s)

• PR with:
  • Directory at the root of this repository with the same name as the function.
  • A .sh file within this directory with the name of the function:
    • An outline of the function's code.
  • A README.md file within the directory with the same name as the function.
  • A util directory within the directory named after the function:
    • A constants.sh file with an outline of what will be in the file.
    • A main.sh file with an outline of what will be in the file.
    • Any other .sh files that are anticipated to be needed at this point:
      • One example would be a function for drawing lines between "boxes" (the output of output --pretty -m=<someText>).
  • Directory in shell-functions/spec/unit/ with the same name as the function.
    • One ore more .sh test files:
      • Doesn't need to be complete or contain any tests.
    • A util directory:
      • A constants_spec.sh file:
        • Doesn't need to be complete or contain any tests.
      • Maybe a main_spec.sh file, depending on the findings of Include main.sh Files in Unit Test Coverage Report #16:
        • Doesn't need to be complete or contain any tests.
      • One file for each util function added:
        • Doesn't need to be complete or contain any tests.
        • File name doesn't need to be final.
  • A .yml file in [shell-functions/.github/workflows/](https://github.com/ReedClanton/shell_base/tree/main/.github/workflows) named testing_unit-.yml`:
    • File doesn't need to be complete.

Scope

Scope is difficult to strictly define. If it's outside of what's listed in the Artifact(s) section, think twice.

Open a PR for This Issue

Relationship(s)

Blocked By

The existence of unit tests (#2, #16), running them in the pipeline (#3), and displaying the status of them (#4, #5), are more important that this.

Blockers

None.