/
style.pdc
450 lines (317 loc) · 9.39 KB
/
style.pdc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
% Felix's Node.js Style Guide
There is no official document that governs the style of node.js applications.
This guide is my opinionated attempt to bring you a good set of instructions that
will allow you to create beautiful and consistent software.
This guide assumes that you are only targeting node.js. If your code also needs
to run in the browser or other environments, please ignore some of it.
Please also note that node.js, as well as various packages for it, have
their own slightly different styles. So if you're interested in contributing
to those, play by their rules.
## Tabs vs Spaces
Let's start with the religious problems first. Our [benevolent dictator][ryah]
has chosen 2 space indention for the node core, so you would do well to follow
his choice.
[ryah]: community.html#ryan-dahl
## Semicolons
There are [rebellious forces][isaac] that try to steal your semicolons from
you. But make no mistake, our traditional culture is still [well and truly
alive][hnsemicolons]. So follow the community, and use those semicolons!
[isaac]: community.html#isaac-schlueter
[hnsemicolons]: http://news.ycombinator.com/item?id=1547647
## Editors
You can use any editor. However, having support for JS syntax highlighting and
executing the currently open file with node.js will come in very handy. While
[vim][vim] may not help you to impress the ladies or gents, it will please our
[BDFL][bdfl] and your grandpa will also approve.
I'm typing this document in Notes on my iPad, but that's because I'm on a beach
in Thailand. It's likely that your own work environment will impact your choice
of editor as well.
[vim]: http://www.vim.org/
[bdfl]: http://en.wikipedia.org/wiki/BDFL
## Trailing whitespace
Just like you brush your teeth after every meal, you clean up any trailing
whitespace in your JavaScript files before committing. Otherwise the rotten
smell of careless neglect will eventually drive away contributors and/or
co-workers.
## Line length
Limit your lines to 80 characters. Yes, screens have gotten much bigger over the
last few years, but your brain hasn't. Use the additional room for split screen,
your editor supports that, right?
## Quotes
Use single quotes, unless you are writing JSON.
*Right:*
~~~ {.javascript}
var foo = 'bar';
~~~
*Wrong:*
~~~ {.javascript}
var foo = "bar";
~~~
## Braces
Your opening braces go on the same line as the statement.
*Right:*
~~~ {.javascript}
if (true) {
console.log('winning');
}
~~~
*Wrong:*
~~~ {.javascript}
if (true)
{
console.log('losing');
}
~~~
Also, notice the use of whitespace before and after the condition statement.
## Variable declarations
Declare one variable per var statement, it makes it easier to re-order the
lines. Ignore [Crockford][crockfordconvention] on this, and put those
declarations wherever they make sense.
*Right:*
~~~ {.javascript}
var keys = ['foo', 'bar'];
var values = [23, 42];
var object = {};
while (items.length) {
var key = keys.pop();
object[key] = values.pop();
}
~~~
*Wrong:*
~~~ {.javascript}
var keys = ['foo', 'bar'],
values = [23, 42],
object = {},
key;
while (items.length) {
key = keys.pop();
object[key] = values.pop();
}
~~~
[crockfordconvention]: http://javascript.crockford.com/code.html
## Variable and property names
Variables and properties should use [lower camel case][camelcase]
capitalization. They should also be descriptive. Single character variables and
uncommon abbreviations should generally be avoided.
*Right:*
~~~ {.javascript}
var adminUser = db.query('SELECT * FROM users ...');
~~~
*Wrong:*
~~~ {.javascript}
var admin_user = d.query('SELECT * FROM users ...');
~~~
[camelcase]: http://en.wikipedia.org/wiki/camelCase#Variations_and_synonyms
## Class names
Class names should be capitalized using [upper camel case][camelcase].
*Right:*
~~~ {.javascript}
function BankAccount() {
}
~~~
*Wrong:*
~~~ {.javascript}
function bank_Account() {
}
~~~
## Constants
Constants should be declared as regular variables or static class properties,
using all uppercase letters.
Node.js / V8 actually supports mozilla's [const][const] extension, but
unfortunately that cannot be applied to class members, nor is it part of any
ECMA standard.
*Right:*
~~~ {.javascript}
var SECOND = 1 * 1000;
function File() {
}
File.FULL_PERMISSIONS = 0777;
~~~
*Wrong:*
~~~ {.javascript}
const SECOND = 1 * 1000;
function File() {
}
File.fullPermissions = 0777;
~~~
[const]: https://developer.mozilla.org/en/JavaScript/Reference/Statements/const
## Object / Array creation
Use trailing commas and put *short* declarations on a single line. Only quote
keys when your interpreter complains:
*Right:*
~~~ {.javascript}
var a = ['hello', 'world'];
var b = {
good: 'code',
'is generally': 'pretty',
};
~~~
*Wrong:*
~~~ {.javascript}
var a = [
'hello', 'world'
];
var b = {"good": 'code'
, is generally: 'pretty'
};
~~~
## Equality operator
Programming is not about remembering [stupid rules][comparisonoperators]. Use
the triple equality operator as it will work just as expected.
*Right:*
~~~ {.javascript}
var a = 0;
if (a === '') {
console.log('winning');
}
~~~
*Wrong:*
~~~ {.javascript}
var a = 0;
if (a == '') {
console.log('losing');
}
~~~
[comparisonoperators]: https://developer.mozilla.org/en/JavaScript/Reference/Operators/Comparison_Operators
## Extending prototypes
Do not extend the prototypes of any objects, especially native ones. There is a
special place in hell waiting for you if you don't obey this rule.
*Right:*
~~~ {.javascript}
var a = [];
if (!a.length) {
console.log('winning');
}
~~~
*Wrong:*
~~~ {.javascript}
Array.prototype.empty = function() {
return !this.length;
}
var a = [];
if (a.empty()) {
console.log('losing');
}
~~~
## Conditions
Any non-trivial conditions should be assigned to a descriptive variable:
*Right:*
~~~ {.javascript}
var isAuthorized = (user.isAdmin() || user.isModerator());
if (isAuthorized) {
console.log('winning');
}
~~~
*Wrong:*
~~~ {.javascript}
if (user.isAdmin() || user.isModerator()) {
console.log('losing');
}
~~~
## Function length
Keep your functions short. A good function fits on a slide that the people in
the last row of a big room can comfortably read. So don't count on them having
perfect vision and limit yourself to ~10 lines of code per function.
## Return statements
To avoid deep nesting of if-statements, always return a functions value as early
as possible.
*Right:*
~~~ {.javascript}
function isPercentage(val) {
if (val < 0) {
return false;
}
if (val > 100) {
return false;
}
return true;
}
~~~
*Wrong:*
~~~ {.javascript}
function isPercentage(val) {
if (val >= 0) {
if (val < 100) {
return true;
} else {
return false;
}
} else {
return false;
}
}
~~~
Or for this particular example it may also be fine to shorten things even
further:
~~~ {.javascript}
function isPercentage(val) {
var isInRange = (val >= 0 && val <= 100);
return isInRange;
}
~~~
## Named closures
Feel free to give your closures a name. It shows that you care about them, and
will produce better stack traces:
*Right:*
~~~ {.javascript}
req.on('end', function onEnd() {
console.log('winning');
});
~~~
*Wrong:*
~~~ {.javascript}
req.on('end', function() {
console.log('losing');
});
~~~
## Nested Closures
Use closures, but don't nest them. Otherwise your code will become a mess.
*Right:*
~~~ {.javascript}
setTimeout(function() {
client.connect(afterConnect);
}, 1000);
function afterConnect() {
console.log('winning');
}
~~~
*Wrong:*
~~~ {.javascript}
setTimeout(function() {
client.connect(function() {
console.log('losing');
});
}, 1000);
~~~
## Callbacks
Since node is all about non-blocking I/O, functions generally return their
results using callbacks. The convention used by the node core is to reserve the
first parameter of any callback for an optional error object.
You should use the same approach for your own callbacks.
## Object.freeze, Object.preventExtensions, Object.seal, with, eval
Crazy shit that you will probably never need. Stay away from it.
## Getters and setters
Do not use setters, they cause more problems for people who try to use your
software than they can solve.
Feel free to use getters that are free from [side effects][sideeffect], like
providing a length property for a collection class.
[sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science)
## EventEmitters
Node.js ships with a simple EventEmitter class that can be included from the
'events' module:
~~~ {.javascript}
var EventEmitter = require('events').EventEmitter;
~~~
When creating complex classes, it is common to inherit from this EventEmitter
class to emit events. This is basically a simple implementation of the
[Observer pattern][].
[Observer pattern]: http://en.wikipedia.org/wiki/Observer_pattern
However, I strongly recommend that you never listen to the events of your own
class from within it. It isn't natural for an object to observe itself. It often
leads to undesirable exposure to implementation details, and makes your code
more difficult to follow.
## Inheritance / Object oriented programming
Inheritance and object oriented programming are subjects by themselves.
If you're interested in following this popular programming model, please read my
[Object oriented programming guide][].
[Object oriented programming guide]: object_oriented_programming.html