search

ferreiro / website

🌐 Jorge Ferreiro personal website and blog fully developed in Javascript and Node.Js. It uses Yarn Workspaces to setup the package architecture. Currently migrating the project to ⚛️ React
https://jorgeferreiro.com/
MIT License
60 stars 9 forks source link

Add Prettier to the project #48

Open ferreiro opened 5 years ago

ferreiro commented 5 years ago

Right now there is not automate code style checker for the project. This issue is about to fix that and ensure a consistency across the codebase.

Options:

A) Prettier

While I was checking the react documentation on how to contribute they use Prettier in their codebase. I didn't know the project so I searched on their website and discovered that is really popular and kind of a standard in the community.

B) ESLint

I've checked this blog post about famous JS linters and ESLint looks like number one: https://hackernoon.com/what-javascript-code-style-is-the-most-popular-5a3f5bec1f6f#5858

ferreiro commented 5 years ago

@kwelch What do you think about Prettier? What's the linter that you like most?

kwelch commented 5 years ago

Prettier is a styling formatter and I love it.

ESlint is also great, but I recommend using the eslint-plugin-prettier to ensure all styling based rules are off and leave that work to prettier. Eslint can be very helpful in finding errors and avoiding variable mixups.

Typescript is another good option in this area as it help avoid a lot of confusion, but the setup is a bit larger since it needs to be supported by the infra where as prettier and eslint both run off to the side.