azpect/MarkdownToHtmlTranspiler
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

File system class for use in the parser. #19

New Issue
Closed
opened 2025-10-17 12:09:02 -07:00 by azpect · 1 comment
azpect commented 2025-10-17 12:09:02 -07:00
Owner
Copy Link

Currently, the parser handles file I/O, which does not meet the OOP principle of single responsibility classes. To resolve this violation, a FileSystem class will be implemented.

This class will be constructed wth a required string for the input file, and an optional string for the output. The class will have methods such as readInput and writeOutput. The class will abstract all filesystem operations.

Eventually, the watchdog class will utilize this module. But this implementation will not have that functionality. Once this issue is complete, it will be passed to @shultzp1 to complete the watchdog implementation.

Currently, the `parser` handles file I/O, which does not meet the OOP principle of **single responsibility classes**. To resolve this violation, a `FileSystem` class will be implemented. This class will be constructed wth a required string for the input file, and an optional string for the output. The class will have methods such as readInput and writeOutput. The class will abstract all filesystem operations. Eventually, the `watchdog` class will utilize this module. But this implementation will not have that functionality. Once this issue is complete, it will be passed to @shultzp1 to complete the watchdog implementation.
azpect added the
Kind/Enhancement
Priority
Medium
 labels 2025-10-17 12:09:02 -07:00
azpect self-assigned this 2025-10-17 12:09:02 -07:00
azpect added this to the (SPRINT) Parser creation project 2025-10-17 12:09:02 -07:00
azpect moved this to In Progress in (SPRINT) Parser creation on 2025-10-17 13:20:04 -07:00
azpect moved this to Done in (SPRINT) Parser creation on 2025-10-20 12:06:55 -07:00
azpect commented 2025-10-20 12:07:13 -07:00
Author
Owner
Copy Link

Close with the merging of #20 .

Close with the merging of #20 .
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No Label
Kind/Enhancement
Priority
Medium
Milestone
No items
No Milestone
Projects
Clear projects
No project (SPRINT) Parser creation
Assignees
Clear assignees
shultzp1 azpect
No Assignees azpect
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: azpect/MarkdownToHtmlTranspiler#19
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?