OSD600-SSG VS ESLint

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

ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

Automating code checks with static code analysis allows us to enforce code styling effectively. By integrating tools into our workflow, we can identify errors at an early stage, while coding instead of blocking us at the end. For instance, flake8 checks Python code for style and errors, eslint performs similar checks for JavaScript, and prettier automatically formats code to maintain consistency.

If you're a developer, you're surely familiar with Prettier and ESLint. With over 8 years of existence, they have established themselves as references in the JavaScript ecosystem.

eslint is used to avoid code errors

No lint errors: The committed code does not contain any lint errors (eslint).

Let’s walk through the steps for a one-time setup to configure husky pre-commit and pre-push hooks, ESLint with code styles conventions, prettier code formatter, and lint-staged. Husky automatically runs a script on each commit or push. This is useful for linting files to enforce code styles that keeps the entire code base following conventions.

GitHub | Website

ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

ESLint

1. Lack of Static Code Analysis Static code analysis tools like TypeScript and ESLint play a crucial role in identifying and preventing bugs. TypeScript provides static typing, enhancing the robustness of the code. ESLint detects issues and enforces coding standards. The absence of these tools can significantly elevate the likelihood of bugs due to the lack of early detection and guidance provided during development.