SovTech Code Style Guide

Based off the AirBnB javascript style guide: A mostly reasonable approach to JavaScript

How to use this?

1. Read through the Guides and familiarise yourself with the content there.

2. Perform the Setups steps on your project

Style Guides

Javascript

Typescript

React

CSS-in-JavaScript

Commit messages

PR Descriptions

Tests

Linter and formatter setup

Install the relevant packages listed below and copy the .eslintrc.json, .editorconfig and .prettierrc files to your project root.

If you have a mono-repo setup you will need to copy these files to the package roots as well.

Create React App projects

CRA comes with eslint and some relevant packages already installed

yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-airbnb eslint-config-prettier eslint-config-react eslint-plugin-prettier

Other Typescript projects

yarn add -D eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-airbnb eslint-config-prettier eslint-plugin-prettier

Remove the references to React in the .eslintrc.json file

Something wrong?

Please send feedback via slack!

Further reading

Google JS Style Guide

Idomatic JS

React Typescript Cheatsheet