This repository contains configurations for different linters that apply Veriff's code style rules and best practices.
To apply this code style in your project you need to configure necessary liters. This repository has 3 packages for ESLint, Stylelint, and Prettier with extensive guides how to set them up for any kind of project. Check README's of the packages you need:
In general, the code you write must be clean, clear, flexible, and consistent. To achieve it we created a ruleset for linters that enforce the best practices and code style conventions.
We prefer TypeScript over JavaScript because strict typing allows to avoid entire class of bugs as well as simplify maintenance.
We follow Airbnb style guide for JavaScript / TypeScript / React projects as well as some necessary best practices
included into eslint/recommended and typescript-eslint/recommended ruleset-s.
In addition to enforcing the standard code style, these rules are meant to catch common problems and insist on following
important best practices such as required explicit types and banning any.
There are specific rules for tests written with Jest and/or Testing Library. They prevent common mistakes and help writing better tests.
Considering the strictness of the current version of the code style, the minimal configurations for ESLint are also
provided. If it is not possible to migrate the project to the code style right away, then you could start with
integrating the minimal version of it.
It enforces the best practices and helps avoid common issues, but does not include Airbnb style guide. More details are in the eslint-config package's README.
The most important rule here is to use our design system Genoma as much as possible, it will simplify the development process as well as improve design consistency across different products.
In case you have to do some custom styles, at first, choose SCSS Modules over plain CSS. Make it compliant with SCSS Guidelines. It is useful and reasonable.
We also follow the standard style guide, 8-point-grid and enforce to use variables for colors. It helps with consistency and clarity.