So this week for our lab we did more practice with working with another person's repo. This week I decided to mix it up a bit and work on a SSG in JavaScript, so I made a pull request for Ritik's repository. Our task was to add a new feature that would allow the user to input a JSON config file as an argument, that config file would contain a JSON object with all the arguments the user wanted to use for the HTML output. Such as input file, output location, stylesheet, language, etc.

Once I had approval from the owner, the .md ticket was assigned to me and I started off by forking the repository and creating a branch to work on the issue (dhillonks/commandline-ssg:issue-8). The code in the repo was already organized into modules which made it easier for me to expand the parsing functionality. I ended up splitting the parsing method to add a flow for .md files. This ensured that I wasn't affecting any old functionality, leaving the parsing for .txt as is. After some coding, I was able to parse .md files and detect headings h1-h6. I used the first h1 text as the placeholder for . The tool could now also generate paragraphs properly for separated lines which were not headings. Moreover, both **bold** and __bold__ markdown syntax for bold text were supported. Along with these code changes, I also modified the Readme.md file to document this new functionality.

Creating a pull request to get the work accepted into the original repo

After I had thoroughly testing my changes, making sure that the new functionality worked and also ensuring that it didn't break any old functionality, I created a pull request on the original repository.

Link to the pr to commandline-ssg - Click here!

I included a description of the changes that were made, the functionality that was added and sample usage for .md files. I also pinged the code owner to review the pull request once it was created. Today, I just found out that my changes were approved and the pull request was merged!

Reviewing a pull request to cli-ssg

I also received a pull request to the open source tool I had created earlier.

Link to the pr to my repo - Click here

The pr was also adding functionality to parse .md files including the headings, bold, italics, links and strikethrough. It looked good at a first glance and the functionality mostly worked but I ended up finding a few issues after looking closely.
The biggest problem was that

paragraphs were not being generated for non-headings. This was obviously an big problem which I need to highlight.
Also, it rendered bold using and italics using which is not the best way to markup emphasis. So I suggested that bold should instead use and italics should instead use .
My last suggestion was not a bug, but since the PR was also implementing the syntax support for links, I wanted to make sure that it also supported automatic links i.e. links within angled braces should be rendered to an anchor tag.
I highlighted these and requested changes when I added my review to the pr. I look forward to reviewing the pr again once these changes are made.

He also helped me in reviewing and testing my code. I was eager for him creating issues so that I can work on them and improve my tool. His issues did not surprise me as I was sure I might have made a few mistakes during the development. He was able to find 3 issues in my code as well! He found issues of a typo, picking version from the file and program giving errors in special cases. I had a typing mistake in my code where I misspelled ‘successfully’ to ‘successfullly’. The issue can be found here. The second issue was versioning related as he suggested me to pick the program version from package.json which could reduce programmers work manually updating it in every file that uses it. And the last issue he found was input file/folder related in which he entered a file which did not exist. Instead of my program warning the user, it created an empty folder which was never expected. I later worked on all the 3 issues and resolved them ASAP.

At the beginning, I had no trouble reading his code because he's done it pretty clean and understandable. But everyone makes mistakes right, he also did :) He had a few typos in his code that could have been tracked by an extension in Visual Studio if he had used it (Code Spell Tracker) but that's no big deal at all Issue on github can be found here. After a few hours reading, I found another thing that could have been improved which is the program version. I read it online saying that the program version can be pulled off of the package.json so we don't need to hard code the program version everywhere Issue on github can be found here. The third problem that I found is quite important and it can lead to severe errors as he forgot to handle cases when users type in invalid files or folders Issue on github can be found here. Other than those small bugs, I couldn't find any other bugs as he did it very well.

GitHub Repo

Over the past couple of weeks, I've been working on cli-ssg, which is a command line tool to generate a website using .txt/.md files. A lot of changes had accumulated, and this was the perfect time to create an official release 1.0.0.

Last week, I added some tests to cli-ssg using jest, but right now the only way to run them is to run them manually. While this works, having an automated process in place to run the tests would be much better, as that would mean that any change that breaks the tests, cannot be merged.

Static analysis tools help us maintain the quality of our source code by fixing formatting issues, spotting suspicious coding constructs, or alerting us to common errors. As cli-ssg is a collaborative open source project, it becomes especially important to have these in place to enforce common formatting and linting.

Since I had created a basic static site generator (cli-ssg), I wanted to explore other bigger projects that were working on the same problem. One such popular SSG is Docusaurus which is a React based static site generator backed by Facebook.

That being said, index.js was looking a bit messy after the pull request for the --config option was merged into main (#18).

Someone also created a similar issue on my project cli-ssg earlier this week to add support for a config JSON file and so I assigned it to them. There hasn't been a pull request as of me writing this blog, but I look forward to reviewing it! https://github.com/dhillonks/cli-ssg/issues/17

This week I worked on adding more functionality to cli-ssg. I decided to add support for a --lang flag to specify language and add the ability to produce horizontal rule: Add support for horizontal rule in markdown Add a -l flag to generate the lang attribute

Once I had approval from the owner, the .md ticket was assigned to me and I started off by forking the repository and creating a branch to work on the issue (dhillonks/commandline-ssg:issue-8). The code in the repo was already organized into modules which made it easier for me to expand the parsing functionality. I ended up splitting the parsing method to add a flow for .md files. This ensured that I wasn't affecting any old functionality, leaving the parsing for .txt as is. After some coding, I was able to parse .md files and detect headings h1-h6. I used the first h1 text as the placeholder for . The tool could now also generate paragraphs properly for separated lines which were not headings. Moreover, both **bold** and __bold__ markdown syntax for bold text were supported. Along with these code changes, I also modified the Readme.md file to document this new functionality.

Creating a pull request to get the work accepted into the original repo

After I had thoroughly testing my changes, making sure that the new functionality worked and also ensuring that it didn't break any old functionality, I created a pull request on the original repository.

Link to the pr to commandline-ssg - Click here!

I included a description of the changes that were made, the functionality that was added and sample usage for .md files. I also pinged the code owner to review the pull request once it was created. Today, I just found out that my changes were approved and the pull request was merged!

Reviewing a pull request to cli-ssg

I also received a pull request to the open source tool I had created earlier.

Link to the pr to my repo - Click here

The pr was also adding functionality to parse .md files including the headings, bold, italics, links and strikethrough. It looked good at a first glance and the functionality mostly worked but I ended up finding a few issues after looking closely.
The biggest problem was that

paragraphs were not being generated for non-headings. This was obviously an big problem which I need to highlight.
Also, it rendered bold using and italics using which is not the best way to markup emphasis. So I suggested that bold should instead use and italics should instead use .
My last suggestion was not a bug, but since the PR was also implementing the syntax support for links, I wanted to make sure that it also supported automatic links i.e. links within angled braces should be rendered to an anchor tag.
I highlighted these and requested changes when I added my review to the pr. I look forward to reviewing the pr again once these changes are made.

Unused variables

Issue #1 There are some defined variables that never used in the code. const yargs = require("yargs"); const path = require("path"); These two variables are never used in the code, so I suggested my partner to remove them.