CodeBuddies Documentation
Search…
Code Contribution
Walkthroughs
Other
5/ Coding Style Guidelines
Standard JS - The Rules
- 2 spaces - for indentation
- Single quotes for strings - except to avoid escaping
- No unused variables - this one catches tons of bugs!
- Never start a line with
(,[,or`!- This is the only gotcha with omitting semicolons - they are automatically checked for you!
- Space after keywords:
if (condition) {...} - Space after function name:
function name (arg) { ... } - Always use
===instead of==- The use of
obj == nullis allowed to check fornull || undefined
- Always handle the
node.js errfunction parameter - Always prefix browser globals with
window- Except for
documentandnavigator, which are okay.- This prevents accidental use of poorly-named browser globals like
open, length, event,andname.
To get a better idea, take a look at a sample file written in JavaScript Standard Style. Or, check out one of the thousands of projects that use
standard!
Refactoring
An example of refactoring from JavaScript to ES2015
Use the ecmascript package
ecmascript packageECMAScript, the language standard on which every browser’s JavaScript implementation is based, has moved to yearly standards releases... Meteor’s
ecmascript package compiles this standard down to regular JavaScript that all browsers can understand using the popular Babel compiler. It’s fully backwards compatible to “regular” JavaScript, so you don’t have to use any new features if you don’t want to. We’ve put a lot of effort into making advanced browser features like source maps work great with this package, so that you can debug your code using your favorite developer tools without having to see any of the compiled output.The
ecmascript package is included in all new apps and packages by default, and compiles all files with the .js file extension automatically. See the list of all ES2015 features supported by the ecmascript package.To get the full experience, you should also use the
es5-shim package which is included in all new apps by default. This means you can rely on runtime features like Array#forEach without worrying about which browsers support them.Follow a JavaScript style guide
Code Contribution - Previous
4/ Submitting a Pull Request
Next - Code Contribution
6/ Dealing with Merge Conflicts
Last modified 3yr ago