simple-ssg1 VS SSGulnur

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 )

Today, I created the first release for my SSGulnur tool.

This will create a configuration yaml file in your .github/workflows folder which will explain Github what and when to do to your repo changes.

For my PR I did basic tests checking the functions for unexpected output.

I also updated my CONTRIBUTING.md, so the future contributors find instructions for testing.

configure the rules and options to customize the look, e.g., .prettierrc

I filed a new issue and started working on it on the new branch. I saved every step as commits which I squashed into one later. Everything went as planned and the implementation took me about what I expected, as I was not creating anything new myself and was only working on integrating an existing tool into my project.

Issue URL

I also received an issue on my repo with my SSG tool. I labeled it as an enhancement as it was not a necessary part but good to have. I checked the PR and realized that there was a need for a few changes by testing the work. For that, I added them as a remote to my local repo, fetched and set a tracking branch. I contacted the author of PR through Slack and explained all necessary updates. I also summarized them in the PR itself as things to do, so I remember what to check for when everything is ready.

First feature that I was interested in implementing was adding markdown bold and link syntax features support. As always, I created an issue about my solution and a branch in which I worked on it.

Issue #1 is a bug connected to file reading and quotation marks. Basically, all quotation marks needed to be converted into the escape characters in order to be processed correctly and not as end of the string.