OSD_SSG VS yargs

In this post, I will be releasing my little static site generator tool, OSD_SSG, to NPM package manager.

This week lab brought me back working on my genius friend's git repo which you can check out his amazing work hereDukeManh - OSD_SSG

I started to create a Issue#8 on his code, and describe what markdown I will implement to his code. After that, I started to read through his code. It was coded in TypeScript which is the same as JavaScript but with types. The code workflow wasn't hard to follow. I implemented a function to process all markdown features. In that function, I'm calling all other process markdowns to change markdown to HTML. I also added some checks such as only accept .txt and .md. After finishing my code I created a pull request PR#9 and requested Duc Bui Manh to review my change. He gave me some feedback to change. I had some redundant code. After fixing it I pushed back to remote and re-request to review.

My partner developed his SSG on TypeScript. This meant that I had to install Nodejs on my Linux laptop, which is not a big deal to do with a package manager. However, my package manager references to an old version of Nodejs, specifically Nodejs version 10. Of course, I had to install the precompiled binaries from the Nodejs website with the most updated version, which was a little bit of hassle.

To explain for the title, I used to read a post where people interviewed Bill Gate and he has claimed that a good IT student should start to work on their deadlines one night before so as they can practice working under pressure. I did start my release 0.1 one night before the due date and did not recognize how rusty I am. I was panic and did not know where to start at all due to not coding for the whole summer. After that, I have a chance to connect with DukeManh on Slack and he helped me out a lot. You guys can visit his code at: OSD_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.