mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #4706 from atom/update-styleguide

Browse source 
Remove CoffeeScript from styleguide
This commit is contained in:
Kevin Sawicki 2016-03-07 13:59:07 -08:00
commit 755c1f5238
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/development/coding-style.md
View file

@ -2,6 +2,9 @@
These are the style guidelines for coding in Electron. These are the style guidelines for coding in Electron.
You can run `npm run lint` to show any style issues detected by `cpplint` and
`eslint`.
## C++ and Python ## C++ and Python
For C++ and Python, we follow Chromium's [Coding For C++ and Python, we follow Chromium's [Coding
@ -17,17 +20,25 @@ document. The document mentions some special types, scoped types (that
automatically release their memory when going out of scope), logging mechanisms automatically release their memory when going out of scope), logging mechanisms
etc. etc.
## CoffeeScript ## JavaScript
For CoffeeScript, we follow GitHub's [Style
Guide](https://github.com/styleguide/javascript) and the following rules:
* Use a two space indent, no hard tabs.
* End lines with a `;`
* Files should **NOT** end with new line, because we want to match Google's * Files should **NOT** end with new line, because we want to match Google's
styles. styles.
* File names should be concatenated with `-` instead of `_`, e.g. * File names should be concatenated with `-` instead of `_`, e.g.
`file-name.coffee` rather than `file_name.coffee`, because in `file-name.js` rather than `file_name.js`, because in
[github/atom](https://github.com/github/atom) module names are usually in [github/atom](https://github.com/github/atom) module names are usually in
the `module-name` form. This rule only applies to `.coffee` files. the `module-name` form. This rule only applies to `.js` files.
* Use newer ES6/ES2015 syntax where appropriate
* [`const`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/const)
for requires and other constants
* [`let`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let)
for defining variables
* [Arrow functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions)
instead of `function () { }`
* [Template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
instead of string concatenation using `+`
## API Names ## API Names