ssg-cli-tool VS nan1-ssg

There was another repo I tried to add test for, and it uses the same setup as mine. It uses JavaScript and achieve CI via GitHub Action, except that it also run test for version 14.x and 16.x of Node.js. Given both repo use Jest for testing, It's pretty easy to write test for the repo. I needed to spend time to understand the code and then run test coverage and see the existing tests to see what's needed to be done.

Automated testing commit: https://github.com/alexsam29/ssg-cli-tool/commit/dff551f7690bf7caaa3db6902b934145df401853

For lab 7 in my open-source course (DPS909), we were asked to implement static analysis tools into our static site generator (SSG).

For lab 6 in my open-source course (DPS909) we were asked to explore features of another popular static site generator (SSG) called Docusaurus. After creating our own demo website using Docusaurus, we were asked to choose one feature that we would like into our own SSG project.

GitHub Repo: https://github.com/alexsam29/ssg-cli-tool Refactoring commit: https://github.com/alexsam29/ssg-cli-tool/commit/cb9bb6e4278680df99c9202ca17288703cebe885

I had an issue that was created on my repo that wanted to add similar feature.

This week I worked with Alex to add a new feature to our SSGs. This new feature was the ability to use a JSON config file to pass in options instead of typing in the options manually in the command line. I worked on Alex's repo.

I continued working on my Static Site Generator and decided to add two more features. I created issues for each feature that I wanted to add.

My Conbtirbution I openned an issue and made a corresponding pull request for an open source Static Site Generator project by Alexander Samaniego(alexsam29). The goal was to add support for parsing Markdown files into HTML files, while also supporting italicization for those. Of course, I needed to update the README.md to reflect the changes.

After completing release 0.1 of my static site generator and having that code reviewed by another person in lab 1. It was time to start contributing to other projects and to learn how to create PRs. In addition, it was a chance to put our code reviewing experience from lab 1 to work by reviewing other people's PRs and code changes on our own repo.

This week I added CI to my SSG. I used GitHub's CI service GitHub Actions to accomplish this. It was very easy to set up as I just had to find the Node.js workflow and add it.

This week I added some testing tools to my SSG. The project now uses Jest for testing. I chose to use Jest because it is a very popular testing framework for JavaScript. I contemplated using Mocha, but after doing some research, decided Jest was easier to use out of the box. Installing Jest was easy. All I had to do was install it using npm: npm install --save-dev jest.

This week I added some static analysis tools to my SSG. The tools I added are Prettier and ESLint. Prettier is a code formatter to make code consistent and ESLint checks your code for any common errors/warnings.

I also chose a feature from Docusaurus to add into my own SSG. The previous version of my SSG had some basic Markdown support, so I decided to upgrade my Markdown support by using an existing open source Markdown converter.

This week, I refactored my SSG repo to clean up my repo. Here is the commit.

I decided to collaborate with Neil and contribute to his static site generator.

This week, I continued to work on my SSG and I added two new features.

My Filed Issue

node_modules shouldn't be commited in git - In another class I took with Prof. Humphrey (CCP555), we learned about the importance of .gitignore files, and that the node_modules is a folder we should avoid committing to git.

This week, I created my own SSG (static site generator) called nan1-ssg using JavaScript and node.js. My SSG will generate .html files from .txt files as specified by the user.