Coding Standards

ESLint

We aspire to conform to the AirBnB ES6 Javascript Style Guide, and use ESLint to enforce compliance as much as possible with these recommendations.

You can run ESLint configured for AirBnB and Meteor from the command line as follows:

app$ meteor npm run lint

During active development, however, a much better way to enforce ESLint guidelines is to install ESLint into your editor. The ICS 314 instructions on ESLint in IntelliJ provides detailed instructions on run ESLint in IntelliJ.

Naming conventions

Directories are all lowercase, hyphens separate words. For example, degree-program.

Javascript classes are named in camel-case. For example, DegreeProgram.

Meteor methods should be placed in their own file, typically in a directory containing the definition of the Collection that they operate on. They should be named with the extension methods.js.

JSDoc conventions

All exported functions should have a JSDoc, and the associated file should have a JSDoc module declaration.

Internal functions might also have a JSDoc if they are sufficiently complicated.

All JSDocs need to supply an @memberOf so that they are associated with a namespace. The namespace corresponds to the directory path within the /imports directory (for example, "api/base").

Testing conventions

All complex functions should have an associated unit test.

Complex tests may need a DB fixture to be loaded in order to set up the DB state correctly.

Methods should have integration tests to ensure that client-server communication works properly.

See the Testing section for more details.

Import paths

There are two ways to specify import paths: absolute and relative.

Absolute:

import BaseInstanceCollection from '/imports/api/base/BaseInstanceCollection';

Relative:

import BaseInstanceCollection from '../base/BaseInstanceCollection';

Please use relative paths, because IntelliJ can perform completion and refactoring on relative paths but not absolute paths.

results matching ""

    No results matching ""