How to maintain 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:
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.
Typescript 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
Only use JSDoc comments /** */ for things we want to put in the API documentation. Use regular comments // or /* */ for coding instructions.
Even though we are using Typescript, JSDoc does not understand Typescript so we have to supply the types of the parameters and return values to get good documentation. For example
generates
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 Perform unit and integration testing for more details.
Import paths
There are two ways to specify import paths: absolute and relative.
Absolute:
Relative:
Please use relative paths, because IntelliJ can perform completion and refactoring on relative paths but not absolute paths.