Standards & Principles

PreviousIntroduction NextIntegrating with ME v1.12.x

Last updated 6 years ago

Code Standards

All code MUST be written in American English (i.e. variable/method/class names, etc).

ES6 / ECMA2015 MUST be used in .

Classes MUST be defined with ES6 class syntax.

Each class MUST be declared in its own file.

Code MUST NOT be placed outside of a class or VueJS component definition.

Code MUST NOT be placed in the global namespace.

A semicolon (;) is REQUIRED at the end of all expressions (including VueJS component definitions).

Abbreviations in class/method/function names MUST NOT be all uppercase.

Good: MyJsonMethod

Bad: ~~MyJSONMethod~~

All variables MUST be declared on their own line.

Custom tag names defined by a VueJS component MUST adhere to the (all-lowercase, must include a hyphen).

Code block length MUST be limited for readability, reusability, and focused reasoning:

Classes SHOULD NOT exceed 300 lines and MUST NOT exceed 500 lines.

Functions/methods SHOULD NOT exceed 50 lines and MUST NOT exceed 150 lines.

On Dependencies

External dependencies SHOULD only be used when absolutely necessary. Instead, prefer a stable and unified codebase.

All external dependencies MUST be wrapped in an interface class to limit coupling to a single location in the code base.

An external dependency MUST NOT be used directly in application code.

For example, use the ElentraJS/Http/RestClient instead of Fetch API or Axios directly. This allows us to swap out either library with zero refactoring of the code base.

Web APIs that are not yet fully standardized MUST be wrapped in an interface class to enable easy updates if the spec changes.

Standards & Principles

Standards & Principles

Definitions

Code Standards

On Dependencies

Design Principles

Definitions

Code Standards

On Dependencies

Design Principles