Skip to content

Code Style

thomran edited this page Mar 8, 2021 · 6 revisions

Code style

This page gives an overview of the decided code styles for this project and how they are enforced.

ESLint

ESLint is used to error-check code and avoid bugs. The ESLint rules are defined in the .eslintrc.js file.

Prettier

Prettier is a helpful tool to keep code in the same format globally within the project. Its rules are defined in the .prettierrc.js file.

Restyled commits

When pushing new code, both ESLint and Prettier must verify the code to keep the codebase consistent. If the code is not verified in such a way, restyled commits will set up a pull request with the changes needed for the code to pass the aforementioned programs.