yargs VS mh-ssg

Your tool now automates project setup, but there's room for improvement. Consider adding more features or handling user input to customize the project structure. Explore packages like yargs for parsing command-line arguments. You can learn more about yargs through their official documentation here.

This code snippet uses yargs, a Node.js package, to parse command-line arguments in a POSIX-compliant way, including support for short and long-form options. You could also use the popular commander defined as a complete node.js command-line interface.

This feature was implemented by adding a new argument option -l or --lang in yargs as below.

Creating CLIs with yargs is a piece of cake. For LZ4 there is a streaming implementation on npm which is a single function and also happened to decompress my files without any errors. Everything else is out-of-box Node.js.

Backend is more tricky. - RESTful APIs I prefer Koajs - For a RPC/microsevice, I have only used gRPC - For a CLI, yargs and inquirer

To accomplish this task, I added a new option using the yargs module. This allows me to read whatever the user inputs after using -l/--l. Following this, I added a conditional statement that defaults to en-CA whenever a language code is not inputted.

You can build them from scratch, or use one of many specialized libraries on NPM, like commander, yargs, blessed, terminal kit, prompts, and many more.

This week, I've published my 1st package on npm - mh-ssg - a static site generator CLI.

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.

As new features are added to the tool, I realized that the logic is not clear anymore and some parts were duplicated, making it inefficient and hard to maintain. This time, I decided to focus on removing those duplications by moving the statements to the appropriate place and extracting function for reusability. All the refactoring was done through a single commit with the help of git rebase.

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.

In the last update, my friend - Dustin - helped to add Markdown as a valid input for my tool. Markdown syntaxes are different from HTML syntaxes and he has worked on converting some of them. This time I decided to add two more:

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.