These are the style guidelines for coding in Electron.
You can run
npm run lint to show any style issues detected by
C++ and Python
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.
- File names should be concatenated with
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 the module itself is a class like
- When the module is a set of APIs, like
- When the API is a property of object, and it is complex enough to be in a
separate chapter like
- For other non-module APIs, use natural titles, like
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.