forked from labs42io/clean-code-typescript
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.md
More file actions
2938 lines (2153 loc) · 106 KB
/
README.md
File metadata and controls
2938 lines (2153 loc) · 106 KB
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-typescript [](https://twitter.com/intent/tweet?text=Clean%20Code%20Typescript&url=https://github.com/labs42io/clean-code-typescript)
Концепції Clean Code, адаптовані для TypeScript.
Натхненні [clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript).
## Зміст
1. [Вступ](#вступ)
2. [Змінні](#змінні)
3. [Функції](#функції)
4. [Об'єкти та структури даних](#обєкти-та-структури-даних)
5. [Класи](#класи)
6. [SOLID](#solid)
7. [Тестування](#тестування)
8. [Асинхронність](#асинхронність)
9. [Обробка помилок](#обробка-помилок)
10. [Форматування](#форматування)
11. [Коментарі](#коментарі)
12. [Переклади](#переклади)
## Вступ
Принципи програмної інженерії з книги Роберта К. Мартіна [*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882), адаптовані для TypeScript. Це не стильовий посібник. Це посібник з написання [читабельного, повторно використовуваного та рефакторингового](https://github.com/ryanmcdermott/3rs-of-software-architecture) програмного забезпечення на TypeScript.
Не кожен принцип тут повинен суворо дотримуватись, і ще менше з них будуть загальноприйнятими. Це лише рекомендації, і нічого більше, але вони кодифіковані багаторічним колективним досвідом авторів книги *Clean Code*.
Наше ремесло програмної інженерії налічує лише трохи більше 50 років, і ми все ще багато чого вчимося. Коли архітектура програмного забезпечення стане такою ж старою, як архітектура будівель, можливо, тоді у нас будуть жорсткіші правила для дотримання. А поки що, нехай ці рекомендації слугують орієнтиром для оцінки якості коду TypeScript, який створюєте ви та ваша команда.
Ще одна річ: знання цих принципів не зробить вас миттєво кращим розробником програмного забезпечення, і робота з ними протягом багатьох років не означає, що ви не будете помилятися. Кожен фрагмент коду починається як перший чернетковий варіант, як мокра глина, що набуває своєї остаточної форми. Врешті-решт, ми вирізаємо недоліки, коли переглядаємо код з колегами. Не картайте себе за перші чернетки, які потребують покращення. Натомість критикуйте сам код!
**[⬆ повернутися до змісту](#зміст)**
## Змінні
### Використовуйте змістовні імена змінних
Розрізняйте імена таким чином, щоб читач розумів, які між ними відмінності.
**Погано:**
```ts
function between<T>(a1: T, a2: T, a3: T): boolean {
return a2 <= a1 && a1 <= a3;
}
```
**Добре:**
```ts
function between<T>(value: T, left: T, right: T): boolean {
return left <= value && value <= right;
}
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте вимовні імена змінних
Якщо ви не можете вимовити ім’я змінної, вам буде складно про неї говорити, не виглядаючи безглуздо.
**Погано:**
```ts
type DtaRcrd102 = {
genymdhms: Date;
modymdhms: Date;
pszqint: number;
}
```
**Добре:**
```ts
type Customer = {
generationTimestamp: Date;
modificationTimestamp: Date;
recordId: number;
}
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте однаковий словниковий запас для однакового типу змінних
**Погано:**
```ts
function getUserInfo(): User;
function getUserDetails(): User;
function getUserData(): User;
```
**Добре:**
```ts
function getUser(): User;
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте пошукові імена
Ми будемо читати більше коду, ніж коли-небудь напишемо. Важливо, щоб код, який ми пишемо, був читабельним і пошуковим. Не називаючи змінні іменами, які мають значення для розуміння нашої програми, ми шкодимо нашим читачам. Робіть ваші імена пошуковими. Інструменти, такі як [ESLint](https://typescript-eslint.io/), можуть допомогти ідентифікувати неназвані константи (також відомі як магічні рядки та магічні числа).
**Погано:**
```ts
// Що за чорт, для чого ці 86400000?
setTimeout(restart, 86400000);
```
**Добре:**
```ts
// Оголосіть їх як капіталізовані іменовані константи.
const MILLISECONDS_PER_DAY = 24 * 60 * 60 * 1000; // 86400000
setTimeout(restart, MILLISECONDS_PER_DAY);
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте пояснювальні змінні
**Погано:**
```ts
declare const users: Map<string, User>;
for (const keyValue of users) {
// ітерація по мапі користувачів
}
```
**Добре:**
```ts
declare const users: Map<string, User>;
for (const [id, user] of users) {
// ітерація по мапі користувачів
}
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте ментального декодування
Робіть код настільки очевидним, щоб його не треба було 'перекладати' у голові.
Явне краще, ніж неявне.
*Чіткість - це король.*
**Погано:**
```ts
const u = getUser();
const s = getSubscription();
const t = charge(u, s);
```
**Добре:**
```ts
const user = getUser();
const subscription = getSubscription();
const transaction = charge(user, subscription);
```
**[⬆ повернутися до змісту](#зміст)**
### Не додавайте непотрібний контекст
Якщо ім'я вашого класу/типу/об'єкта говорить вам щось, не повторюйте це в імені змінної.
**Погано:**
```ts
type Car = {
carMake: string;
carModel: string;
carColor: string;
}
function print(car: Car): void {
console.log(`${car.carMake} ${car.carModel} (${car.carColor})`);
}
```
**Добре:**
```ts
type Car = {
make: string;
model: string;
color: string;
}
function print(car: Car): void {
console.log(`${car.make} ${car.model} (${car.color})`);
}
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте аргументи за замовчуванням замість умовних виразів
Аргументи за замовчуванням виглядають чистіше, ніж умовні вирази для підстановки значення.
**Погано:**
```ts
function loadPages(count?: number) {
const loadCount = count !== undefined ? count : 10;
// ...
}
```
**Добре:**
```ts
function loadPages(count: number = 10) {
// ...
}
```
**[⬆ повернутися до змісту](#зміст)**
### Використовуйте enum для документування наміру
Перерахування (enums) можуть допомогти вам документувати намір коду. Наприклад, коли ми більше турбуємося про те, щоб значення відрізнялись, ніж про їх точне значення.
**Погано:**
```ts
const GENRE = {
ROMANTIC: 'romantic',
DRAMA: 'drama',
COMEDY: 'comedy',
DOCUMENTARY: 'documentary',
}
projector.configureFilm(GENRE.COMEDY);
class Projector {
// декларація Projector
configureFilm(genre) {
switch (genre) {
case GENRE.ROMANTIC:
// якась логіка для виконання
}
}
}
```
**Добре:**
```ts
enum GENRE {
ROMANTIC,
DRAMA,
COMEDY,
DOCUMENTARY,
}
projector.configureFilm(GENRE.COMEDY);
class Projector {
// декларація Projector
configureFilm(genre) {
switch (genre) {
case GENRE.ROMANTIC:
// якась логіка для виконання
}
}
}
```
**[⬆ повернутися до змісту](#зміст)**
## Функції
### Аргументи функцій (в ідеалі 2 або менше)
Обмеження кількості параметрів функції неймовірно важливе, оскільки це полегшує тестування вашої функції.
Наявність більше трьох призводить до комбінаторного вибуху, коли ви повинні тестувати тонни різних випадків для кожного окремого аргументу.
Один або два аргументи - це ідеальний випадок, а трьох слід уникати, якщо це можливо. Все, що перевищує це, має бути консолідовано.
Зазвичай, якщо у вас більше двох аргументів, то ваша функція намагається зробити занадто багато.
У випадках, коли це не так, здебільшого об'єкт вищого рівня буде достатнім як аргумент.
Розгляньте можливість використання об'єктних літералів, якщо вам потрібно багато аргументів.
Щоб було очевидно, які властивості очікує функція, ви можете використовувати синтаксис [деструктуризації](https://basarat.gitbook.io/typescript/future-javascript/destructuring).
Це має кілька переваг:
1. Коли хтось дивиться на сигнатуру функції, відразу зрозуміло, які властивості використовуються.
2. Це можна використовувати для імітації іменованих параметрів.
3. Деструктуризація також клонує вказані примітивні значення об'єкта аргументу, переданого у функцію. Це може допомогти запобігти побічним ефектам. Примітка: об'єкти та масиви, які деструктуризуються з об'єкта аргументу, НЕ клонуються.
4. TypeScript попереджає про невикористані властивості, що було б неможливо без деструктуризації.
**Погано:**
```ts
function createMenu(title: string, body: string, buttonText: string, cancellable: boolean) {
// ...
}
createMenu('Foo', 'Bar', 'Baz', true);
```
**Добре:**
```ts
function createMenu(options: { title: string, body: string, buttonText: string, cancellable: boolean }) {
// ...
}
createMenu({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
});
```
Ви можете ще більше покращити читабельність, використовуючи [аліаси типів](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#type-aliases
):
```ts
type MenuOptions = { title: string, body: string, buttonText: string, cancellable: boolean };
function createMenu(options: MenuOptions) {
// ...
}
createMenu({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
});
```
**[⬆ повернутися до змісту](#зміст)**
### Функції повинні робити одне
Це, безумовно, найважливіше правило в програмній інженерії. Коли функції роблять більше, ніж одне, їх важче створювати, тестувати та розуміти. Коли ви можете ізолювати функцію до однієї дії, її легко рефакторити, і ваш код буде набагато чистішим. Якщо ви не винесете з цього посібника нічого іншого, крім цього, ви випередите багатьох розробників.
**Погано:**
```ts
function emailActiveClients(clients: Client[]) {
clients.forEach((client) => {
const clientRecord = database.lookup(client);
if (clientRecord.isActive()) {
email(client);
}
});
}
```
**Добре:**
```ts
function emailActiveClients(clients: Client[]) {
clients.filter(isActiveClient).forEach(email);
}
function isActiveClient(client: Client) {
const clientRecord = database.lookup(client);
return clientRecord.isActive();
}
```
**[⬆ повернутися до змісту](#зміст)**
### Назви функцій повинні говорити, що вони роблять
**Погано:**
```ts
function addToDate(date: Date, month: number): Date {
// ...
}
const date = new Date();
// Важко зрозуміти з назви функції, що саме додається
addToDate(date, 1);
```
**Добре:**
```ts
function addMonthToDate(date: Date, month: number): Date {
// ...
}
const date = new Date();
addMonthToDate(date, 1);
```
**[⬆ повернутися до змісту](#зміст)**
### Функції повинні бути лише на одному рівні абстракції
Коли у вас більше одного рівня абстракції, ваша функція зазвичай робить занадто багато. Розділення функцій призводить до повторного використання та полегшує тестування.
**Погано:**
```ts
function parseCode(code: string) {
const REGEXES = [ /* ... */ ];
const statements = code.split(' ');
const tokens = [];
REGEXES.forEach((regex) => {
statements.forEach((statement) => {
// ...
});
});
const ast = [];
tokens.forEach((token) => {
// лексичний аналіз...
});
ast.forEach((node) => {
// парсинг...
});
}
```
**Добре:**
```ts
const REGEXES = [ /* ... */ ];
function parseCode(code: string) {
const tokens = tokenize(code);
const syntaxTree = parse(tokens);
syntaxTree.forEach((node) => {
// парсинг...
});
}
function tokenize(code: string): Token[] {
const statements = code.split(' ');
const tokens: Token[] = [];
REGEXES.forEach((regex) => {
statements.forEach((statement) => {
tokens.push( /* ... */ );
});
});
return tokens;
}
function parse(tokens: Token[]): SyntaxTree {
const syntaxTree: SyntaxTree[] = [];
tokens.forEach((token) => {
syntaxTree.push( /* ... */ );
});
return syntaxTree;
}
```
**[⬆ повернутися до змісту](#зміст)**
### Видаліть дубльований код
Зробіть все можливе, щоб уникнути дубльованого коду.
Дубльований код поганий, тому що це означає, що існує більше одного місця для зміни чогось, якщо вам потрібно змінити якусь логіку.
Уявіть, якщо ви керуєте рестораном і ведете облік вашого інвентарю: всіх ваших помідорів, цибулі, часнику, спецій тощо.
Якщо у вас є кілька списків, де ви це зберігаєте, то всі вони повинні бути оновлені, коли ви подаєте страву з помідорами.
Якщо у вас лише один список, є лише одне місце для оновлення!
Часто ви маєте дубльований код, тому що у вас є дві або більше дещо різних речей, які мають багато спільного, але їхні відмінності змушують вас мати дві або більше окремі функції, які роблять багато однакових речей. Видалення дубльованого коду означає створення абстракції, яка може обробляти цей набір різних речей лише однією функцією/модулем/класом.
Правильна абстракція є критичною, саме тому ви повинні дотримуватися принципів [SOLID](#solid). Погані абстракції можуть бути гіршими за дубльований код, тому будьте обережні! Але якщо ви можете зробити хорошу абстракцію, зробіть це! Не повторюйтеся, інакше ви будете оновлювати кілька місць щоразу, коли захочете змінити одну річ.
**Погано:**
```ts
function showDeveloperList(developers: Developer[]) {
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: Manager[]) {
managers.forEach((manager) => {
const expectedSalary = manager.calculateExpectedSalary();
const experience = manager.getExperience();
const portfolio = manager.getMBAProjects();
const data = {
expectedSalary,
experience,
portfolio
};
render(data);
});
}
```
**Добре:**
```ts
class Developer {
// ...
getExtraDetails() {
return {
githubLink: this.githubLink,
}
}
}
class Manager {
// ...
getExtraDetails() {
return {
portfolio: this.portfolio,
}
}
}
function showEmployeeList(employee: (Developer | Manager)[]) {
employee.forEach((employee) => {
const expectedSalary = employee.calculateExpectedSalary();
const experience = employee.getExperience();
const extra = employee.getExtraDetails();
const data = {
expectedSalary,
experience,
extra,
};
render(data);
});
}
```
Ви також можете розглянути додавання типу об'єднання або спільного батьківського класу, якщо це відповідає вашій абстракції.
```ts
class Developer {
// ...
}
class Manager {
// ...
}
type Employee = Developer | Manager
function showEmployeeList(employee: Employee[]) {
// ...
});
}
```
Ви повинні критично ставитися до дублювання коду. Іноді існує компроміс між дубльованим кодом і збільшенням складності через введення непотрібної абстракції. Коли дві реалізації з двох різних модулів виглядають схожими, але живуть у різних доменах, дублювання може бути прийнятним і переважати над витяганням спільного коду. Витягнутий спільний код у цьому випадку створює непряму залежність між двома модулями.
**[⬆ повернутися до змісту](#зміст)**
### Встановлюйте об'єкти за замовчуванням за допомогою Object.assign або деструктуризації
**Погано:**
```ts
type MenuConfig = { title?: string, body?: string, buttonText?: string, cancellable?: boolean };
function createMenu(config: MenuConfig) {
config.title = config.title || 'Foo';
config.body = config.body || 'Bar';
config.buttonText = config.buttonText || 'Baz';
config.cancellable = config.cancellable !== undefined ? config.cancellable : true;
// ...
}
createMenu({ body: 'Bar' });
```
**Добре:**
```ts
type MenuConfig = { title?: string, body?: string, buttonText?: string, cancellable?: boolean };
function createMenu(config: MenuConfig) {
const menuConfig = Object.assign({
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true
}, config);
// ...
}
createMenu({ body: 'Bar' });
```
Або ви можете використовувати оператор поширення (spread operator):
```ts
function createMenu(config: MenuConfig) {
const menuConfig = {
title: 'Foo',
body: 'Bar',
buttonText: 'Baz',
cancellable: true,
...config,
};
// ...
}
```
Оператор поширення і `Object.assign()` дуже схожі.
Головна відмінність полягає в тому, що поширення визначає нові властивості, тоді як `Object.assign()` встановлює їх. Більш детально ця різниця пояснюється в [цій](https://stackoverflow.com/questions/32925460/object-spread-vs-object-assign) темі.
Альтернативно, ви можете використовувати деструктуризацію з значеннями за замовчуванням:
```ts
type MenuConfig = { title?: string, body?: string, buttonText?: string, cancellable?: boolean };
function createMenu({ title = 'Foo', body = 'Bar', buttonText = 'Baz', cancellable = true }: MenuConfig) {
// ...
}
createMenu({ body: 'Bar' });
```
Щоб уникнути будь-яких побічних ефектів і неочікуваної поведінки передаючи явно значення `undefined` або `null`, ви можете вказати компілятору TypeScript не дозволяти це.
Дивіться опцію [`--strictNullChecks`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-0.html#--strictnullchecks) в TypeScript.
**[⬆ повернутися до змісту](#зміст)**
### Не використовуйте булеві параметри (так звані "прапори") у функціях.
Їх наявність означає, що функція має декілька сценаріїв поведінки, тобто робить більше однієї речі.
Це ускладнює розуміння й підтримку коду. Якщо функція поводиться по-різному в залежності від прапору, краще розбити її на дві окремі функції, кожна з яких чітко робить щось одне..
**Погано:**
```ts
function createFile(name: string, temp: boolean) {
if (temp) {
fs.create(`./temp/${name}`);
} else {
fs.create(name);
}
}
```
**Добре:**
```ts
function createTempFile(name: string) {
createFile(`./temp/${name}`);
}
function createFile(name: string) {
fs.create(name);
}
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте побічних ефектів (частина 1)
Функція створює побічний ефект, якщо вона робить щось інше, ніж приймає значення і повертає інше значення або значення.
Побічним ефектом може бути запис у файл, зміна глобальної змінної або випадкове перерахування всіх ваших грошей незнайомцю.
Час від часу вам дійсно потрібні побічні ефекти в програмі. Як у попередньому прикладі, вам може знадобитися запис у файл.
Але те, що ви хочете зробити, це централізувати місце, де ви це робите. Не майте кілька функцій і класів, які записують у певний файл.
Майте одну службу, яка це робить. Одну і тільки одну.
Основна ідея полягає в тому, щоб уникнути поширених пасток, таких як обмін станом між об'єктами без структури, використання мутабельних типів даних, які можуть бути змінені будь-чим, і не централізація того, де відбуваються ваші побічні ефекти. Якщо ви зможете це зробити, ви будете щасливіші, ніж більшість інших програмістів.
**Погано:**
```ts
// Глобальна змінна, на яку посилається наступна функція.
let name = 'Robert C. Martin';
function toBase64() {
name = btoa(name);
}
toBase64();
// Якби у нас була інша функція, яка використовувала це ім'я, тепер це було б значення в Base64
console.log(name); // очікується, що надрукує 'Robert C. Martin', але натомість 'Um9iZXJ0IEMuIE1hcnRpbg=='
```
**Добре:**
```ts
const name = 'Robert C. Martin';
function toBase64(text: string): string {
return btoa(text);
}
const encodedName = toBase64(name);
console.log(name);
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте побічних ефектів (частина 2)
Браузери та Node.js обробляють лише JavaScript, тому будь-який код TypeScript має бути скомпільований перед запуском або налагодженням. У JavaScript деякі значення незмінні (immutable), а деякі змінні (mutable). Об'єкти та масиви є двома видами мутабельних значень, тому важливо обережно обробляти їх, коли вони передаються як параметри до функції. Функція JavaScript може змінювати властивості об'єкта або змінювати вміст масиву, що може легко спричинити помилки в інших місцях.
Припустимо, існує функція, яка приймає параметр масиву, що представляє кошик покупок. Якщо функція вносить зміни в цей масив кошика - наприклад, додаючи товар для покупки - тоді будь-яка інша функція, яка використовує той самий масив `cart`, буде порушена цим додаванням. Це може бути чудово, але також може бути погано. Давайте уявимо погану ситуацію:
Користувач натискає кнопку "Придбати", яка викликає функцію `purchase`, що створює мережевий запит і надсилає масив `cart` на сервер. Через погане мережеве з'єднання функція `purchase` повинна повторювати запит. А що, якщо тим часом користувач випадково натисне кнопку "Додати до кошика" на товарі, який насправді не хоче, перш ніж розпочнеться мережевий запит? Якщо це станеться і мережевий запит розпочнеться, функція покупки надішле випадково доданий товар, оскільки масив `cart` був змінений.
Відмінним рішенням було б для функції `addItemToCart` завжди клонувати `cart`, редагувати його і повертати клон. Це забезпечило б, що функції, які все ще використовують старий кошик покупок, не будуть порушені змінами.
Два застереження щодо цього підходу:
1. Можуть бути випадки, коли ви дійсно хочете змінити вхідний об'єкт, але коли ви приймаєте цю практику програмування, ви виявите, що такі випадки досить рідкісні. Більшість речей можна переробити так, щоб не було побічних ефектів! (див. [чиста функція](https://en.wikipedia.org/wiki/Pure_function))
2. Клонування великих об'єктів може бути дуже дорогим з точки зору продуктивності. На щастя, це не є великою проблемою на практиці, оскільки існують [чудові бібліотеки](https://github.com/immutable-js/immutable-js), які дозволяють такий підхід до програмування бути швидким і не таким інтенсивним щодо пам'яті, як це було б для вас вручну клонувати об'єкти та масиви.
**Погано:**
```ts
function addItemToCart(cart: CartItem[], item: Item): void {
cart.push({ item, date: Date.now() });
};
```
**Добре:**
```ts
function addItemToCart(cart: CartItem[], item: Item): CartItem[] {
return [...cart, { item, date: Date.now() }];
};
```
**[⬆ повернутися до змісту](#зміст)**
### Не змінюйте глобальні функції
Забруднення глобальних змінних є поганою практикою в JavaScript, оскільки ви можете зіткнутися з іншою бібліотекою, і користувач вашого API не буде про це знати, поки не отримає виняток у продакшені. Давайте подумаємо про приклад: що, якщо ви хочете розширити нативний метод масиву JavaScript, щоб мати метод `diff`, який міг би показати різницю між двома масивами? Ви могли б написати свою нову функцію до `Array.prototype`, але вона могла б зіткнутися з іншою бібліотекою, яка намагалася зробити те саме. Що, якщо ця інша бібліотека використовувала `diff` лише для пошуку різниці між першим і останнім елементами масиву? Ось чому було б набагато краще просто використовувати класи і просто розширювати глобальний `Array`.
**Погано:**
```ts
declare global {
interface Array<T> {
diff(other: T[]): Array<T>;
}
}
if (!Array.prototype.diff) {
Array.prototype.diff = function <T>(other: T[]): T[] {
const hash = new Set(other);
return this.filter(elem => !hash.has(elem));
};
}
```
**Добре:**
```ts
class MyArray<T> extends Array<T> {
diff(other: T[]): T[] {
const hash = new Set(other);
return this.filter(elem => !hash.has(elem));
};
}
```
**[⬆ повернутися до змісту](#зміст)**
### Віддавайте перевагу функціональному програмуванню над імперативним
Віддавайте перевагу цьому стилю програмування, коли можете.
**Погано:**
```ts
const contributions = [
{
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 < contributions.length; i++) {
totalOutput += contributions[i].linesOfCode;
}
```
**Добре:**
```ts
const contributions = [
{
name: 'Uncle Bobby',
linesOfCode: 500
}, {
name: 'Suzie Q',
linesOfCode: 1500
}, {
name: 'Jimmy Gosling',
linesOfCode: 150
}, {
name: 'Gracie Hopper',
linesOfCode: 1000
}
];
const totalOutput = contributions
.reduce((totalLines, output) => totalLines + output.linesOfCode, 0);
```
**[⬆ повернутися до змісту](#зміст)**
### Інкапсулюйте умови
**Погано:**
```ts
if (subscription.isTrial || account.balance > 0) {
// ...
}
```
**Добре:**
```ts
function canActivateService(subscription: Subscription, account: Account) {
return subscription.isTrial || account.balance > 0;
}
if (canActivateService(subscription, account)) {
// ...
}
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте негативних умов
**Погано:**
```ts
function isEmailNotUsed(email: string): boolean {
// ...
}
if (isEmailNotUsed(email)) {
// ...
}
```
**Добре:**
```ts
function isEmailUsed(email: string): boolean {
// ...
}
if (!isEmailUsed(email)) {
// ...
}
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте умов
Це здається неможливим завданням. При першому почутті цього більшість людей каже: "Як я повинен щось робити без оператора `if`?" Відповідь полягає в тому, що ви можете використовувати поліморфізм для досягнення тієї ж задачі в багатьох випадках. Друге питання зазвичай: "Ну, це чудово, але чому я повинен це робити?" Відповідь - це попередня концепція чистого коду, яку ми вивчили: функція повинна робити тільки одну річ. Коли у вас є класи та функції, які мають оператори `if`, ви повідомляєте своєму користувачеві, що ваша функція робить більше однієї речі. Пам'ятайте, робіть лише одну річ.
**Погано:**
```ts
class Airplane {
private type: string;
// ...
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();
default:
throw new Error('Unknown airplane type.');
}
}
private getMaxAltitude(): number {
// ...
}
}
```
**Добре:**
```ts
abstract class Airplane {
protected getMaxAltitude(): number {
// спільна логіка з підкласами ...
}
// ...
}
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();
}
}
```
**[⬆ повернутися до змісту](#зміст)**
### Уникайте перевірки типів
TypeScript є строгим синтаксичним розширенням JavaScript і додає необов'язкову статичну перевірку типів до мови.
Завжди віддавайте перевагу вказанню типів змінних, параметрів і значень, що повертаються, щоб використовувати повну силу можливостей TypeScript.
Це робить рефакторинг легшим.
**Погано:**
```ts
function travelToTexas(vehicle: Bicycle | Car) {
if (vehicle instanceof Bicycle) {
vehicle.pedal(currentLocation, new Location('texas'));
} else if (vehicle instanceof Car) {
vehicle.drive(currentLocation, new Location('texas'));
}
}
```
**Добре:**
```ts
type Vehicle = Bicycle | Car;
function travelToTexas(vehicle: Vehicle) {