octo VS the-great-site-generator

{ "name": "octo-ssg", "version": "0.1.0", "description": "A tool that allows you to generate static sites based off of text data.", "main": "bin/app.js", "bin": { "octo": "./bin/app.js" }, "scripts": { "prepare": "husky install", "start": "node ./bin/app.js", "build": "npm run prettier && npm run eslint-fix && npm run eslint", "test": "jest", "coverage": "jest --coverage", "eslint": "npx eslint .", "eslint-fix": "eslint --fix .", "prettier": "prettier --write .", "prettier-check": "prettier --check ." }, "repository": { "type": "git", "url": "git+https://github.com/LuigiZaccagnini/octo.git" }, "keywords": [ "ssg", "static", "site", "generator" ], "author": "Luigi Zaccagnini (https://luigizaccagnini.com/)", "license": "GPL-3.0-or-later", "bugs": { "url": "https://github.com/LuigiZaccagnini/octo/issues" }, "homepage": "https://github.com/LuigiZaccagnini/octo#readme", "dependencies": { "boxen": "^4.2.0", "chalk": "2.4", "enzyme": "^3.9.0", "react": "^16.8.6", "react-dom": "^16.8.6", "react-test-renderer": "^17.0.2", "showdown": "^1.9.0", "yargs": "^17.2.1" }, "devDependencies": { "eslint": "^8.1.0", "husky": "^7.0.4", "jest": "^27.3.1", "prettier": "2.4.1" } }

This week, I choose Luigi octo to work on. He has 14 stars for his project so it a bit pressure but I will take it. You can check out my PR-20

Welcome to another post about my project Octo! In this blog I am going to go over:

I have choose this project to add more tests into it. I see Luis does not have tests for textToHTML function yet, so I decide to add it for him, and then I create a pull request with three successful pass in nodes. My testing still needs to be improved a lot because it takes some times to think about it, and I would love to add more tests into my program covering all aspects of it.

Hello! Welcome to another blog post about my open source project Octo. If you're new to my blogs, Octo is an open source static site generation tool created by me! Today I am going to review the process of writing tests and explain how I implemented them in my project.

Welcome to another blog post about the journey of Octo, the open source tool for static site generation! Today I will be going over how I added static analysis tooling into the project and how you can do the same for your open source projects!

Now that I have Markdown finished for Octo I have filed some issues for the next steps of what I would like to be down for the tool. Some of the features I want are:

Hello Everyone! Welcome to my weekly blog post about my journey in Open Source. This week I will be focusing on my experience with refactoring my code for Octo and working with the rebasing feature with Git. I also wanted to share that while writing these blog posts, I will also be posting about Hacktoberfest every week until the end of October so be sure to read those blog posts as well.

First of all, I head into his repo and create another issue telling him what I am going to improve his code. This new feature would allow the ability to use a configuration file within the SSG to allow users specifying the config file instead of typing a long argument. Once he assigns me to the issue, I start to do my work as soon as possible. To be honest, the way he writes his code is completely different from my logic, so it is quite hard for me to understand what is going on inside there. It took me a few hours completing my task. One thing I noticed in his code was that he declared the type for parameter separately, which I should practice how to do this inside my future code. Then I sent him a pull request, we had a conversation to discuss about how we can fix the code and he could merge my code into his branch.

Welcome to my blog post about merging multiple features with my personal project! This time around I will be talking about the two new features I added to the Octo project. The two new features I added are:

This week I focused on creating an initial v1.0 release of the project, The Great Site Generator. I was able to use Conan and Gitlab to create the release by following their guide. At first, I tried vcpkg, but found I couldn't get it to work with Gitlab. Conan was able to work well with CMake and did not require too much work. I was happy to see my project finally added to the Gitlabs registry. I had to alter my code before this release. I wanted to ensure my code looked like it was ready and added another function to get rid of the remaining global variables. I asked one of my fronds, who is not in my program, to test out my initial release by following the README.md. They did not seem to have any trouble following it, except for requiring assistance to install Conan. In order to try out TGSG, you can use the following command. conan install the-great-site-generator/1.0@root+the-great-site-generator/stable --remote=gitlab--remote=gitlab

After setting up my own CI and ensuring everything was working properly I teamed up with Andrew Tassone to work on his SSG. I added a new test case to his that would check for proper markdown conversion with the

This week I focused on adding a tester to my project. I chose to use Google Test as I have read it is a very popular tester for C++. Google Test cam be used easily with CMake which was also being used in this project. I setup the tester by changing the CMakeLists.txt which can download the Google Test folder to the root directory by only using FetchContent_Declare. While writing the test cases, I learned that it was more difficult than I had expected. I made sure my tests checked that the HTML output files were correct by reading the file and comparing it to the correct lines. I got stuck trying to get CMake to compile correctly. I eventually figured out that I did not have the correct executable files listed.

This week I focused on adding clang-format to my code to have better consistency when other developers are contributing. I chose this as it has a VSCode extension and works very well with C++ which is what my project is written in.

I wanted to reduce redundancy in my code so I created a function called readFolder() for reading folders. I also combined readMarkdownFile() into readFile(). This supports both file types of either .txt or .md.

I will be working on adding more features soon. If you'd like to contribute, you can fork it on Github

I had an easy time finding a partner to work with this week on Slack, but unfortunately I was transported to hospital for an unexpected injury. Oh the pain... Life is like a box of chocolates I suppose. Anyway, when I got back, my partner had already helped add markdown features to my project. I had forked his project before but unfortunately, someone else had already worked on markdown. I had fun fixing issues within my own project. I did run into a few issues like being unsure how to use CMake. I eventually figured it out with some research and was able to add versioning, as well as cross compatibility. I was surprised to learn about new features in C++17 that make cross platform much easier such as std::filesystem::path

Welcome to the weekly blog post about my open source journey! This weeks topic will be about adding a feature to a new an open source repository. The repository we will be working on this week will be The Great Site Generator.

Here are the links to both repository issues: Octo the-great-site-generator

You can read more about The GREAT Site Generator and how to use it on Github.