Repository navigation
Description
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
.shfile within this directory with the name of the function:- An outline of the function's code.
- A
README.mdfile within the directory with the same name as the function. - A
utildirectory within the directory named after the function:- A
constants.shfile with an outline of what will be in the file. - A
main.shfile with an outline of what will be in the file. - Any other
.shfiles 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>).
- One example would be a function for drawing lines between "boxes" (the output of
- A
- Directory in shell-functions/spec/unit/ with the same name as the function.
- One ore more
.shtest files:- Doesn't need to be complete or contain any tests.
- A
utildirectory:- A
constants_spec.shfile:- Doesn't need to be complete or contain any tests.
- Maybe a
main_spec.shfile, depending on the findings of Includemain.shFiles in Unit Test Coverage Report #16:- Doesn't need to be complete or contain any tests.
- One file for each
utilfunction added:- Doesn't need to be complete or contain any tests.
- File name doesn't need to be final.
- A
- One ore more
- A
.ymlfile in [shell-functions/.github/workflows/](https://github.com/ReedClanton/shell_base/tree/main/.github/workflows) namedtesting_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.
Metadata
Metadata
Assignees
Labels
Projects
- StatusShow more project fieldsBacklog
Activity
main.shFiles in Unit Test Coverage Report #16logging- GitHub Status Badge of Tests for All Supported Shells #5default_pull_request_template.md- Add Unit Testing Checks to GitHub PR Template #23verifyInputProvided()- GitHub Status Badge of Tests for All Supported Shells #40output- Interface Functional Tests #46output- Interface Functional Tests #46output- Interface Functional Tests #46