simple-ssg1 VS SiteGenerationTool

Today, I also reviewed and added a few tests to another project, which was a similar tool of my friend. I was a little happy when I realized that I have structured my work in an easy way for testing such as I have lots of isolated small functions. Meanwhile, my friend had to copy his main function and rewrite it to be able to test its logic. It was a little confusing at first to figure out how everything works and to find something testable, but because he was also using Node.js and Jest, it was manageable.

To set up workflow I added nodeJS.yml file that runs on any push or PR to main branch.

For my SSG tool I used Jest, because it was made for JavaScript language(language my tool is using) and pretty straightforward to use.

This week I've been setting up code formatters for my project.

I was adding a configuration option via -c or –config option, where it will accept a JSON file as config file to use the values inside instead of other options. It waseasy to plan for what and how I want to do, since it’s just about reading a file and using the variables. The hard part was figuring out how my code would be compatible with the repo I tried to add it to. I was working on this repo, and I opened an issue and filed a pull request. This static site generator tool doesn’t use any options but accept arguments directly, so I had to use minimist package to parse options. There are a few variables that aren’t listed in the config module, such as stylesheet url, so I added them and use the variables from the config module instead. I also ended up slightly rewriting the language option code so the program would actually use the code from the author. Overall, there where bits and pieces of code for other options that aren’t entirely functional as options, so I ended up rewriting them a bit for the configuration option to work.

Today I have been adding some features to the tool:

I created SSG tool that allows you to conver txt files into html. I was unable to fix some issues yet, but planning to make it better in the future. (https://github.com/mnosov622/simple-ssg1).

I have an issue with the location of the script. When person clones the project, and then runs it, the tool gives weird error, saying that he can't find the location of the specified txt file. ( https://github.com/mnosov622/simple-ssg1/issues/2 )

My pull request involved updating syntax for some files in order to modernize the code in the project. I've had minimal exposure to Python, only having worked on another student's SSG made in Python, so it was somewhat of a shift to understand the basics of Python syntax. There isn't much more to say at the moment, but I will update this post as I receive feedback from the maintainers and hopefully have my pull request merged.

Here is an example workflow from my class mate Rudy's recent PR to my repository where he added some testing to see that my CI was working: Successful actions run.

How did your partner's repo and testing setup differ from yours? I worked with sfrunza13 once again on his SSG. Even though he used Python and I used C++ for our projects, the tests were similar since they both accomplish the same task. With the understanding of the task being performed, the difference between languages did not matter significantly. Both the projects and tests were very similar. Although one significant difference was that my repo outsourced the Markdown parsing to a external module.

The issue that I filed for this:Replace index w navbar The commit:7435a0

For Lab 4, I added support for reading and parsing a JSON config file to Stefan's SSG.

In the third lab that we were assigned in my Opensource Dev course at Seneca we were taught how to checkout feature branches so that we can work on multiple features independently and how to later merge them all to the main branch and resolve conflicts. To do so we yet again used our simple site generators

The project I chose to contribute to was SiteGenerationTool by sfrunza13. I decided to add features to the project to be able to open .md files, and for .html files created using these files to have bold and italics Markdown indicators to be replaced with the appropriate HTML tags.

It turns out that writing SSG in python is not that complicated. (https://github.com/sfrunza13/SiteGenerationTool) The code that I was reading is very clear and concise, even if you are not very good at this language.

My first closed issue https://github.com/sfrunza13/SiteGenerationTool/issues/1