octo VS txt2html

{ "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:

Hello all, this week I have to add a Testing Framework to my program-SSG. By doing this, I will be able to test different pieces of my code. Moreover, I also have a basic concept about how to test a program. My program is still small compare to others project, which is super convenient when we know how to test it, and what to test. Let's get started!

I pick Prettier for my project. It will help me fix any format issue and make my code look "prettier" as its name. In order to install it, I type:

As I catch up the concept of Docusaurus as well as knowing what it is, I choose a feature from it and add it into my SSG. I file an issue inside my repo, which is adding full markdown support for my SSG. The reason why I choose this is because I partially implement the heading to

The first thing I need to do is make sure I update everything from my Github into my local machine. Then I create another branch named refactoring, and I will do my changes in this branch, which will not affect any things in my original code.

After he is done his task with my code and send me a pull request, I reviewed it and pulled his code into my machine, I was kind of surprised because a new logic was applied into my code and there were so much things for me to learn. Reviewing a Pull Request by fetching to my local machine is way effective than checking it on Github. Once I satisfy with the new feature, I merge his work to my main branch.

This week I have to add another two features in my program, which is inline code block and horizontal rule. To be honest, I am able to know Git can do so many things out there, working with multiple branches in parallel is an example of this week.

Additionally, he uses Visual Studio to do his code, so when I clone his code to my machine and open it in Visual Code, I have to install C/C++ extension, but he does not mention it in his instruction. Other than that, his code is short and explained, which is easy for me to catch what is happening in this program. Kien also comes up with some issues I have in my program. Initially, I put all the text file into a single paragraph tag, I fix this one by correcting regex in my function, I mix up [] and () in my program.

At first, I have some difficulties to run his code. I need to install some required packages to run (which not specify in the README). After all, everything goes fine to test his code. He has few issues on his code. He put all the text file into a single paragraph tag. He has not specify detailed packages needed to install to run the program on README. His code is organized but he needs few comments to explain how it works. The optional features about external stylesheet and specifying output folder work great. I would list some errors or recommendations to improve his code in the Issue Page on his repository: https://github.com/tcvan0707/txt2html/issues/1

View soure code on GitHub