OSD600-SSG VS octo

Repo: https://github.com/nguyenhung15913/OSD600-SSG Jest: https://jestjs.io/

Sample docusaurus site: https://nguyenhung15913.github.io/OSDdocusaurus/ Static-site generator tool: https://github.com/nguyenhung15913/OSD600-SSG

The first thing I did was to create an issue after forking OSD600-SSG

Project repo: https://github.com/nguyenhung15913/OSD600-SSG Issue-11: https://github.com/nguyenhung15913/OSD600-SSG/issues/12 Final merge main with issue-11: https://github.com/nguyenhung15913/OSD600-SSG/commit/c9f72f123133250897eef3e27a0f5c0df3e3145d#diff-e8ba56b7852a747928456dd8ad6bc1c92a747d806b5feb04e59563044567484c Issue-12:https://github.com/nguyenhung15913/OSD600-SSG/issues/13 Final merge main with issue-12: https://github.com/nguyenhung15913/OSD600-SSG/commit/72efea5358c4b1423e1b7394d286b225930dc785#diff-e8ba56b7852a747928456dd8ad6bc1c92a747d806b5feb04e59563044567484c

The project I chose to work on is OSD600-SSG, written by Hung. I am interested in this project because it is written in JS and I would love to learn more about it. I contributed to the project by adding the new feature to accept markdown file. The first challenge I had was adding new code without breaking his old code. His coding style is different from mine so it took some time to learn the logic flow of the code. Luckily, Hung was really nice and he even encouraged me to change his code. The second challenge I had was working with regular expression. I needed to transfer the emphasis sentence in markdown file to html bold text. In a markdown file, to bold the middle of a word for emphasis, you need to add two asterisks without spaces around the letters. I added an extra space to my finding pattern and it was hard to find this bug. In the end, I successfully added the new feature to the project. After testing it on my local computer, I created a pull request and got accepted by Hung. My PR

Luigi's Octo: https://github.com/LuigiZaccagnini/octo Octo's Markdown issue: https://github.com/LuigiZaccagnini/octo/issues/7 Pull request to Octo: https://github.com/LuigiZaccagnini/octo/pull/8 My OSD600-SSG: https://github.com/nguyenhung15913/OSD600-SSG OSD600-SSG Markdown issue: https://github.com/nguyenhung15913/OSD600-SSG/issues/10 Emily's pull request: https://github.com/nguyenhung15913/OSD600-SSG/pull/11

Hung's program is called OSD600-SSG and it is similar to mine in functionality. I found the process of testing the program pretty straightforward. I cloned it, I followed the instructions on the README and everything worked as expected.

One of my program's problems is it accepts all files. For example, if you have an input.md, my program can still read it and export an html file, while it is supposed to receive only .txt file. On top of that, Menghi recommended me to fix the outputs so it will export files with specific names instead of just index1.html, index2.html, etc. Detail: https://github.com/nguyenhung15913/OSD600-SSG/issues

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