JavaScript TypeScript Coding Standard

Rationale

To facilitate maintainability by a community of developers, all source code authored under the umbrella of the Simon Initiative should conform to a stated standard.

JavaScript code

Pure JavaScript code should conform to the AirBnb JavaScript coding stanard.

Highlights of this coding standard include:

• Use soft tabs (space character) set to 2 spaces
• ' characters for string literals instead of " characters
• { opening brace on same line as beginning of statement
• camelCase when naming objects, functions, and instances
• Use PascalCase only when naming constructors or classes.

TypeScript code

TypeScript code should also conform to the AirBnb JavaScript coding standard, as well as adhere to the following additional conventions:

• None yet

TSLint

This git repository is set up to automatically run tslint against commits to ensure adherence to the stated coding standards. In some rare cases it is necessary to bypass a specific tslint rule (notably in variable names of React functional components). Information about how to do that via comments can be found here

React code

React code should also conform to the AirBnb React coding standard