Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Builder with Latest Changes #123

Open
SibTiger opened this issue Jan 5, 2025 · 3 comments
Open

Update Builder with Latest Changes #123

SibTiger opened this issue Jan 5, 2025 · 3 comments
Assignees
Labels
Priority: NORMAL Priority for this report or submission is: NORMAL

Comments

@SibTiger
Copy link
Owner

SibTiger commented Jan 5, 2025

The Builder within PSCAT has not been thoroughly inspected to assure that it contains the proper updates as needed due to the vast changes that had occurred over time. The Builder will need to be updated to assure that it will work with the latest changes made within the program.

Call to Action:

  • Update the Builder such that it will work properly within PSCAT's latest changes as-of-today.
  • Provide improvements as necessary to assure that the functionality works as intended.

Linked Tickets:

@SibTiger SibTiger added the Priority: NORMAL Priority for this report or submission is: NORMAL label Jan 5, 2025
@SibTiger SibTiger added this to the Third Release (1.2.0) milestone Jan 5, 2025
@SibTiger SibTiger self-assigned this Jan 5, 2025
@SibTiger SibTiger moved this from To do to In Progress in PSCAT Software Kanban (Version 1.2.0) Jan 5, 2025
SibTiger added a commit that referenced this issue Jan 5, 2025
Now using Static class, ProjectInformation.

#123
SibTiger added a commit that referenced this issue Jan 5, 2025
Now using Static class, ArchiveZip.

#123
@SibTiger
Copy link
Owner Author

SibTiger commented Jan 5, 2025

Wow... that was easier than I thought. I was able to push out a build using the Builder. YAAA!!!!

I want to look over the function, line-by-line, to see what is going on under the bonnet.

@SibTiger
Copy link
Owner Author

SibTiger commented Jan 9, 2025

Running late on this; I will try to accomplish this today.

SibTiger added a commit that referenced this issue Jan 10, 2025
- Revised some documentation within Build()
- If anything can be one-liner statements within the Build() function, do it.  Only some are affected with this change.
- Revised __PrerequisiteCheck() description block.
- Removed the three variables within the __PrerequisiteCheck() as they are not needed and can be handled as needed within the function.
- Any calls to DisplayBulletListMessage() will now be multi-lines, making it easier to read in __PrerequisiteCheck().
- Revised messages that are displayed onto the terminal from __PrerequisiteCheck()
- Revised the messages that are recorded to the logfile from __PrerequisiteCheck().
- When __PrerequisiteCheck() detects the Project's Source Files, also show the same path to the user.
- When __PrerequisiteCheck() detects the parent output directory, also show the same path to the user.
- Revised __GenerateArchiveFileName() function description block.
- Updated __GenerateArchiveFileName() signature to be a void, but will take a string reference that will provide the filename.
- Revised the messages that are shown to the user from the __GenerateArchiveFileName() function.
- Revised __GenerateOutputPath() function description block.
- Revised __GenerateOutputPath() signature, to return a bool flag signifying if the function completed successfully, and takes a reference as its argument for a output path string.
- Enhanced __GenerateOutputPath() to try to create the project's output directory when it doesn't already exist.

#123
SibTiger added a commit that referenced this issue Jan 10, 2025
SibTiger added a commit that referenced this issue Jan 10, 2025
- Build() has all single-liner statements to make life easier.
- Revised the rest of the comments within the Build() function.
- Forgot to make the __DisplayBulletListMessage() multi-lines within __GenerateArchiveFileName()
- Revised the tab space of the bullet points when an error is reached in the __GenerateOutputPath() function.
- Revised the __CreateProjectTemporaryDirectory() function's description block.
- Removed the logging variables in the top-most Declarations and Init. variable block within __CreateProjectTemporaryDirectory() function.
- Immediately initialize the $directoryKeyTerm to a meaningful value, instead of $NULL in __CreateProjectTemporaryDirectory().
- Revised the messages that are shown to the user from __CreateProjectTemporaryDirectory().
- Changed the tab-spacing when a bullet point is shown from __CreateProjectTemporaryDirectory()
- __DisplayBulletListMessage() is now multi-line within __CreateProjectTemporaryDirectory() making it a bit easier to read.

