These are the style guidelines for coding in Electron.
You can run
npm run lint to show any style issues detected by
Place requires in the following order:
Place class properties in the following order:
Avoid platform-dependent code:
path.join()to concatenate filenames.
/tmpwhen you need to reference the temporary directory.
Using a plain
return when returning explicitly at the end of a function.
The Python version we are using now is Python 2.7.
The C++ code uses a lot of Chromium's abstractions and types, so it's recommended to get acquainted with them. A good place to start is Chromium's Important Abstractions and Data Structures document. The document mentions some special types, scoped types (that automatically release their memory when going out of scope), logging mechanisms etc.
You can run
npm run lint-docs to ensure that your documentation changes are
file_name.js, because in github/atom module names are usually in the
module-nameform. This rule only applies to
Use newer ES6/ES2015 syntax where appropriate
Electron APIs uses the same capitalization scheme as Node.js:
When creating a new API, it is preferred to use getters and setters instead of
jQuery's one-function style. For example,
are preferred to
.text([text]). There is a
discussion on this.