locomotivemtl / locomotive-boilerplate

🚂 Front-end boilerplate for projects by Locomotive.
https://locomotivemtl-boilerplate.vercel.app/
MIT License
455 stars 71 forks source link

Add prettier formatter with basic configuration options #140

Open devenini opened 1 year ago

devenini commented 1 year ago

This pull request introduces an opinionated coding formatter configuration using Prettier. The biggest reason for adopting Prettier is to stop all the ongoing debates over styles and provide consistency across styles and scripts. The implementation is straightforward, requiring only periodic running of the npm run precommit command to enforce the coding style. Including Prettier in the dev dependencies also ensures that all contributors can use it regardless of their chosen IDE.

Here's the current configuration:

{
    "trailingComma": "es5",
    "tabWidth": 4,
    "useTabs": false,
    "singleQuote": true,
    "semi": false
}

Please note that we will also need to keep the .editorconfig file up-to-date and ensure that both configurations are aligned.

This pull request focuses solely on the introduction of a formatter, and does not include a linter. The naming of the branch may suggest otherwise, but adding a linter is a separate matter that will be addressed in a future pull request.

cloudflare-pages[bot] commented 1 year ago

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8f3034d
Status: âœ…  Deploy successful!
Preview URL: https://754ba5d9.locomotive-boilerplate.pages.dev
Branch Preview URL: https://feature-add-linter-prettier.locomotive-boilerplate.pages.dev

View logs