OSD600-SSG VS Standard

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

I picked up standard[1] a while back for this reason, I don't want to have to think about it. It works fine, I have no complaints (took me a while to get used to not using semi-colons but now I prefer it) Same reason I use `cargo fmt` as well.

[1] https://standardjs.com/

# question 1: ? How would you like to use ESLint? … To check syntax only To check syntax and find problems ❯ To check syntax, find problems, and enforce code style # question 2: ? What type of modules does your project use? … ❯ JavaScript modules (import/export) CommonJS (require/exports) None of these # question 3: ? Which framework does your project use? … ❯ React Vue.js None of these # question 4 (select "No", because we won't add TypeScript support for this project): ? Does your project use TypeScript? › No / Yes # question 5: ? Where does your code run? … Browser ✔ Node # question 6: ? How would you like to define a style for your project? … ❯ Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) # question 7 (we'll rely on Airbnb's JavaScript style guide here): ? Which style guide do you want to follow? … ❯ Airbnb: https://github.com/airbnb/javascript Standard: https://github.com/standard/standard Google: https://github.com/google/eslint-config-google # question 8: ? What format do you want your config file to be in? … JavaScript YAML ❯ JSON # the final prompt here is where eslint will ask you if you want to install all the necessary dependencies. Select "Yes" and hit enter: Checking peerDependencies of eslint-config-airbnb@latest The config that you have selected requires the following dependencies: eslint-plugin-react@^7.21.5 eslint-config-airbnb@latest eslint@^5.16.0 || ^6.8.0 || ^7.2.0 eslint-plugin-import@^2.22.1 eslint-plugin-jsx-a11y@^6.4.1 eslint-plugin-react-hooks@^4 || ^3 || ^2.3.0 || ^1.7.0 ? Would you like to install them now with npm? › No / Yes

A Thin JavaScript Document Storage with Middleware Stack

https://github.com/standard/standard/issues/384

For example, if you use https://standardjs.com/ - it will error on your second code snippet and if you ask it for an autofix - it will transfer the minus sign to the first line.

In comparison, JavaScript doesn't have a strict coding standard, although it does have widely accepted code style guides like the Airbnb JavaScript Style Guide and the JavaScript Standard Style. These guides provide recommendations for code formatting and naming conventions, but they are not as strictly enforced as the Java coding standard.