staticSiteCon VS ssg-cli-tool

I released a project I was working on. It's the static site generator I have been mentioning in some of the past blog posts. I use released it as a npm package, as it's written in JavaScript. You can find it here.

PR to another repo: https://github.com/cychu42/staticSiteCon/pull/21 My partner's repo and testing setup was very similar to my own. The main difference was that they used multiple testing files which kept things more organized. In hindsight, I probably should've done the same thing to keep things cleaner.

For my static site generator, I was trying to set up tests that can be ran easily. I mean, it takes effort to run the same test manually and hope you don't forget to test all the specifics. Don't worry, you can can set up tests to run with one command instead!

Part of open source approach is that you can learn from others when allowed. The licence used by Docusaurus is MIT, so one is allowed to copy its features if the license is kept. For my static site generator here, I also uses MIT licence, so it matches. I decided to take ideas from Docusaurus's ability to parse links because I already have a bit of features in that direction, it's rather crucial, and I already have some idea of what I can do to make it happen.

I tried to refactor my code for my static site generator, with this commit.

To address two changes I wanted to add to the static site generator I talked about in previous posts, I first opened one issue for each: 1 2 Then, I made a branch to work on for each them: 1 2 Spoiler: I did merge them back to the main branch, as you can see!

Accepting Contribution For my repo, Alexander opened an issue to add features to support .md input files and bolded text from those files into HTML files.

For this lab, I decided to contribute to cychu42's static site generator project. So, I forked his project into my own repo and began working on it

First, I connected with Chen-Yuan through a post he created on Slack regarding seeking a peer code tester and reviewer for his tool called staticSiteCon. Since it uses NodeJS and Javascript, It was not difficult to test and review the code.

What is it? Recently, I’m working a static site generator using JavaScript . What it does is that it takes TXT files to convert into HTML web pages. You can find it here. I name it the TXT-to-HTML Static Site Converter...Yeah, I never claim to be good with names. It's a bit of struggle between being practical and creative. I use the minimist module to handle options for the program.

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.