Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 2.92 KB

CODING_STANDARD.md

File metadata and controls

100 lines (66 loc) · 2.92 KB
Raw

Vircadia Web SDK Coding Standard

File Locations

The source code is kept in the /src directory.

Unit and integration tests are kept in the /tests directory.

  • Test files have the same relative path and file name as the source code files they test.
  • Unit tests have file extensions .unit.test.js.
  • Integration tests have file extensions .integration.test.js.

General Rules

The Vircadia Coding Standard should be followed, where applicable.

Unix line endings (LF, 0A character) are used.

Linting Rules

A quite strict set of TypeScript and ESLint rules is configured to help avoid common pitfalls and ensure a consistent style to aid maintenance:

  • tsconfig.json
  • .eslintrc.js

TypeScript Conventions

Private, Protected, and Public

JavaScript's # should be used for private members (not TypeScript's private) so that their privacy is enforced at runtime.

TypeScript's protected may be used in internal SDK code where necessary to make internal members available to derived classes. However, protected should not be used in classes that are part of the public API (because when transpiled to JavaScript, protected in effect becomes public).

Document Return Types

Methods' return types should always be explicitly specified even if TypeScript can automatically determine the return type from the current code — the code may change and any changes in the return type should be flagged.

Validate Public API Values

Function parameter values and property values must be validated before being used — e.g., that they're of the expected type. Note that for property values, this means that setters must be used.

Unused function parameters

TODO

Implementation Patterns

File Code Order

Code in a file should be ordered as follows:

  • Imports. In directory order then alphabetical order, except where inheritance requires differently.
  • Public types.
  • Private types.

class {

  • JSDoc for types.
  • Public static items.
  • Protected static items.
  • Private static items.
  • Protected member variables.
  • Private member variables.
  • Constructor.
  • Public property setters and getters.
  • Public methods.
  • Public listeners.
  • Public slots.
  • Public signals' getters for.
  • Protected property setters and getters.
  • Protected methods.
  • Protected listeners.
  • Protected slots.
  • Protected signals' getters for.
  • Private methods.
  • Private listeners.
  • Private slots.
  • Private signals' getters for.

}

  • Exports.

JSDoc directly adjacent to type statements isn't recognized, hence why it is included inside the class { ... } or other top-level block.

Signals and slots, here, refer to the Qt-style signals and slots implemented by Signal in the /domain library files.

Following the C++

Code in the /domain library and associated API files should follow C++ equivalent code per DOMAIN.md.