OSD600-SSG VS dodo-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 setup a new action to run Jest tests on "ubuntu-latest" using both Node 14 and Node 16 every time a new Pull Request is created or a new commit is added. I tested it with a new PR and this is what showed up at the bottom:

This week I looked at code testing for my Static Site Generator dodo-SSG. I picked Jest for this since it is a very popular unit testing tool used by many open source projects.

There are some amazing tools available for developers to make coding easier. Today I am looking at a few of those and how it was like installing and using them in my dodo-SSG repo.

I chose to take two features from Docusaurus and implement them into my own dodo-SSG tool:

To practice, I worked on refactoring my dodo-SSG project in a new branch that I called refactoring. I started by fixing the code format from previous contributions using prettier. I then changed the code to get rid of global variables. To do that, I had to split up some code into separate smaller functions. At each of these steps, I created a new commit to make sure I could easily go back to the previous version if anything broke (And things broke a lot while doing this!).

This week I was contributing to the dodo-ssg's remote repo. My intention was to add a feature so that when someone types in "--config" or "-c" followed by a path to a JSON file, the program will read its contents and execute the commands inside of it. This is a useful feature when you don't want to see a super long line in the command line interface filled with a bunch of commands. Here is my PR.

In my Static Site Generator dodo-SSG, I added two new issues, one to Add support for inline code blocks and the other to Add support for a horizontal rule in Markdown.

While I was working on Tue's project, he was busy adding Markdown features on my dodo-SSG project. He sent me a pull request and I got started reviewing it. I noticed that the program was working only with Markdown files inside a directory when that directory was selected as input like: dodo-SSG -i ./directory but it did not work when a Markdown file was selected directly as input: dodo-SSG -i ./directory/file.md

Adding markdown support to Francesco's dodo-SSG

This was my first time sending my code for review to a classmate instead of submitting it to a professor. I like the fact that this activity is made to learn from others and to hopefully improve each other's code. I received some helpful feedback such as this issue. Using the option -v or --version on my program only showed the version number without anything else. I took that feedback and I improved the output to be: