my-ssg VS mh-ssg

View my commit at 11c9ed8

3. Reviewing and testing Dustin's work on my ssg using git remote

My issue link My pull request Her repo

First, I decided to check the repo and noting down everything I could. Carefully examined how Vivian wrote the project allowed me to avoid unnecessary changes and ensure that the new code I wrote would not break the existing ones. Once satisfied, I decided to file an issue describing in detail what I wanted to do. The plan was:

At first, Minh Hang found out the -o or --output option specified in the help section, however, it has not been applied yet. I solved this problem by commenting this option out cause I intend to implement that feature in the next version of the tool.

During the testing and reviewing for her code, I have encountered both minor and major issues. Minor issues are related to documentation: there was a mismatch between actual functionalities and the options in Help section and Readme file was missing installation guide. Both were quickly resolved after the issues were filed.

I also worked on another project, mh-ssg, and added tests to this project as well. I created unit tests for a function called processFolder(). This function accepts an input folder path, output folder path and stylesheet URL. I created two unit tests, one which tests when a valid input folder containing files is passed to the function and one which tests when a non-existent folder is passed to the function. The function logs a message to the console depending on how many files are saved in the output folder, so the tests I wrote tested for these console logs.

For this lab, I picked Jest as the testing tool for mh-ssg. This is a popular Javascript testing framework thanks to its simplicity and ease of usage.

To maintain the quality of source code, I added a formatter and a linter for my project.

Throughout the previous week, I was exploring Docusaurus and found that they have a feature to support static files. I find this feature very useful for any static site generator since images, favicons, stylesheets, etc. are very common parts of a webpage. Therefore, I decided to add this feature in my tool.

Luke also implemented the same feature for my project. His code in general was good but I suggested some changes including separating modules and combining functions to remove code duplicates.

After looking through my classmates' projects, I decided to work on Minh Hang's static site generator and filed an issue to her repo.

I've been sending a lot of pull requests but this was actually my first time receiving one 😄 and Dustin was my first contributor. He also proposed to add Markdown support for my tool and to parse all the headings, bold, italics and link from markdown into the corresponding HTML tags. I scanned through the pull request and found some minor issues, including missing new feature in documentation and missing the handling of the output file name. We also had different opinions about the implementation of .txt file and .md file. However after discussion, we came to agreement and I approved his changes.

Secondly, the source code is neat and easy to understand, all generated HTML files are stored in ./dist folder if there is no output directory specified. However, the data contained in generated HTML files is displayed a little messy so it should be improve for a better look.

Vivian found a bug with my stylesheet feature. The title is defined as the first line of the file followed by two new lines. Some files have a title and some don't. My tool was assuming that every file has a title, hence failed to do the check. Therefore, if the input file doesn't have a title, the tool will generate the wrong title for it. I was able to fix this by adding a quick check before creating the HTML file.