Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 2.03 KB

CodeStyle.md

File metadata and controls

19 lines (12 loc) · 2.03 KB
Raw

Code style

In this repository—our newest front-end repository at Tidepool—our JavaScript style is much stricter than in our other repositories, largely because we started the work and continue to develop with a very strict ESLint configuration, borrowed from AirBnb.

It is not worth duplicating a description of the vast number of constraints that this configuration imposes. Our advice is to configure your editor to provide instant linting feedback as you code1, and you will learn the constraints quite quickly 😜

To summarize in general the constraints that the AirBnb ESLint configuration imposes:

  • ES2015/ES6 given preference over ES5 (so const and let over var, etc.)
  • lots of general code quality/bug prevention constraints like no unused variables, no mutating arguments to functions, etc.
  • React components that don't need a (substantive) constructor, any of the lifecycle methods, or component-internal state should be pure functional components instead of classes
  • all React components should type-check the props used via PropTypes

We have also added an additional plug-in for enforcing a preference for lodash utility methods over their native implementations (e.g., lodash _.map instead of JavaScript Array.map).

Also see the documentation on directory structure for our conventions around file naming, placement, and in particular our semantic division between "containers" and "components."

Footnotes

  1. And you don't even have to Google! Here's where to get started for Sublime Text and Atom. ↩