forked from ryanmcdermott/clean-code-javascript
-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.md
2092 lines (1698 loc) · 63.8 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
# clean-code-javascript
## Lista dei contenuti
- [**Lista dei contenuti**](#lista-dei-contenuti)
- [**Introduzione**](#introduzione)
- [**Variabili**](#variabili)
- [Utilizza nomi di variabili comprensibili e pronunciabili](#utilizza-nomi-di-variabili-comprensibili-e-pronunciabili)
- [Usa la stessa semantica per lo stesso tipo di variabili](#usa-la-stessa-semantica-per-lo-stesso-tipo-di-variabili)
- [Utilizza nomi che possano essere cercati](#utilizza-nomi-che-possano-essere-cercati)
- [Utilizza nomi di variabili esplicartivi](#utilizza-nomi-di-variabili-esplicartivi)
- [Evita mappe mentali](#evita-mappe-mentali)
- [Non contestualizzare inutilmente](#non-contestualizzare-inutilmente)
- [Utilizza i valori di default (predefiniti), anzichè usare condizioni o valutazioni minime](#utilizza-i-valori-di-default-predefiniti-anzichè-usare-condizioni-o-valutazioni-minime)
- [**Funzioni**](#funzioni)
- [Argomenti di una funzione (idealmente 2 o anche meno)](#argomenti-di-una-funzione-idealmente-2-o-anche-meno)
- [Un metodo dovrebbe fare una sola cosa](#un-metodo-dovrebbe-fare-una-sola-cosa)
- [I nomi delle funzioni dovrebbero farti capire cosa fanno](#i-nomi-delle-funzioni-dovrebbero-farti-capire-cosa-fanno)
- [Le funzioni dovrebbero avere un solo livello di astrazione](#le-funzioni-dovrebbero-avere-un-solo-livello-di-astrazione)
- [Rimuovi il codice duplicato](#rimuovi-il-codice-duplicato)
- [Estendi un oggetto con Object.assign](#estendi-un-oggetto-con-objectassign)
- [Non usare valori flag (true/false) come parametri di una funzione](#non-usare-valori-flag-truefalse-come-parametri-di-una-funzione)
- [Evitare effetti inattesi (parte 1)](#evitare-effetti-inattesi-parte-1)
- [Evitare effetti inattesi (parte 2)](#evitare-effetti-inattesi-parte-2)
- [Non aggiungere funzioni globali](#non-aggiungere-funzioni-globali)
- [Preferisci la programmazione funzionale a quella imperativa](#preferisci-la-programmazione-funzionale-a-quella-imperativa)
- [Incapsula le condizioni](#incapsula-le-condizioni)
- [Evita di verificare condizioni in negativo](#evita-di-verificare-condizioni-in-negativo)
- [Evita le condizioni](#evita-le-condizioni)
- [Evita la validazione dei tipi (parte 1)](#evita-la-validazione-dei-tipi-parte-1)
- [Evita la validazione dei tipi (part 2)](#evita-la-validazione-dei-tipi-part-2)
- [Non ottimizzare eccessivamente](#non-ottimizzare-eccessivamente)
- [Rimuovi il codice inutilizzato](#rimuovi-il-codice-inutilizzato)
- [**Oggetti e strutture dati**](#oggetti-e-strutture-dati)
- [Utilizza getter e setter](#utilizza-getter-e-setter)
- [Imposta proprietà private in un oggetto](#imposta-proprietà-private-in-un-oggetto)
- [**Classi**](#classi)
- [Utilizza le classi ES2015/ES6 piuttosto che le funzioni di ES5](#utilizza-le-classi-es2015es6-piuttosto-che-le-funzioni-di-es5)
- [Concatena i metodi](#concatena-i-metodi)
- [Preferisci una struttura compositiva all'ereditarietà](#preferisci-una-struttura-compositiva-allereditarietà)
- [**SOLID**](#solid)
- [Single Responsibility Principle (SRP) (Principio di singola responsabilità)](#single-responsibility-principle-srp-principio-di-singola-responsabilità)
- [Open/Closed Principle (OCP) (Principio aperto/chiuso)](#openclosed-principle-ocp-principio-apertochiuso)
- [Liskov Substitution Principle (LSP) (Principio di sostituzione di Liskov)](#liskov-substitution-principle-lsp-principio-di-sostituzione-di-liskov)
- [Interface Segregation Principle (ISP) (Principio di segregazione delle interfacce)](#interface-segregation-principle-isp-principio-di-segregazione-delle-interfacce)
- [Dependency Inversion Principle (DIP) (Principio di inversione delle dipendenze)](#dependency-inversion-principle-dip-principio-di-inversione-delle-dipendenze)
- [**Test**](#test)
- [Un singolo comportamento per test](#un-singolo-comportamento-per-test)
- [**Consequenzialità**](#consequenzialità)
- [utilizza le Promise, non funzioni di callback](#utilizza-le-promise-non-funzioni-di-callback)
- [Async/Await sono addirittura più chiari delle Promise](#asyncawait-sono-addirittura-più-chiari-delle-promise)
- [**Gestione degli errori**](#gestione-degli-errori)
- [Non ingnorare gli errori intercettati](#non-ingnorare-gli-errori-intercettati)
- [Non ignorare le Promise quando vengono rigettate](#non-ignorare-le-promise-quando-vengono-rigettate)
- [**Formattazione**](#formattazione)
- [Utilizza le maiuscole in modo consistente](#utilizza-le-maiuscole-in-modo-consistente)
- [Richiami e dichiarazioni di funzioni dovrebbero essere vicini](#richiami-e-dichiarazioni-di-funzioni-dovrebbero-essere-vicini)
- [**Commenti**](#commenti)
- [Commenta solo il codice che ha un alto livello di complessità](#commenta-solo-il-codice-che-ha-un-alto-livello-di-complessità)
- [Non lasciare parti del tuo codice commentate all'interno dei sorgenti](#non-lasciare-parti-del-tuo-codice-commentate-allinterno-dei-sorgenti)
- [Non utilizzare i commenti come un diario](#non-utilizzare-i-commenti-come-un-diario)
- [Evita di specificare di cosa si tratta](#evita-di-specificare-di-cosa-si-tratta)
- [Traduzioni](#traduzioni)
## Introduzione
![Immagine umoristica che rappresenta quanto sia possibile stimare la qualità di un software attraverso il numero di parolacce espresse durante la lettura del codice](http://www.osnews.com/images/comics/wtfm.jpg)
Principi di Ingegneria del Software, dal libro di Robert C. Martin
[*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882),
adattati a JavaScript.
Non si tratta di una guida stilistica, bensì di una guida per cercare di produrre software
[leggibile, riutilizzabile e rifattorizzabile](https://github.com/ryanmcdermott/3rs-of-software-architecture) in JavaScript.
Non tutti i principi di questa guida devono essere seguiti alla lettera, e solo alcuni sono universalmente condivisi. Sono linee guida e niente più, ma sono linee guida che derivano da anni di esperienza collettiva degli autori di *Clean code*.
Il nostro lavoro come ingegneri del software esiste da soli 50 anni, e stiamo ancora imparando molto. Quando l'architettura del software godrà della stessa anzianità dell'architettura in sé, probabilmente avremo regole più rigide da seguire. Per ora, facciamo sì che queste linee guida servano come termine di paragone per valutare la qualità del software che producete tu ed il tuo team.
Un'ultima cosa: conoscere queste regole non ti trasformerà immediatamente in uno sviluppatore migliore, e lavorare tenendole presenti, anche per tanti anni, non ti impedirà di commettere errori.
Ogni singola parte di codice nasce come una bozza, per poi prendere forma, proprio come una scultura di argilla.
Solo alla fine perfezioneremo il nostro software, revisionando il codice con i nostri colleghi. Non abbatterti se il codice iniziale si deve migliorare. Piuttosto, vacci giù duro con il codice!
## **Variabili**
### Utilizza nomi di variabili comprensibili e pronunciabili
**Da evitare**
```javascript
const yyyymmdstr = moment().format('YYYY/MM/DD');
```
**Corretto**
```javascript
const currentDate = moment().format('YYYY/MM/DD');
```
**[⬆ torna su](#lista-dei-contenuti)**
### Usa la stessa semantica per lo stesso tipo di variabili
**Da evitare**
```javascript
getUserInfo();
getClientData();
getCustomerRecord();
```
**Corretto**
```javascript
getUser();
```
**[⬆ torna su](#lista-dei-contenuti)**
### Utilizza nomi che siano facili da cercare
Leggiamo molto più codice di quanto ne scriviamo. È importante che il codice che produciamo sia leggibile e consultabile. Se non assegnamo un nome a variabili importanti per capire il nostro software, infastidiamo chi lo legge.
Fai in modo che i nomi delle tue variabili siano facili da cercare.
Strumenti come [buddy.js](https://github.com/danielstjules/buddy.js) e
[ESLint](https://github.com/eslint/eslint/blob/660e0918933e6e7fede26bc675a0763a6b357c94/docs/rules/no-magic-numbers.md) possono essere utili per identificare costanti a cui dovrebbe essere assegnato un nome.
**Da evitare**
```javascript
// Cosa caspita significa 86400000?
setTimeout(blastOff, 86400000);
```
**Corretto**
```javascript
// Dichiara la costante assegnandole un nome e usando lettere maiuscole.
const MILLISECONDI_IN_UN_GIORNO = 86400000; //86400000;
setTimeout(blastOff, MILLISECONDI_IN_UN_GIORNO);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Utilizza nomi di variabili esplicativi
**Da evitare**
```javascript
const address = 'One Infinite Loop, Cupertino 95014';
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
saveCityZipCode(address.match(cityZipCodeRegex)[1], address.match(cityZipCodeRegex)[2]);
```
**Corretto**
```javascript
const address = 'One Infinite Loop, Cupertino 95014';
const cityZipCodeRegex = /^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$/;
const [, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evita collegamenti mentali impliciti
È meglio essere espliciti piuttosto che non esserlo.
**Da evitare**
```javascript
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((l) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
// Un momento, a cosa si riferiva `l`?
dispatch(l);
});
```
**Corretto**
```javascript
const locations = ['Austin', 'New York', 'San Francisco'];
locations.forEach((location) => {
doStuff();
doSomeOtherStuff();
// ...
// ...
// ...
dispatch(location);
});
```
**[⬆ torna su](#lista-dei-contenuti)**
### Non aggiungere informazioni inutili
Se il nome della tua classe o oggetto è già esplicativo, non ripeterlo nei nomi delle sue proprietà o funzioni.
**Da evitare**
```javascript
const Car = {
carMake: 'Honda',
carModel: 'Accord',
carColor: 'Blue'
};
function paintCar(car) {
car.carColor = 'Red';
}
```
**Corretto**
```javascript
const Car = {
make: 'Honda',
model: 'Accord',
color: 'Blue'
};
function paintCar(car) {
car.color = 'Red';
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Utilizza parametri predefiniti, anzichè usare condizionali o short-circuiting
I parametri predefiniti, generalmente, sono più chiari di condizionali o short-circuiting [valutazioni minime](https://it.wikipedia.org/wiki/Valutazione_a_corto_circuito). Ricorda che, se utilizzi parametri predefiniti, la tua funzione assegnerà il valore predefinito solamente ai parametri che non le verranno forniti (`undefined`).
Gli altri valori assimilabili al booleano falso, ovvero `''`, `""`, `false`, `null`, `0`, e `NaN`, non saranno sostituiti dal valore predefinito specificato.
**Da evitare**
```javascript
function createMicrobrewery(name) {
const breweryName = name || 'Hipster Brew Co.';
// ...
}
```
**Corretto**
```javascript
function createMicrobrewery(name = 'Hipster Brew Co.') {
// ...
}
```
**[⬆ torna su](#lista-dei-contenuti)**
## **Funzioni**
### Argomenti di una funzione (idealmente 2 o anche meno)
Limitare il numero di argomenti di una funzione è incredibilmente importante perchè ti permette di testarla più facilmente. Avere più di 3 argomenti può portare ad un'esplosione di combinazioni da testare, che produrranno una lunga serie di casi da verificare.
1 o 2 argomenti sono l'ideale e dovremmo evitarne un terzo se possibile. Generalmente se la tua funzione ha più di 2 argomenti, forse, sta facendo troppe operazioni. Nei casi in cui questo non sia del tutto vero, un oggetto può aiutare ad ovviare a questo problema.
Dal momento in cui JavaScript permette la creazione di oggetti al volo puoi usare un oggetto, se pensi che il tuo metodo richieda molti argomenti.
Per rendere evidente cosa la funzione si aspetta di ricevere, puoi utilizzare la sintassi destrutturata (destructuring syntax) di ES2015/ES6 che ha diversi vantaggi:
1. Quando qualcuno osserva la firma della tua funzione, è immediatamente chiaro che proprietà saranno utilizzate
2. Destrutturare, oltretutto, clona i valori primitivi passati alla funzione. Questo può prevenire effetti inattesi. **Nota**: oggetti ed array destrutturati nell'oggetto usato come argomento NON saranno clonati.
3. Un Linter può avvisarti che non stai utilizzando alcune delle proprietà del tuo oggetto, diversamente non sarebbe possibile.
**Da evitare**
```javascript
function createMenu(title, body, buttonText, cancellable) {
// ...
}
```
**Bene:**
```javascript
function createMenu({ title, body, buttonText, cancellable }) {
// ...
}
createMenu({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
});
```
**[⬆ torna su](#lista-dei-contenuti)**
### Un metodo dovrebbe fare una sola cosa
Questa è di sicuro la regola più importante nell'ingegneria del software. Quando un metodo si occupa di più di un solo aspetto sarà più difficile da testare, comporre e ragioraci sopra.
Se è possibile far eseguire al metodo una sola azione sarà più facile il suo refactor e la leggibilità del tuo codice sarà maggiore e più chiara. Anche se non dovesse rimanerti in mente altro di questa guida, sarai comunque più avanti di molti sviluppatori.
**Da evitare**
```javascript
function emailClients(clients) {
clients.forEach((client) => {
const clientRecord = database.lookup(client);
if (clientRecord.isActive()) {
email(client);
}
});
}
```
**Bene:**
```javascript
function emailActiveClients(clients) {
clients
.filter(isActiveClient)
.forEach(email);
}
function isActiveClient(client) {
const clientRecord = database.lookup(client);
return clientRecord.isActive();
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### I nomi delle funzioni dovrebbero farti capire cosa fanno
**Da evitare**
```javascript
function addToDate(date, month) {
// ...
}
const date = new Date();
// Difficile da dire esattamente cosa viene aggiunto tramite questa funzione
addToDate(date, 1);
```
**Bene:**
```javascript
function addMonthToDate(month, date) {
// ...
}
const date = new Date();
addMonthToDate(1, date);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Le funzioni dovrebbero avere un solo livello di astrazione
Quando hai più di un livello di astrazione, la tua funzione generalmente sta facendo troppe cose. Dividere in più funzioni aiuta a riutilizzarle e testare più facilmente.
**Da evitare**
```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...
});
}
```
**Bene:**
```javascript
function parseBetterJSAlternative(code) {
const tokens = tokenize(code);
const ast = lexer(tokens);
ast.forEach((node) => {
// parse...
});
}
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;
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Rimuovi il codice duplicato
Fai del tuo meglio per evitare codice duplicato. Duplicare il codice è un male, perchè vuol dire che c'è più di un punto da modificare nel caso in cui dovessi cambiare alcune logiche.
Immagina di avere un ristorante e di dover tener traccia del tuo magazzino: la riserva di pomodori, cipolle, aglio, spezie, etc. Se hai più di una lista in cui tieni traccia di queste quantità dovrai aggiornarle tutte ogni volta che servirai, per esempio, un piatto con dei pomodori. Al contrario, se dovessi avere una sola lista, avrai un solo posto un cui dovrai tenere traccia delle modifiche sulle quantità in magazzino.
Generalmente si duplica il codice perchè ci sono due o tre piccole differenze tra una parte e l'altra del software. Questo permette di condividere le parti comuni del codice, ma allo stesso tempo avrai dei duplicati di parti che fanno la stessa cosa.
Rimuovere questi duplicati, significa creare un'astrazione che permette di gestire queste differenze attraverso un unico metodo/modulo/classe.
Ottenere la sufficiente astrazione può essere complicato. Per questo dovresti seguire i principi SOLID, approfonditi nella sezione *Classi*.
Un'astrazione non ottimale potrebbe anche essere peggio del codice duplicato, per cui fai attenzione! Non ripeterti, altrimenti dovrai aggiornare tutte le occorrenze della stessa logica ogni volta che vorrai cambiare qualcosa.
**Da evitare**
```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);
});
}
```
**Bene:**
```javascript
function showEmployeeList(employees) {
employees.forEach((employee) => {
const expectedSalary = employee.calculateExpectedSalary();
const experience = employee.getExperience();
const data = {
expectedSalary,
experience
};
switch (employee.type) {
case 'manager':
data.portfolio = employee.getMBAProjects();
break;
case 'developer':
data.githubLink = employee.getGithubLink();
break;
}
render(data);
});
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Estendi un oggetto con Object.assign
**Da evitare**
```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);
```
**Bene:**
```javascript
const menuConfig = {
title: 'Order',
// User did not include 'body' key
buttonText: 'Send',
cancellable: true
};
function createMenu(config) {
config = Object.assign({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
}, config);
// config adesso sarà: {title: "Order", body: "Bar", buttonText: "Send", cancellable: true}
// ...
}
createMenu(menuConfig);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Non usare valori flag (true/false) come parametri di una funzione
Un valore di tipo flag indica che la tua funzione può eseguire più di una sola operazione. Una funzione dovrebbe eseguire una sola operazione. Separa la tua funzione se deve eseguire più di una operazione in base al parametro flag che riceve in input.
**Da evitare**
```javascript
function createFile(name, temp) {
if (temp) {
fs.create(`./temp/${name}`);
} else {
fs.create(name);
}
}
```
**Bene:**
```javascript
function createFile(name) {
fs.create(name);
}
function createTempFile(name) {
createFile(`./temp/${name}`);
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evitare effetti inattesi (parte 1)
Una funzione può generare un effetto collaterale se fa altro oltre a ricevere un valore e restituirne uno o più. L'effetto collaterale potrebbe essere scrivere su un file, modificare una variabile globale o accidentalmente girare tutti i tuoi soldi ad uno sconosciuto.
Probabilmente, e occasionalmente, avrai bisogno di generare un effetto collaterale: come nell'esempio precedente magari proprio scrivere su un file.
Quello che dovrai fare è centralizzare il punto in cui lo fai. Non avere più funzioni e classi che fanno la stessa cosa, ma averne un servizio ed uno soltanto che se ne occupa.
La questione più importante è evitare le insidie che stanno dietro ad errate manipolazioni di oggetti senza alcuna struttura, utilizzando strutture che possono essere modificate da qualunque parte.
Se riuscirai ad evitare che questo accada...sarai ben più felice della maggior parte degli altri programmatori.
**Da evitare**
```javascript
// Variable globale utilizzata dalla funzione seguente.
// Nel caso in cui dovessimo utilizzarla in un'altra funzione a questo punto si tratterebbe di un array e potrebbe generare un errore.
let name = 'Ryan McDermott';
function splitIntoFirstAndLastName() {
name = name.split(' ');
}
splitIntoFirstAndLastName();
console.log(name); // ['Ryan', 'McDermott'];
```
**Bene:**
```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'];
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evitare effetti inattesi (parte 2)
In Javascript i valori primitivi sono passati come valori, mentre oggetti ed array vengono passati come reference. Nel caso di oggetti ed array, se la tua funzione modifica l'array contenente un carrello della spesa, per esempio, aggiungendo o rimuovendo un oggetto da acquistare, tutte le altre funzioni che utilizzeranno l'array `carrello` saranno condizionati da questa modifica. Questo potrebbe essere un bene ed un male allo stesso tempo. Immaginiamo una situazione in cui questo è un male:
l'utente clicca sul tasto "Acquista", che richiamerà una funzione `acquista` che effettua una richiesta ed invia l'array `carrello` al server. Per via di una pessima connessione, il metodo `acquista` riproverà ad effettuare la richiesta al server. Cosa succede se nello stesso momento accidentalmemte l'utente clicca su "Aggiungi al carrello" su di un oggetto che non ha intenzione di acquistare prima che venga eseguita nuovamente la funzione?
Verrà inviata la richiesta con il nuovo oggetto accidentalmente aggiunto al carrello utilizzando la funzione `aggiungiOggettoAlCarrello`.
Un'ottima soluzione è quella di di clonare sempre l'array `carrello`, modificarlo e restituire il clone.
Questo ci assicurerà che che nessun'altra funzione che gestisce il carrello subirà cambiamenti non voluti.
Due precisazioni vanno fatte su questo approccio:
1. Potrebbe essere che tu voglia realmente modificare l'oggetto in input, ma vedrai che utilizzando questo approccio ti accorgerai che questi casi sono veramente rari. La maggior parte delle volte dovrai utilizzare questo approccio per non generare effetti inattesi
2. Clonare oggetti molto grandi potrebbe essere davvero dispendioso in termini di risorse. Fortunatamente questo non è un problema perchè esistono [ottime librerie](https://facebook.github.io/immutable-js/) che permettono di utilizzare questo approccio senza dispendio di memoria e più velocemente rispetto al dovelo fare manualmente.
**Da evitare**
```javascript
const addItemToCart = (cart, item) => {
cart.push({ item, date: Date.now() });
};
```
**Bene:**
```javascript
const addItemToCart = (cart, item) => {
return [...cart, { item, date: Date.now() }];
};
```
**[⬆ torna su](#lista-dei-contenuti)**
### Non aggiungere funzioni globali
Contaminare o aggiungere delle variabili globali è una pratica sconsigliata, in quanto potresti entrare in conflitto con altre librerie e chi utiliza le tue API potrebbe non accorgersene fintanto che non si trova in produzione, generando un'eccezione.
Facciamo un esempio pratico: supponiamo che tu voglia estendere il costrutto Array nativo di JavaScript aggiungendo il metodo `diff` che mostra le differenze tra due array. Come puoi fare?
Potresti scrivere il metodo utilizzando `Array.prototype`, che però potrebbe entrare in conflitto con con un'altra libreria che fa la stessa cosa. Cosa succederebbe se anche l'altra libreria utilizzasse `diff` per trovare le differenze tra due array? Ecco perchè è molto meglio utilizzare le classi ES2015/ES6 e semplicemente estendere `Array`.
**Da evitare**
```javascript
Array.prototype.diff = function diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
};
```
**Bene:**
```javascript
class SuperArray extends Array {
diff(comparisonArray) {
const hash = new Set(comparisonArray);
return this.filter(elem => !hash.has(elem));
}
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Preferisci la programmazione funzionale a quella imperativa
*[Programmazione funzionale](https://it.wikipedia.org/wiki/Programmazione_funzionale)* -
*[Programmazione imperativa](https://it.wikipedia.org/wiki/Programmazione_imperativa)*
Javascript non è un linguaggio funzionale alla stregua di [Haskell](https://www.haskell.org/), ma entrambi hanno qualcosa che li accomuna.
I linguaggi funzionali generalmente sono più puliti e facili da testare.
Preferisci questo stile se possibile.
**Da evitare**
```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;
}
```
**Bene:**
```javascript
const programmerOutput = [
{
name: 'Uncle Bobby',
linesOfCode: 500
}, {
name: 'Suzie Q',
linesOfCode: 1500
}, {
name: 'Jimmy Gosling',
linesOfCode: 150
}, {
name: 'Gracie Hopper',
linesOfCode: 1000
}
];
const totalOutput = programmerOutput
.map(output => output.linesOfCode)
.reduce((totalLines, lines) => totalLines + lines);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Incapsula le condizioni
**Da evitare**
```javascript
if (fsm.state === 'fetching' && isEmpty(listNode)) {
// ...
}
```
**Bene:**
```javascript
function shouldShowSpinner(fsm, listNode) {
return fsm.state === 'fetching' && isEmpty(listNode);
}
if (shouldShowSpinner(fsmInstance, listNodeInstance)) {
// ...
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evita di verificare condizioni in negativo
**Da evitare**
```javascript
function isDOMNodeNotPresent(node) {
// ...
}
if (!isDOMNodeNotPresent(node)) {
// ...
}
```
**Bene:**
```javascript
function isDOMNodePresent(node) {
// ...
}
if (isDOMNodePresent(node)) {
// ...
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evita le condizioni
Sembrerebbe un task impossibile. Ad un rapido sguardo molti sviluppatori potrebbero pensare "come posso pensare di far funzionare qualcosa senza utilizzare un `if`?"
La risposta è che puoi utilizzare il polimorfismo per ottenere lo stesso risultato in molti casi.
La seconda domanda generalmente è "Ottimo! Ma perchè dovrei farlo?".
La risposta è data in uno dei concetti precedentemente descritti: una funzione dovrebbe eseguire una sola operazione.
Quando hai una Classe con delle funzioni che utilizzano lo stato `if` stai dicendo all'utente che la tua funzione può fare più di una operazione.
**Da evitare**
```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();
}
}
}
```
**Bene:**
```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();
}
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evita la validazione dei tipi (parte 1)
JavaScript è un linguaggio non tipizzato, il che significa che le tue funzioni possono accettare qualunque tipo di argomento.
Qualche volta potresti essere tentato da tutta questa libertà e potresti essere altrettanto tentato di veririfcare il tipo di dato ricevuto nella tua funzione.
Ci sono molti modi per evitare di dover fare questo tipo di controllo.
Come prima cosa cerca scrivere API consistenti.
**Da evitare**
```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'));
}
}
```
**Bene:**
```javascript
function travelToTexas(vehicle) {
vehicle.move(this.currentLocation, new Location('texas'));
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Evita la validazione dei tipi (part 2)
Se stai lavorando con tipi di dati primitivi come stringhe o interi e non puoi utilizzare il paradigma del polimorfismo, ma senti ancora l'esigenza di validare il tipo di dato considera l'utilizzo di [TypeScript](https://www.typescriptlang.org/).
È una vlidissima alternativa al normale JavaScript che fornicsce una validazione di tipi statica utilizzando la sintassi JavaScript.
Il problema con la validazione manuale dei tipi utilizzando lo standard JavaScript è che richiede tanto codice extra che non compensa la scarsa leggibilità del codice ottenuto.
Mantieni pulito il tuo codice, scrivi dei test validi e cerca di fare delle buone revisioni del coidice. Altrimenti utilizza TypeScript (che come detto in precedenza è una validissima alternativa!)
**Da evitare**
```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');
}
```
**Bene:**
```javascript
function combine(val1, val2) {
return val1 + val2;
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Non ottimizzare eccessivamente
I browser moderni eseguono un sacco di ottimizzazione "sottobanco". Molte volte, quando cerchi di ottimizzare il tuo codice, stai perdendo tempo prezioso. [Ci sono tante guide](https://github.com/petkaantonov/bluebird/wiki/Optimization-killers) che aiutano a capire quali tipi di ottimizzazione sono superflui e quali no. Utilizza queste guide nel frattempo, fintanto che queste lacune non verranno colmate.
**Da evitare**
```javascript
// Nei vecchi browser ogni volta che in un ciclo verifichi `list.length` potrebbe
// essere dispendioso per via del suo ricalcolo. Nei browser moderni
// questa operazione è stata ottimizzata
for (let i = 0, len = list.length; i < len; i++) {
// ...
}
```
**Bene:**
```javascript
for (let i = 0; i < list.length; i++) {
// ...
}
```
**[⬆ torna su](#lista-dei-contenuti)**
### Rimuovi il codice inutilizzato
Il codice inutilizzato è dannoso quanto il codice duplicato. Non c'è motivo per cui tenerlo nel tuo codebase. Se realmente non viene utilizzato rimuovilo!
Sarà comunque presente nella storia del tuo file se utilizzi un sistema di versioning nel caso in cui dovesse servirti.
**Da evitare**
```javascript
function oldRequestModule(url) {
// ...
}
function newRequestModule(url) {
// ...
}
const req = newRequestModule;
inventoryTracker('apples', req, 'www.inventory-awesome.io');
```
**Bene:**
```javascript
function newRequestModule(url) {
// ...
}
const req = newRequestModule;
inventoryTracker('apples', req, 'www.inventory-awesome.io');
```
**[⬆ torna su](#lista-dei-contenuti)**
## **Oggetti e strutture dati**
### Utilizza getter e setter
Utilizzare getter e setter per acceedere ai dati di un oggetto può essere meglio che accedere direttamente alle sue proprietà. Ti starai sicuramente chiedendo il motivo.
Eccoti qualche motivo per cui utilizzare getter e setter:
* Quando hai bisogno di eseguire un'operazione sul dato recuperato, non devi andare a modificarlo ogni volta che accedi al dato nel tuo codice.
* Valida il dato nel momento in cui lo setti con `set`
* Incapsula la rappresentazione interna
* È più facile loggare e gestire gli errori quando imposti o recuperi un dato
* Puoi caricare i dati del tuo oggetto in modalità *lazy*, per esempio caricandoli dal server.
**Da evitare**
```javascript
function makeBankAccount() {
// ...
return {
balance: 0,
// ...
};
}
const account = makeBankAccount();
account.balance = 100;
```
**Bene:**
```javascript
function makeBankAccount() {
// questa proprietà è privata
let balance = 0;
// un "getter", la rende pubblica restituendola in questo modo
function getBalance() {
return balance;
}
// un "setter", la rende pubblica in questo modo
function setBalance(amount) {
// ... e la valida prima di impostarla
balance = amount;
}
return {
// ...
getBalance,
setBalance,
};
}
const account = makeBankAccount();
account.setBalance(100);
```
**[⬆ torna su](#lista-dei-contenuti)**
### Imposta proprietà private in un oggetto
Può essere fatto attraverso le *closure* (per ES5 e versioni precedenti).
**Da evitare**
```javascript
const Employee = function(name) {
this.name = name;
};
Employee.prototype.getName = function getName() {
return this.name;
};
const employee = new Employee('John Doe');
console.log(`Employee name: ${employee.getName()}`); // Employee name: John Doe
delete employee.name;
console.log(`Employee name: ${employee.getName()}`); // Employee name: undefined
```
**Bene:**
```javascript
function makeEmployee(name) {
return {
getName() {
return name;
},
};
}
const employee = makeEmployee('John Doe');
console.log(`Employee name: ${employee.getName()}`); // Employee name: John Doe
delete employee.name;
console.log(`Employee name: ${employee.getName()}`); // Employee name: John Doe
```
**[⬆ torna su](#lista-dei-contenuti)**