forked from ryanmcdermott/clean-code-javascript
-
Notifications
You must be signed in to change notification settings - Fork 60
/
README.md
2223 lines (1853 loc) · 58.4 KB
/
README.md
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Repositori original : [ryanmcdermott/clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript)
# clean-code-javascript (Bahasa Indonesia)
## Daftar Isi
1. [Kata Pengantar](#kata-pengantar)
2. [Variabel](#variabel)
3. [Fungsi](#fungsi)
4. [Objek dan Struktur Data](#objek-dan-struktur-data)
5. [Class](#class)
6. [SOLID](#solid)
7. [Pengujian](#pengujian)
8. [Concurrency](#concurrency)
9. [Penanganan Kesalahan](#penanganan-kesalahan)
10. [Menyusun Format](#menyusun-format)
11. [Komentar](#komentar)
12. [Alih Bahasa](#alih-bahasa)
## Kata Pengantar
![Gambar lucu dari estimasi kualitas perangkat lunak sebagai hitungan berapa
banyak umpatan yang keluar saat membaca kode](http://www.osnews.com/images/comics/wtfm.jpg)
Prinsip Rekayasa Perangkat Lunak, oleh Robert C. Buku
[*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) oleh Martin,
diadaptasi untuk JavaScript. Perlu diingat bahwa panduan ini bukan tentang gaya
penulisan kode. Panduan ini lebih tentang membuat perangkat lunak yg [mudah dibaca,
dapat digunakan kembali, dan mudah direfaktor kembali](https://github.com/ryanmcdermott/3rs-of-software-architecture)
dalam bahasa Javascript.
Tidak semua prinsip disini harus diikuti secara ketat, dan bahkan lebih sedikit
akan lebih mudah disepakati bersama. Ini hanyalah panduan-panduan saja dan tidak
lebih, tetapi panduan-panduan ini dikodifikiasi selama bertahun-tahun dari
pengalaman kolektif penulis buku *Clean Code*.
Rekayasa-rekayasa perangkat lunak kita baru berumur 50 tahun lebih sedikit. dan
kita masih belajar banyak. Ketika arsitektur perangkat lunak setua arsitektur itu
sendiri, mungkin kita memiliki aturan yang lebih ketat untuk diikuti. Untuk saat
ini, biarkan panduan ini berfungsi sebagai batu ujian (touchstone) untuk mengukur
kualitas kode JavaScript yang kamu dan tim kamu buat.
Satu hal lagi: mengetahui hal ini bukan berarti membuat kamu menjadi seorang
pengembang perangkat lunak (*developer*) yg baik secara tiba-tiba, dan bekerja dengannya
bukan berarti kamu tidak akan membuat kesalahan-kesalahan. Setiap potongan kode
dimulai sebagai draft pertama, seperti tanah liat basah yg terus dibentuk menjadi
bentuk terakhirnya. Akhirnya, kita memahat ketidaksempurnaan ketika kita
me-*-nya kembali dengan teman dalam tim kita. Apabila draft pertamamu butuh
perbaikan, jangan pukul dirimu sendiri. Pukul Kodenya !
## **Variabel**
### Gunakan nama-nama variabel yg bermakna dan mudah diucapkan
**Buruk:**
```javascript
const yyyymmdstr = moment().format('YYYY/MM/DD');
```
**Baik:**
```javascript
const currentDate = moment().format('YYYY/MM/DD');
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Gunakan kosakata yang sama untuk jenis variabel yang sama
**Buruk:**
```javascript
getUserInfo();
getClientData();
getCustomerRecord();
```
**Baik:**
```javascript
getUser();
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Gunakan nama yg mudah dicari kembali
Kita akan lebih banyak membaca kode daripada menulisnya. Maka penting hukumnya
menulis kode untuk mudah dibaca dan mudah dicari. Dengan *tidak* memberi nama
variabel yang bermakna untuk memahami program kita, kita menyakiti pembaca kode
kita. Buat nama variabel lebih mudah dicari. Alat seperti
[buddy.js](https://github.com/danielstjules/buddy.js) dan
[ESLint](https://github.com/eslint/eslint/blob/660e0918933e6e7fede26bc675a0763a6b357c94/docs/rules/no-magic-numbers.md)
dapat membantu mengidentifikasi konstanta yg tidak diberi nama.
**Buruk:**
```javascript
// Nah kan, 86400000 itu untuk apa?
setTimeout(blastOff, 86400000);
```
**Baik:**
```javascript
// tulis `const` dalam huruf kapital dan secara global
const MILLISECONDS_IN_A_DAY = 86400000;
setTimeout(blastOff, MILLISECONDS_IN_A_DAY);
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Gunakan variabel penjelas
**Buruk:**
```javascript
const address = 'One Infinite Loop, Cupertino 95014';
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityZipCode(address.match(cityZipCodeRegex)[1], address.match(cityZipCodeRegex)[2]);
```
**Baik:**
```javascript
const address = 'One Infinite Loop, Cupertino 95014';
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari Mental Mapping
Explisit lebih baik daripada implisit.
**Buruk:**
```javascript
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((l) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// Sebentar, `l` itu untuk apa lagi?
dispatch(l);
});
```
**Baik:**
```javascript
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((location) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch(location);
});
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Jangan menambahkan konteks yang tidak dibutuhkan
Jika nama class/objek kamu memiliki arti tertentu, jangan mengulanginya di dalam
nama variabel.
**Buruk:**
```javascript
const Car = {
carMake: 'Honda',
carModel: 'Accord',
carColor: 'Blue'
};
function paintCar(car) {
car.carColor = 'Red';
}
```
**Baik:**
```javascript
const Car = {
make: 'Honda',
model: 'Accord',
color: 'Blue'
};
function paintCar(car) {
car.color = 'Red';
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Gunakan argumen default daripada `short circuiting` dan `kondisional`
Argumen *default* lebih bersih daripada `shoot circuiting`. Sadarilah jika kamu
menggunakannya, fungsimu hanya akan memberikan nilai *default* untuk argumen `undefined`.
Selain nilai "falsy" seperti `''`, `""`, `false`, `null`, `0`, dan `NaN`, tidak
digantikan oleh nilai *default*.
**Buruk:**
```javascript
function createMicrobrewery(name) {
const breweryName = name || 'Hipster Brew Co.';
// ...
}
```
**Baik:**
```javascript
function createMicrobrewery(breweryName = 'Hipster Brew Co.') {
// ...
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
## **Fungsi**
### Argumen Fungsi (idealnya hanya 2 atau kurang)
Membatasi jumlah parameter dari fungsi sangatlah penting karena membuat pengujian
fungsi menjadi lebih mudah. Memiliki lebih dari 3 parameter dapat mengakibatkan
ledakan kombinasional dimana kamu harus menguji banyak sekali kasus-kasus yg
berbeda di tiap-tiap argumen secara terpisah.
Satu atau dua argumen adalah kasus yg ideal, jika tiga maka sebaiknya dihindari.
Apapun lebih dari itu harus dikonsolidasikan. Biasanya, jika kamu memiliki lebih
dari dua argumen maka fungsimu melakukan hal yg terlalu banyak. Di beberapa kasus
dimana hal itu tidak terjadi, seringkali objek tingkat-tinggi sudah cukup untuk
dijadikan sebuah argumen.
JavaScript memperbolehkanmu untuk membuat objek secara langsung, tanpa membuat
banyak *class* terlebih dahulu. kamu dapat menggunakan sebuah objek jika kamu
mendapati bahwa kamu memerlukan banyak argumen.
Lebih jelasnya, kamu dapat menggunakan destructuring syntax pada ES2015/ES6. Hal
tersebut memiliki beberapa kelebihan:
1. Ketika seseorang melihat fungsi, fungsi tersebut secara langsung menjelaskan
properti-properti apa saja yg digunakan.
2. Merestrukturisasi juga mengkloning nilai primitif yang ditentukan dari objek
argumen yang dilewatkan ke fungsi. Hal ini dapat membantu mencegah efek samping.
Sebagai Catatan: objek dan *array* yg telah didestrukturisasi dari argumen objek
tidak di kloning.
3. Linters dapat memberi peringatan kepadamu tentang properti yg tidak digunakan,
yg mana akan lebih tidak mungkin tanpa merestrukturisasi.
**Buruk:**
```javascript
function createMenu(title, body, buttonText, cancellable) {
// ...
}
```
**Baik:**
```javascript
function createMenu({ title, body, buttonText, cancellable }) {
// ...
}
createMenu({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
});
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Fungsi harus melakukan satu hal saja
Ini adalah aturan terpenting dalam rekayasa perangkat lunak. Ketika fungsi melakukan
lebih dari satu hal, mereka sulit untuk dibuat, diuji dan dipikirkan. Ketika kamu
dapat mengisolasi sebuah fungsi untuk melakukan satu *action* saja, mereka dapat
difaktorkan secara mudah dan kodemu akan jauh lebih bersih. Jika kamu tidak mengambil
apapun dari panduan ini selain hal ini, maka kamu akan ada di depan banyak pengembang.
**Buruk:**
```javascript
function emailClients(clients) {
clients.forEach((client) => {
const clientRecord = database.lookup(client);
if (clientRecord.isActive()) {
email(client);
}
});
}
```
**Baik:**
```javascript
function emailActiveClients(clients) {
clients
.filter(isActiveClient)
.forEach(email);
}
function isActiveClient(client) {
const clientRecord = database.lookup(client);
return clientRecord.isActive();
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Nama dari fungsi harus mewakili apa yg dia lakukan
**Buruk:**
```javascript
function addToDate(date, month) {
// ...
}
const date = new Date();
// sulit untuk mengatakan dari nama fungsi yg ditambahkan
addToDate(date, 1);
```
**Baik:**
```javascript
function addMonthToDate(month, date) {
// ...
}
const date = new Date();
addMonthToDate(1, date);
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Fungsi-fungsi seharusnya satu tingkat abstraksi
Ketika kamu memiliki lebih dari satu tingkat abstraksi, fungsimu biasanya melakukan
hal yg terlalu banyak. Memisah-misah fungsi dapat meningkatkan reusabilitas dan
memudahkan pengujian.
**Buruk:**
```javascript
function parseBetterJSAlternative(code) {
const REGEXES = [
// ...
];
const statements = code.split(' ');
const tokens = [];
REGEXES.forEach((REGEX) => {
statements.forEach((statement) => {
// ...
});
});
const ast = [];
tokens.forEach((token) => {
// lex...
});
ast.forEach((node) => {
// parse...
});
}
```
**Baik:**
```javascript
function tokenize(code) {
const REGEXES = [
// ...
];
const statements = code.split(' ');
const tokens = [];
REGEXES.forEach((REGEX) => {
statements.forEach((statement) => {
tokens.push( /* ... */ );
});
});
return tokens;
}
function lexer(tokens) {
const ast = [];
tokens.forEach((token) => {
ast.push( /* ... */ );
});
return ast;
}
function parseBetterJSAlternative(code) {
const tokens = tokenize(code);
const ast = lexer(tokens);
ast.forEach((node) => {
// parse...
});
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hapus kode yg duplikat
Lakukan yg terbaik untuk menghindari kode yg duplikat. Kode yg duplikat itu Buruk
karena berarti terdapat lebih dari satu tempat untuk diubah jika kamu perlu
mengubah beberapa *logic*.
Bayangkan jika kamu memiliki sebuah restoran dan kamu harus terus melacak inventarismu:
tomat, bawang, cabe, dan lain-lain. Nah, Jika kamu memiliki beberapa daftar yg kamu
simpan, maka kamu harus mengubah itu semua ketika kamu menyajikan hidangan yg ada
tomatnya. Jika kamu hanya memiliki satu daftar saja, maka kamu hanya perlu mengubahnya
di satu tempat saja.
Seringkali kamu memiliki kode yg duplikat karena kamu memiliki dua atau lebih
hal-hal yg sedikit berbeda, memiliki banyak hal yg sama, namun perbedaan itu
memaksamu untuk memisahkan dua atau lebih fungsi yg berbeda namun kebanyakan
melakukan hal yg sama. Membuang kode yg duplikat berarti membuat sebuah
abstraksi yg dapat menangani hal yg berbeda dengan satu fungsi/modul/class.
Mendapatkan abstraksi yg benar sangat penting, itulah kenapa kamu harus mengikuti
prinsip SOLID yg ada setelah bagian *Class*. Abstraksi yg buruk dapat lebih buruk
daripada kode yg duplikat, jadi berhati-hatilah! Setelah diberitahu hal ini, kamu
dapat membuat abstraksi yg baik, lakukan! Jangan membuat dirimu mengulang (DRY),
Jika tidak, kamu akan mendapati dirimu memperbarui hal dibeberapa tempat setiap
kali kamu ingin mengubah satu hal.
**Buruk:**
```javascript
function showDeveloperList(developers) {
developers.forEach((developer) => {
const expectedSalary = developer.calculateExpectedSalary();
const experience = developer.getExperience();
const githubLink = developer.getGithubLink();
const data = {
expectedSalary,
experience,
githubLink
};
render(data);
});
}
function showManagerList(managers) {
managers.forEach((manager) => {
const expectedSalary = manager.calculateExpectedSalary();
const experience = manager.getExperience();
const portfolio = manager.getMBAProjects();
const data = {
expectedSalary,
experience,
portfolio
};
render(data);
});
}
```
**Baik:**
```javascript
function showEmployeeList(employees) {
employees.forEach((employee) => {
const expectedSalary = employee.calculateExpectedSalary();
const experience = employee.getExperience();
let portfolio;
switch (employee.type) {
case 'manager':
portfolio = employee.getMBAProjects();
break;
case 'developer':
portfolio = employee.getGithubLink();
break;
}
const data = {
expectedSalary,
experience,
portfolio
};
render(data);
});
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Tetapkan default objects dengan Object.assign
**Buruk:**
```javascript
const menuConfig = {
title: null,
body: 'Bar',
buttonText: null,
cancellable: true
};
function createMenu(config) {
config.title = config.title || 'Foo';
config.body = config.body || 'Bar';
config.buttonText = config.buttonText || 'Baz';
config.cancellable = config.cancellable !== undefined ? config.cancellable : true;
}
createMenu(menuConfig);
```
**Baik:**
```javascript
const menuConfig = {
title: 'Order',
// Pengguna tidak memasukkan key 'body'
buttonText: 'Send',
cancellable: true
};
function createMenu(config) {
config = Object.assign({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
}, config);
// config sekarang sama dengan: {title: "Order", body: "Bar",
// buttonText: "Send", cancellable: true}
// ...
}
createMenu(menuConfig);
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Jangan gunakan flag sebagai parameter fungsi
Flag memberitahu penggunamu bahwa fungsi ini melakukan lebih dari satu hal. Fungsi seharusnya melakukan satu hal. Pisahkan fungsimu jika mereka
mengikuti jalur kode yg berbeda berdasarkan boolean.
**Buruk:**
```javascript
function createFile(name, temp) {
if (temp) {
fs.create(`./temp/${name}`);
} else {
fs.create(name);
}
}
```
**Baik:**
```javascript
function createFile(name) {
fs.create(name);
}
function createTempFile(name) {
createFile(`./temp/${name}`);
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari Efek Samping (bagian 1)
Sebuah fungsi memproduksi efek samping ketika dia melakukan apapun selain memasukkan
nilai dan mengembalikan nilai. Sebuah efek samping bisa berupa menulis ke sebuah
*file*, memodifikasi sebuah variabel global, atau secara tidak sengaja mentransfer
semua uangmu ke orang yg tidak kamu kenal.
Sekarang, kamu memang perlu memiliki efek samping dalam sebuah program pada
suatu kesempatan. Seperti pada contoh sebelumnya, kamu bisa jadi perlu untuk
menulis sebuah *file*. Apa yg akan kamu lakukan adalah memusatkan dimana kamu
melakukan ini. Tidak memiliki beberapa fungsi dan *class* yang menulis ke
*file* tertentu. Miliki satu *service* yg melakukan hal itu. Satu dan satu-satunya.
Poin utama untuk menghindari jebakan yg umum seperti berbagi *state* antara objek
tanpa struktur apapun, menggunakan tipe data yg *mutable* yg dapat ditulis ke
apapun, dan tidak memusatkan dimana efek samping tersebut muncul. Jika kamu dapat
melakukan hal ini, kamu akan lebih bahagia daripada programmer-programmer
kebanyakan.
**Buruk:**
```javascript
// Variabel global direferensi oleh beberapa fungsi
// Jika kita mempunyai fungsi lain yg menggunakan nama variabel ini, sekarang akan menjadi array dan dapat merusak ini semua.
let name = 'Ryan McDermott';
function splitIntoFirstAndLastName() {
name = name.split(' ');
}
splitIntoFirstAndLastName();
console.log(name); // ['Ryan', 'McDermott'];
```
**Baik:**
```javascript
function splitIntoFirstAndLastName(name) {
return name.split(' ');
}
const name = 'Ryan McDermott';
const newName = splitIntoFirstAndLastName(name);
console.log(name); // 'Ryan McDermott';
console.log(newName); // ['Ryan', 'McDermott'];
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari Efek Samping (bagian 2)
Dalam JavaScript, primitif dilewatkan oleh nilai dan objek / *array* dilewatkan
melalui referensi. Dalam kasus dimana objek dan *array*, jika fungsimu membuat
perubahan di *array* keranjang belanja, sebagai contoh, dengan menambahkan
sebuah barang untuk pembelian, maka fungsi lain yg menggunakan *array* `keranjang`
akan terpengaruh dengan penambahan ini. Hal itu mungkin bagus, namun bisa
jadi hal yg buruk jg. Mari kita mengimajinasikan situasi berikut:
Pengguna menekan "Beli", tombol yg memanggil fungsi `beli` yg memunculkan
permintaan jaringan dan mengirim *array* `keranjang` ke server. Karena
koneksi jaringan yg buruk, fungsi `beli` harus terus mencoba request kembali.
Sekarang, bagaimana jika di waktu yg sama si pengguna secara tidak sengaja
menekan tombol "Tambahkan ke Keranjang" pada barang yg sedang tidak mereka
inginkan sebelum *request* jaringan dimulai? Jika hal itu terjadi dan *request*
jaringan dimulai, maka fungsi beli tersebut akan mengirimkan tambahan barang
secara tidak sengaja karena hal itu mereferensi ke *array* keranjang belanja
yg mana fungsi `addItemToCart` dimodifikasi dengan menambahkan barang yg
tidak diinginkan.
Solusi yg bagus bisa jadi `addItemToCart` harus selalu mengkloning `cart`,
mengeditnya, dan mengembalikan klonnya. Ini memastikan bahwa tidak ada fungsi
lain yang memegang referensi keranjang belanja akan terpengaruh oleh perubahan
apapun.
Dua keberatan yg disebutkan pada pendekatan ini:
1. Terdapat beberapa kasus dimana kamu benar-benar ingin memodifikasi objek
masukan, namun ketika kamu menggunakan praktek pemrograman ini kamu akan
menemukan bahwa kasus tersebut sangatlah langka. Kebanyakan apapun yg
refaktorkan tidak memiliki efek samping.
2. Kloning objek-objek yg besar dapat sangat mahal dalam hal performa.
Beruntungnya, hal ini bukan isu yg besar dalam prakteknya karena terdapat
*library* seperti [great libraries](https://facebook.github.io/immutable-js/)
yg memperbolehkan pendekatan pemrograman seperti ini lebih cepat dan
tidak terlalu banyak memakan *memory* seperti mengkloning objek-objek dan
*array* secara manual.
**Buruk:**
```javascript
const addItemToCart = (cart, item) => {
cart.push({ item, date: Date.now() });
};
```
**Baik:**
```javascript
const addItemToCart = (cart, item) => {
return [...cart, { item, date : Date.now() }];
};
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Jangan menulis fungsi global
Mencemari hal yg bersifat global adalah praktek yg buruk di JavaScript karena
kamu dapat berbenturan dengan *library* yg lain dan pengguna dari API-mu tidak
akan menjadi yg bijak sampai mereka mendapatkan *exception* di *production*.
Mari berpikir tentang sebuah contoh: Bagaimana jika kamu ingin memperpanjang
metode *Array* asli JavaScript untuk memiliki metode `diff` yang dapat menunjukkan
perbedaan antara dua *array*? Kamu dapat menulis fungsi barumu ke `Array.prototype`,
tapi hal tersebut dapat berbenturan dengan *library* lain yang mencoba melakukan
hal yang sama. Bagaimana jika *library* lainnya sudah menggunakan `diff` untuk
mencari perbedaan antara elemen pertama dan terakhir dalam sebuah *array*? Inilah
kenapa lebih baiknya menggunakan *class* ES2015/ES6 dan secara sederhana
memperpanjang global `Array`.
**Buruk:**
```javascript
Array.prototype.diff = function diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
};
```
**Baik:**
```javascript
class SuperArray extends Array {
diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
}
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Gunakan functional programming daripada imperative programming
JavaScript bukanlah sebuah bahasa fungsional seperti Haskell, namun dia memiliki
aroma fungsional juga. Bahasa yg fungsional lebih sederhana dan lebih mudah
diuji. Gunakan gaya pemrograman seperti ini sebisa mungkin.
**Buruk:**
```javascript
const programmerOutput = [
{
name: 'Uncle Bobby',
linesOfCode: 500
}, {
name: 'Suzie Q',
linesOfCode: 1500
}, {
name: 'Jimmy Gosling',
linesOfCode: 150
}, {
name: 'Gracie Hopper',
linesOfCode: 1000
}
];
let totalOutput = 0;
for (let i = 0; i < programmerOutput.length; i++) {
totalOutput += programmerOutput[i].linesOfCode;
}
```
**Baik:**
```javascript
const programmerOutput = [
{
name: 'Uncle Bobby',
linesOfCode: 500
}, {
name: 'Suzie Q',
linesOfCode: 1500
}, {
name: 'Jimmy Gosling',
linesOfCode: 150
}, {
name: 'Gracie Hopper',
linesOfCode: 1000
}
];
const INITIAL_VALUE = 0;
const totalOutput = programmerOutput
.map((programmer) => programmer.linesOfCode)
.reduce((acc, linesOfCode) => acc + linesOfCode, INITIAL_VALUE);
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Enkapsulasi Kondisional
**Buruk:**
```javascript
if (fsm.state === 'fetching' && isEmpty(listNode)) {
// ...
}
```
**Baik:**
```javascript
function shouldShowSpinner(fsm, listNode) {
return fsm.state === 'fetching' && isEmpty(listNode);
}
if (shouldShowSpinner(fsmInstance, listNodeInstance)) {
// ...
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari Kondisional Negatif
**Buruk:**
```javascript
function isDOMNodeNotPresent(node) {
// ...
}
if (!isDOMNodeNotPresent(node)) {
// ...
}
```
**Baik:**
```javascript
function isDOMNodePresent(node) {
// ...
}
if (isDOMNodePresent(node)) {
// ...
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari Kondisional
Ini terlihat seperti pekerjaan yg tidak mungkin. Sejak pertama kali mendengar
hal ini, kebanyakan orang berkata "Bagaimana saya bisa bekerja tanpa sebuah
statemen `if` ?" Jawabannya aalah kamu bisa menggunakan polimorfisme untuk
mengerjakan hal-hal di berbagai kasus. Pertanyaan kedua biasanya, "Oke itu bagus
tapi kenapa aku harus melakukannya?" Jawabannya adalah kode yg bersih seperti
apa yg sudah kita pelajari sebelumnya: sebuah fungsi harus melakukan satu hal
saja. Ketika kamu memiliki *class* dan fungsi yang memiliki statemen `if`, kamu
memberitahu pengguna bahwa fungsimu melakukan hal yg lebih dari satu. Ingat, hanya
lakukan satu hal saja.
**Buruk:**
```javascript
class Airplane {
// ...
getCruisingAltitude() {
switch (this.type) {
case '777':
return this.getMaxAltitude() - this.getPassengerCount();
case 'Air Force One':
return this.getMaxAltitude();
case 'Cessna':
return this.getMaxAltitude() - this.getFuelExpenditure();
}
}
}
```
**Baik:**
```javascript
class Airplane {
// ...
}
class Boeing777 extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude() - this.getPassengerCount();
}
}
class AirForceOne extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude();
}
}
class Cessna extends Airplane {
// ...
getCruisingAltitude() {
return this.getMaxAltitude() - this.getFuelExpenditure();
}
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari type-checking (bagian 1)
JavaScript tidak memiliki tipe data, yang mana fungsimu dapat mengambil tipe
data apapun dari sebuah argumen. Terkadang kamu tergigit karena kebebasan ini
dan menjadi tergoda untuk melakukan *type-checking* pada fungsimu. Terdapat
banyak jalan untuk terhindar dari hal ini. Hal pertama yg harus dipertimbangkan
adalah memiliki API yg konsisten.
**Buruk:**
```javascript
function travelToTexas(vehicle) {
if (vehicle instanceof Bicycle) {
vehicle.pedal(this.currentLocation, new Location('texas'));
} else if (vehicle instanceof Car) {
vehicle.drive(this.currentLocation, new Location('texas'));
}
}
```
**Baik:**
```javascript
function travelToTexas(vehicle) {
vehicle.move(this.currentLocation, new Location('texas'));
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hindari type-checking (bagian 2)
Jika kamu bekerja dengan nilai primitif sederhana seperti *string*, *integer* dan
*array*, dan kamu tidak bisa menggunakan polimorfisme tapi kamu tetap merasa
perlu untuk melakukan *type-check*, kamu harus mempertimbangkan untuk menggunakan
TypeScript. Itu merupakan alternatif yg sangat baik untuk JavaScript biasa, yg
mana menyediakanmu *static typing* diatas standar sintaks JavaScript. Masalah
dengan *type-checking* secara manual di Javascript adalah hal itu memerlukan
banyak kata tambahan palsu yang merusak readibilitas. Pastikan JavaScript-mu
bersih, tulis pengujian yang baik, dan memiliki kode review yang bagus.
Jika tidak, lakukan semuanya dengan TypeScript (yang mana, seperti apa yang
aku katakan, itu adalah sebuah alternatif yang sangat bagus)
**Buruk:**
```javascript
function combine(val1, val2) {
if (typeof val1 === 'number' && typeof val2 === 'number' ||
typeof val1 === 'string' && typeof val2 === 'string') {
return val1 + val2;
}
throw new Error('Must be of type String or Number');
}
```
**Baik:**
```javascript
function combine(val1, val2) {
return val1 + val2;
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Jangan Optimasi Berlebihan
Browser-browser yang modern melakukan banyak optimisasi dibalik layar di *runtime*.
Seringkali, kamu mengoptimasi dan kamu hanya menghabiskan waktumu. [Terdapat
Sumber yg bagus](https://github.com/petkaantonov/bluebird/wiki/Optimization-killers)
untuk dilihat dimana optimasi itu kurang. Targetkan mereka sementara,
sampai mereka diperbaiki jika mereka bisa melakukannya.
**Buruk:**
```javascript
// Di Browser lama, setiap iterasi dengan `list.length` yg uncached akan sangat costly
// karena `list.length` menghitung ulang. Di browser yang modern, ini sudah teroptimasi
for (let i = 0, len = list.length; i < len; i++) {
// ...
}
```
**Baik:**
```javascript
for (let i = 0; i < list.length; i++) {
// ...
}
```
**[⬆ Kembali ke atas](#daftar-isi)**
### Hapus kode mati
Kode yg mati akan sama buruknya dengan kode yang duplikat. Tidak ada alasan untuk menyimpannya
dalam basis kode-mu. Bisa dibuang jika tidak digunakan, kode akan tetap tersimpan
di "version history" jika kamu membutuhkannya lagi.
**Buruk:**
```javascript
function oldRequestModule(url) {
// ...
}
function newRequestModule(url) {
// ...
}
const req = newRequestModule;
inventoryTracker('apples', req, 'www.inventory-awesome.io');
```
**Baik:**
```javascript
function newRequestModule(url) {
// ...
}
const req = newRequestModule;
inventoryTracker('apples', req, 'www.inventory-awesome.io');
```
**[⬆ Kembali ke atas](#daftar-isi)**
## **Objek dan Struktur Data**
### Gunakan getters dan setters
Menggunakan getters dan setter untuk mengakses data di objek akan lebih baik
daripada sekedar mencari sebuah properti dari objek, "Kenapa?" kamu mungkin
bertanya. Baik, terdapat daftar yg tidak teratur sebagai alasan:
* Ketika kamu ingin melakukan hal lebih dari sekedar mendapatkan properti objek,
kamu tidak harus mencari dan mengubah setiap aksesor di basis kode-mu.
* Buat menambahkan validasi sederhana ketika melakukan sebuah `set`.
* Enkapsulasi representasi internal.
* Memudahkan untuk tambah catatan dan penanggulangan kesalahan ketika getting
dan setting.
* Kamu bisa lazy load properti-properti dari objek, seperti mendapatkannya dari
server.
**Buruk:**
```javascript
function makeBankAccount() {
// ...
return {
balance: 0,
// ...
};
}
const account = makeBankAccount();
account.balance = 100;
```
**Baik:**
```javascript
function makeBankAccount() {
// yg satu ini privat
let balance = 0;
// sebuah "getter", dibuat publik via objek yg dikembalikan di bawah ini
function getBalance() {
return balance;
}
// sebuah "setter", dibuat publik via objek yg dikembalikan di bawah ini
function setBalance(amount) {
// ... validasi sebelum memperbarui balance
balance = amount;
}
return {
// ...