#123
SibTiger added a commit that referenced this issue Jan 10, 2025
- Revised the __DuplicateSourceToTemporaryDirectory() function description block.
- Builder now has __DuplicateSourceToTemporaryDirectory() conditional and execution block as a single-line.
- Removed the logging variables in the top-most Declaratiosn and Init. block.
- __DisplayBulletListMessage() calls are now multi-lines in __DuplicateSourceToTemporaryDirectory(), making it easier to read.
- Revised how the messages are logged in __DuplicateSourceToTemporaryDirectory().
- Revised __DisplayBulletListMessage() tab-spacing bullets in __DuplicateSourceToTemporaryDirectory().
- Revised the __ExpungeExtraneousResources() function discription.
- Revised documentation within ____ExpungeExtraneousResources()
- Removed logging variables within the top-most Declarations and Init. block, as they can instantiated later within their respective scopes, in __ExpungeExtraneousResources().
- Revised the folders that will be removed from the temp. directory, instead of:
    - ($temporaryDirectoryPath)\TEMP
    - ($temporaryDirectoryPath)\Temporary
    - ($temporaryDirectoryPath)\Tools
    - ($temporaryDirectoryPath)\Github Services
    - ($temporaryDirectoryPath)\GitHub
 These paths were more focused on my needs, to be more open for all needs, only these directories will be removed:
    - ($temporaryDirectoryPath)\.git
    - ($temporaryDirectoryPath)\.svn
- Made __DisplayBulletListMessage() multi-line to make it easier to read, in __ExpungeExtraneousResources().
- Revised the messages that are shown to the user, in __ExpungeExtraneousResources().
- Show what folders are removed from the temporary directory as they happen, in __ExpungeExtraneousResources().
- Instead of passing the entire array file files to remove, we will iterate through the array and remove each file individually.  The reason for this change is so it is easier to show what files are being removed and what file caused an error during the deletion.
- Show what files are removed from the temporary directory as they happen, in __ExpungeExtraneousResources().

#123
SibTiger added a commit that referenced this issue Jan 10, 2025
- Revised the __CompileProject() function's description block.
- Updated comments regarding __CompileProject() call from Build().
- Updated __CompileProject() function signature to include the Output Path, this was somehow removed some time ago or was grossly over-simplified?
- Removed the logging variables, these variables will be instantiated in their appropriate scopes in __CompileProject().
- Updated the __DisplayBulletListMessage() calls to multi-lines in __CompileProject(), so it easier to read.
- Revised messages that are shown to the user in __CompileProject().
- Revised messages that are being logged in __CompileProject().
- After a build had been successful, show the path to that build in __CompileProject().

#123
SibTiger added a commit that referenced this issue Jan 10, 2025
- Revised the __DeleteProjectTemporaryDirectory() function description.
- Removed the logging variables from the top-most Declarations and Init. block, as these will be instantiated in their respective scopes.
- __DisplayBulletListMessage() calls from __DeleteProjectTemporaryDirectory() are now multi-line, to make it easier to read.
- Show the user what folder is being removed in __DeleteProjectTemporaryDirectory().
- If incase the temporary directory could be deleted, then assure the user that the Windows OS will do this automatically in a later time; __DeleteProjectTemporaryDirectory().
- Revised the messages that are being logged in __DeleteProjectTemporaryDirectory().
- Revised messages that are shown to the user from __DeleteProjectTemporaryDirectory().
- Revised documentation of the __DeleteProjectTemporaryDirectory() in Build().
- Revised documentation of the __ShowProjectLocation() in Build().
- Revised __ShowProjectLocation() function's description block.
- Revised documentation within __ShowProjectLocation()
- Revised the messages that are shown to the user in the __ShowProjectLocation() function.
- Revised comments when the operation was successful in Build().
- Revised the messages that are shown when the operation was successful in the Build() function.

#123
SibTiger added a commit that referenced this issue Jan 10, 2025
- Revised the Builder Formatted List description.
- Revised the __DisplayBulletListMessage() function's description.

#123
@SibTiger
Copy link
Owner Author

I did not perform any testing, so that will be the next task. But the massive changes should be done now.

I will not close this ticket until I finish the testing.

SibTiger added a commit that referenced this issue Jan 10, 2025
SibTiger added a commit that referenced this issue Jan 11, 2025
When showing the Output Path and the PowerShell Core Version, provide a newline.  Previously, the two strings would be incorrectly mashed together, in the [Builder]::__PrerequisiteCheck() function.

#123
SibTiger added a commit that referenced this issue Jan 11, 2025
Changed what messages that are shown to the user in [Builder]::__PrerequisiteCheck() at each step.  Now it will show what it is doing before it does the task, but will also show if the check had passed or failed afterwards.

#123
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: NORMAL Priority for this report or submission is: NORMAL
Projects
Development

No branches or pull requests

1 participant