OSD600-SSG VS shinny-ssg

Repo: https://github.com/nguyenhung15913/OSD600-SSG Jest: https://jestjs.io/

Sample docusaurus site: https://nguyenhung15913.github.io/OSDdocusaurus/ Static-site generator tool: https://github.com/nguyenhung15913/OSD600-SSG

The first thing I did was to create an issue after forking OSD600-SSG

Project repo: https://github.com/nguyenhung15913/OSD600-SSG Issue-11: https://github.com/nguyenhung15913/OSD600-SSG/issues/12 Final merge main with issue-11: https://github.com/nguyenhung15913/OSD600-SSG/commit/c9f72f123133250897eef3e27a0f5c0df3e3145d#diff-e8ba56b7852a747928456dd8ad6bc1c92a747d806b5feb04e59563044567484c Issue-12:https://github.com/nguyenhung15913/OSD600-SSG/issues/13 Final merge main with issue-12: https://github.com/nguyenhung15913/OSD600-SSG/commit/72efea5358c4b1423e1b7394d286b225930dc785#diff-e8ba56b7852a747928456dd8ad6bc1c92a747d806b5feb04e59563044567484c

The project I chose to work on is OSD600-SSG, written by Hung. I am interested in this project because it is written in JS and I would love to learn more about it. I contributed to the project by adding the new feature to accept markdown file. The first challenge I had was adding new code without breaking his old code. His coding style is different from mine so it took some time to learn the logic flow of the code. Luckily, Hung was really nice and he even encouraged me to change his code. The second challenge I had was working with regular expression. I needed to transfer the emphasis sentence in markdown file to html bold text. In a markdown file, to bold the middle of a word for emphasis, you need to add two asterisks without spaces around the letters. I added an extra space to my finding pattern and it was hard to find this bug. In the end, I successfully added the new feature to the project. After testing it on my local computer, I created a pull request and got accepted by Hung. My PR

Luigi's Octo: https://github.com/LuigiZaccagnini/octo Octo's Markdown issue: https://github.com/LuigiZaccagnini/octo/issues/7 Pull request to Octo: https://github.com/LuigiZaccagnini/octo/pull/8 My OSD600-SSG: https://github.com/nguyenhung15913/OSD600-SSG OSD600-SSG Markdown issue: https://github.com/nguyenhung15913/OSD600-SSG/issues/10 Emily's pull request: https://github.com/nguyenhung15913/OSD600-SSG/pull/11

Hung's program is called OSD600-SSG and it is similar to mine in functionality. I found the process of testing the program pretty straightforward. I cloned it, I followed the instructions on the README and everything worked as expected.

One of my program's problems is it accepts all files. For example, if you have an input.md, my program can still read it and export an html file, while it is supposed to receive only .txt file. On top of that, Menghi recommended me to fix the outputs so it will export files with specific names instead of just index1.html, index2.html, etc. Detail: https://github.com/nguyenhung15913/OSD600-SSG/issues

I want to test how my tools generated files and folders in the destination with different arguments passed to the program. However, in my old code, I put all the logic of working with arguments in the static int main( string[] args) function. I could not use Interface and Dependency injection to mock the CLI tools because CommandLineUtils does not have an interface library. Luckily, I found this guidance from the owner of CommandLineUtils, and he advised that "Split the command-line argument parser and application execution into separate class structures" to test various options programmatically. It is a great suggestion, and I rewrote my program by adding class CommandLineOptions and adding logic to class Generator to make it works with CommandLineOptions. I can kill two birds with one stone by this change: code refactoring and writing better tests. Another problem I had was my folder structure. Before, I put the project's sln file, .git file , and src files in the root of the folder. However, when I added a new test project for Shinny-SSG, I had it outside my git folder, and it would be impossible to commit the change and put it in my remote repository. To resolve this, I had to change my folder structure to this:

This week, I learn about Docusaurus- an awesome static-site generator. The application helps building a single page application with just a few commands. The application is beginner friendly and it can generate html page from React Component or markdown file read more.It also has advanced features and plugins to provide more options for users. I really impressive about what this tool can do. The support markdown feature is cool and it would be a good additional for my Shinny-SSG project. I have filed an issue and I will use CommonMark.NET package for achieving the goal. Borrowing the idea from Docusaurus, I added some metadata to my Page class so when a new HTML Page generates, it will have better SEO Pr. In the future, I would love to add Support for React components or Static Assets features for my project.

This week, I was working on refactoring my project - Shinny-SSG and experimenting Git Rebase command.

I had the pleasure of receiving the contribution from Andrew to add markdown processing feature to my application. He made the change to the code very quickly and it was exactly what I would do if I were the one to implement it. I especially liked the way he used LinQ in createSubfolder function. It was brilliant and now I know one more way to work with file. Andrew's PR

After I built the Glazed Donut, I had a wonderful opportunity to explore a similar project shinny-ssg by doing some testing and reviewing and get my glazed-donut tested as well.

After finishing the features of my command line application tool shinny-ssg, I was working with Diana to cross-check the source code of our projects. In general, we have to check for bugs, suggest improvement, and file issues on Github. We both use C# and .NetCore 3.1 to create the projects and therefore, the experience was quite exciting and I definitely learned a lot. It is just a pleasure to work with Diana. I have known her previously from my database and web classese and knew that she is such a hard working and bright girl. In addition, Diana worked at the company which I am now doing the internship at. She has used C# for a long time and have great knowledge about it. This was very evident from her code.