-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathindex.jade
983 lines (908 loc) · 57.6 KB
/
index.jade
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
.page.page--angularjs
.page-header
img(src="assets/img/angularjs.png")
h1 AngularJS 1.x
h2 Code Review Checklist
p Checklist you can use when you need to perform a code review of an AngularJS 1.x application.
p Based on best-practices and recommendations by
.header__names
a(href="https://twitter.com/angularjs", target="_blank") @angularjs
= ', '
a(href="https://twitter.com/mgechev", target="_blank") @mgechev
= ', '
a(href="https://twitter.com/toddmotto", target="_blank") @ToddMotto
= ', '
a(href="https://twitter.com/John_Papa", target="_blank") @John_Papa
= ', '
a(href="https://twitter.com/thoughtram", target="_blank") @Thoughtram
= ' and '
a(href="https://twitter.com/jvandemo", target="_blank") @jvandemo
.section.section--code
.section__header
.section-title Code style
.section__content
.cards
.card
.card__number 1
.card__title Is all code intention-revealing?
.card__what
.list.list--what
.list-heading What?
.list-item All code should be easy to understand for other developers
.card__why
.list.list--why
.list-heading Why?
.list-item To make sure the code can be updated, refactored and maintained by others if needed
.card
.card__number 2
.card__title Is all code linted/hinted?
.card__what
.list.list--what
.list-heading What?
.list-item All code should be syntactically correct
.card__why
.list.list--why
.list-heading Why?
.list-item To avoid unpredictable errors
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="http://jshint.com/", target="_blank") http://jshint.com
.list-item
a(href="http://eslint.org/", target="_blank") http://eslint.org/
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#js-hint", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#js-hint
.card
.card__number 3
.card__title Is `controller as` syntax used?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>controllerAs</code>
.list-item Use <code>bindToController</code>
.card__why
.list.list--why
.list-heading Why?
.list-item Avoid pitfalls from scope soup
.list-item Target outer scopes easily from within inner scopes
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://toddmotto.com/digging-into-angulars-controller-as-syntax/", target="_blank") https://toddmotto.com/digging-into-angulars-controller-as-syntax/
.list-item
a(href="http://blog.thoughtram.io/angularjs/2015/01/02/exploring-angular-1.3-bindToController.html", target="_blank") http://blog.thoughtram.io/angularjs/2015/01/02/exploring-angular-1.3-bindToController.html
.card
.card__number 4
.card__title Is DOM manipulation handled only by directives?
.card__what
.list.list--what
.list-heading What?
.list-item DOM manipulation should only happen in directives
.list-item Use the element available in the directive compile and link function to manipulate the DOM
.list-item No DOM manipulation from controllers or services
.card__why
.list.list--why
.list-heading Why?
.list-item Angular is declarative with directives attached to elements. The directive then provides access via the compile or link element to this DOM element
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#directives", target="_blank") https://github.com/mgechev/angularjs-style-guide#directives
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y072", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y072
.card
.card__number 5
.card__title Are names prefixed with `$ ` avoided?
.card__what
.list.list--what
.list-heading What?
.list-item Names of variables, properties and methods should not start with <code>$</code>
.card__why
.list.list--why
.list-heading Why?
.list-item The <code>$</code> prefix is reserved for AngularJS internals
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://google.github.io/styleguide/angularjs-google-style.html", target="_blank") https://google.github.io/styleguide/angularjs-google-style.html
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#others", target="_blank") https://github.com/mgechev/angularjs-style-guide#others
.card
.card__number 6
.card__title Is direct use of globals avoided?
.card__what
.list.list--what
.list-heading What?
.list-item Create services to wrap globals
.list-item Use dependency injection to inject global wrappers
.card__why
.list.list--why
.list-heading Why?
.list-item Prevents unpredictable application behavior when global is not available
.list-item Easier to test: allows you to mock global
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="http://jvandemo.com/how-to-properly-integrate-non-angularjs-libraries-in-your-angularjs-application/", target="_blank") http://jvandemo.com/how-to-properly-integrate-non-angularjs-libraries-in-your-angularjs-application/
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#others", target="_blank") https://github.com/mgechev/angularjs-style-guide#others
.card
.card__number 7
.card__title Are AngularJS specific directives put after standard attributes in templates?
.card__what
.list.list--what
.list-heading What?
.list-item Put AngularJS specific directives after standard attributes
.card__why
.list.list--why
.list-heading Why?
.list-item Easier to read and maintain your code
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#markup", target="_blank") https://github.com/mgechev/angularjs-style-guide#markup
.card
.card__number 8
.card__title Are built-in AngularJS dependencies injected before custom ones?
.card__what
.list.list--what
.list-heading What?
.list-item Inject built-in AngularJS dependencies before customer ones
.list-item Example: <code>function($rootScope, $timeout, MyDependency)</code>
.card__why
.list.list--why
.list-heading Why?
.list-item Easier to read and maintain your code
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#markup", target="_blank") https://github.com/mgechev/angularjs-style-guide#markup
.card
.card__number 9
.card__title Are modules named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item lowerCamelCase
.list-item Example: myApp
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y020", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y020
.card
.card__number 10
.card__title Are controllers named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item UpperCamelCase + Ctrl or UpperCamelCase + Controller
.list-item Example: MyCtrl or MyController
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y124", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y124
.card
.card__number 11
.card__title Are directives named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item lowerCamelCase
.list-item Example: myDirective
.list-item Use <code>scope</code> instead of <code>$scope</code> in link function
.list-item Use custom prefix to prevent name collisions with third-party libraries
.list-item Don’t use <code>ng</code> prefix as it is reserved for AngularJS
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y073", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y073
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y126", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y126
.card
.card__number 12
.card__title Are filters named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item lowerCamelCase
.list-item Example: myFilter
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.card
.card__number 13
.card__title Are services named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item lowerCamelCase
.list-item Example: myService
.list-item UpperCamelCase if service is a Constructor
.list-item Example: MyContrstructorClassService
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y125
.card
.card__number 14
.card__title Are factories named correctly?
.card__what
.list.list--what
.list-heading What?
.list-item lowerCamelCase
.list-item Example: myFactory
.card__why
.list.list--why
.list-heading Why?
.list-item Naming convention
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#naming-conventions", target="_blank") https://github.com/mgechev/angularjs-style-guide#naming-conventions
.card
.card__number 15
.card__title Are built-in AngularJS directives used whenever possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>ng-src</code> instead of <code>src</code>, <code>ng-href</code>instead of <code>href</code>, <code>ng-style</code>instead of <code>style</code>, etc. when dynamic values are passed
.card__why
.list.list--why
.list-heading Why?
.list-item They make sure markup remains valid, even when expression value is not available yet
.list-item They are well-written and tested
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#templates", target="_blank") https://github.com/mgechev/angularjs-style-guide#templates
.card
.card__number 16
.card__title Are built-in AngularJS services used whenever possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>$</code> services provided by AngularJS whenever possible
.list-item Examples: <code>$timeout</code>, <code>$interval</code>, <code>$http</code>, …
.card__why
.list.list--why
.list-heading Why?
.list-item These services are designed to work well with the <code>$digest</code> cycle
.list-item They are well-written and tested
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#angular--wrapper-services", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#angular--wrapper-services
.card
.card__number 17
.card__title Is ng-cloak used to prevent content from flashing
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>ng-cloak</code> to initially hide elements that are only visible under certain conditions
.card__why
.list.list--why
.list-heading Why?
.list-item Prevents content flashing when page is loaded
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#templates", target="_blank") https://github.com/mgechev/angularjs-style-guide#templates
.card
.card__number 18
.card__title Is console.log() avoided?
.card__what
.list.list--what
.list-heading What?
.list-item use <code>$log</code> service
.list-item use <code>$log.debug()</code> to write debug messages to the console
.card__why
.list.list--why
.list-heading Why?
.list-item allows you to turn off debug logging in production
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ng/service/$log", target="_blank") https://docs.angularjs.org/api/ng/service/$log
.card
.card__number 19
.card__title Is code minification safe?
.card__what
.list.list--what
.list-heading What?
.list-item Use array notation or $inject notation or use ng-annotate
.card__why
.list.list--why
.list-heading Why?
.list-item Code will break when minified if not written in a way that supports minification
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/di", target="_blank") https://docs.angularjs.org/guide/di
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#manual-annotating-for-dependency-injection", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#manual-annotating-for-dependency-injection
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#minification-and-annotation", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#minification-and-annotation
.section.section--architecture
.section__header
.section-title Architecture
.section__content
.cards
.card
.card__number 1
.card__title Is there a component-driven structure?
.card__what
.list.list--what
.list-heading What?
.list-item Group scripts, markup and styles by feature
.card__why
.list.list--why
.list-heading Why?
.list-item Components can easily be removed
.list-item Locating related files is easy
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.google.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub", target="_blank") https://docs.google.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#directory-structure", target="_blank") https://github.com/mgechev/angularjs-style-guide#directory-structure
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y120", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y120
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y152", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y152
.card
.card__number 2
.card__title Do directives communicate correctly?
.card__what
.list.list--what
.list-heading What?
.list-item Never rely on scope inheritance e.g. <code>$scope.$parent</code>
.list-item Use directive controllers and <code>require</code> to let directives communicate
.card__why
.list.list--why
.list-heading Why?
.list-item The scope hierarchy may change, breaking your code
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/directive", target="_blank") https://docs.angularjs.org/guide/directive
.list-item
a(href="https://toddmotto.com/directive-to-directive-communication-with-require/", target="_blank") https://toddmotto.com/directive-to-directive-communication-with-require/
.card
.card__number 3
.card__title Is business logic defined in services?
.card__what
.list.list--what
.list-heading What?
.list-item Business logic should be defined in services, not in controllers
.card__why
.list.list--why
.list-heading Why?
.list-item Business logic is centralized and reusable
.list-item Services are really easy to test
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#services", target="_blank") https://github.com/mgechev/angularjs-style-guide#services
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y035", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y035
.card
.card__number 4
.card__title UI-Router: has a default route been configured?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>$urlRouterProvider.otherwise()</code> to specify the default route in case no route definition matches the request
.card__why
.list.list--why
.list-heading Why?
.list-item To gracefully handle requests that do not match to a route definition
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ngRoute/provider/$routeProvider", target="_blank") https://docs.angularjs.org/api/ngRoute/provider/$routeProvider
.card
.card__number 5
.card__title ngRoute: has a default route been configured?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>$routerProvider.otherwise()</code> to specify the default route in case no route definition matches the request
.card__why
.list.list--why
.list-heading Why?
.list-item to gracefully handle requests that do not match to a route definition
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ngRoute/provider/$routeProvider", target="_blank") https://docs.angularjs.org/api/ngRoute/provider/$routeProvider
.card
.card__number 6
.card__title ngRoute: are route errors handled properly?
.card__what
.list.list--what
.list-heading What?
.list-item use a <code>$routeChangeError</code> event listener to handle routing errors
.card__why
.list.list--why
.list-heading Why?
.list-item To gracefully handle routing errors
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y112", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y112
.card
.card__number 7
.card__title UI-Router: are state change errors handled properly?
.card__what
.list.list--what
.list-heading What?
.list-item use a <code>$stateChangeError</code> event listener to handle routing errors
.card__why
.list.list--why
.list-heading Why?
.list-item to gracefully handle errors that occur during state transition (e.g. when a resolve fails)
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/angular-ui/ui-router/wiki#state-change-events", target="_blank") https://github.com/angular-ui/ui-router/wiki#state-change-events
.card
.card__number 8
.card__title Are exceptions handled properly?
.card__what
.list.list--what
.list-heading What?
.list-item decorate the <code>$exceptionHandler</code> service to handle uncaught exceptions
.card__why
.list.list--why
.list-heading Why?
.list-item To gracefully handle uncaught exceptions
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y110", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y110
.card
.card__number 9
.card__title Are resolves used where needed?
.card__what
.list.list--what
.list-heading What?
.list-item Use the <code>resolve</code> property of a route or state to load content that is immediately required in the view
.card__why
.list.list--why
.list-heading Why?
.list-item Make sure content is loaded before view is shown
.list-item Prevent content flashing
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#routing", target="_blank") https://github.com/mgechev/angularjs-style-guide#routing
.list-item
a(href="http://www.jvandemo.com/how-to-resolve-angularjs-resources-with-ui-router/", target="_blank") http://www.jvandemo.com/how-to-resolve-angularjs-resources-with-ui-router/
.list-item
a(href="http://www.jvandemo.com/how-to-resolve-application-wide-resources-centrally-in-angularjs-with-ui-router/", target="_blank") http://www.jvandemo.com/how-to-resolve-application-wide-resources-centrally-in-angularjs-with-ui-router/
.list-item
a(href="https://toddmotto.com/resolve-promises-in-angular-routes/", target="_blank") https://toddmotto.com/resolve-promises-in-angular-routes/
.list-item
a(href="https://johnpapa.net/route-resolve-and-controller-activate-in-angularjs/", target="_blank") https://johnpapa.net/route-resolve-and-controller-activate-in-angularjs/
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y081", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y081
.section.section--security
.section__header
.section-title Security
.section__content
.cards
.card
.card__number 1
.card__title Is Strict Contextual Escaping enabled?
.card__what
.list.list--what
.list-heading What?
.list-item Make sure SCE is enabled
.list-item Use <code>$sce</code> service to explicitly tell AngularJS which content can be marked as safe for a context
.list-item As of version 1.2, AngularJS ships with SCE enabled by default.
.card__why
.list.list--why
.list-heading Why?
.list-item To deal with content that can not be trusted
.list-item With SCE disabled, your application allows a user to render arbitrary data creating security vulnerabilities
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ng/service/$sce", target="_blank") https://docs.angularjs.org/api/ng/service/$sce
.card
.card__number 2
.card__title UI-Router: are private parts of application properly protected?
.card__what
.list.list--what
.list-heading What?
.list-item Use border states to protect private areas in your application
.list-item Use <code>$stateChangeStart</code> event handler to control access
.card__why
.list.list--why
.list-heading Why?
.list-item To restrict access to private areas in your application
.list-item To make sure the states cannot be accessed by guessing the url's
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="http://jvandemo.com/how-to-use-areas-and-border-states-to-control-access-in-an-angular-application-with-ui-router/", target="_blank") http://jvandemo.com/how-to-use-areas-and-border-states-to-control-access-in-an-angular-application-with-ui-router/
.card
.card__number 3
.card__title Is there a server-side template engine involved?
.card__what
.list.list--what
.list-heading What?
.list-item Don't use a server-side template engine for building angular templates
.card__why
.list.list--why
.list-heading Why?
.list-item XSS prevention of the server-side template don't avoid injection of angular expressions
.list-item Violation of this rule can result in a XSS vulnerability
.list-item This issue is called "client-side template injection"
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/security", target="_blank") https://docs.angularjs.org/guide/security
.list-item
a(href="https://portswigger.net/knowledgebase/issues/details/00200308_clientsidetemplateinjection", target="_blank") https://portswigger.net/knowledgebase/issues/details/00200308_clientsidetemplateinjection
.card
.card__number 4
.card__title Is user input used for template generation or in watch expressions?
.card__what
.list.list--what
.list-heading What?
.list-item User input must not be used for template generation: <code>$compile, <code>$parse</code> and <code>$interpolate</code>
.list-item User input must not be used for expressions inside the following functions: watches, <code>$eval</code>, <code>$apply</code> and not in the <code>orderBy</code> pipe
.card__why
.list.list--why
.list-heading Why?
.list-item Violation of this rule can result in a XSS vulnerability
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/security", target="_blank") https://docs.angularjs.org/guide/security
.section.section--accessibility
.section__header
.section-title Accessibility
.section__content
.cards
.card
.card__number 1
.card__title Is ngAria included?
.card__what
.list.list--what
.list-heading What?
.list-item Include the <code>ngAria</code> module as a dependency
.card__why
.list.list--why
.list-heading Why?
.list-item To convey state or semantic information about the application for users of assistive technologies, such as screen readers
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ngAria", target="_blank") https://docs.angularjs.org/api/ngAria
.section.section--performance
.section__header
.section-title Performance
.section__content
.cards
.card
.card__number 1
.card__title Are scripts at bottom of the document?
.card__what
.list.list--what
.list-heading What?
.list-item <code><script></code> elements should be as low as possible in document
.card__why
.list.list--why
.list-heading Why?
.list-item Improves initial rendering speed
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://developer.yahoo.com/blogs/ydn/high-performance-sites-rule-6-move-scripts-bottom-7200.html", target="_blank") https://developer.yahoo.com/blogs/ydn/high-performance-sites-rule-6-move-scripts-bottom-7200.html
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#markup", target="_blank") https://github.com/mgechev/angularjs-style-guide#markup
.card
.card__number 2
.card__title Are styles in HEAD?
.card__what
.list.list--what
.list-heading What?
.list-item Stylesheets should be in the document <code><head></code>
.card__why
.list.list--why
.list-heading Why?
.list-item Improves initial rendering speed
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://developer.yahoo.com/blogs/ydn/high-performance-sites-rule-6-move-scripts-bottom-7200.html", target="_blank") https://developer.yahoo.com/blogs/ydn/high-performance-sites-rule-6-move-scripts-bottom-7200.html
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#markup", target="_blank") https://github.com/mgechev/angularjs-style-guide#markup
.card
.card__number 3
.card__title Is expensive logic avoided in filters?
.card__what
.list.list--what
.list-heading What?
.list-item Filter logic should be lightweight
.card__why
.list.list--why
.list-heading Why?
.list-item Filters are called often during <code>$digest</code> loop so if they are slow, they will slow down your application
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#filters", target="_blank") https://github.com/mgechev/angularjs-style-guide#filters
.list-item
a(href="https://toddmotto.com/use-controller-filters-to-prevent-digest-performance-issues/", target="_blank") https://toddmotto.com/use-controller-filters-to-prevent-digest-performance-issues/
.list-item
a(href="https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y420", target="_blank") https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md#style-y420
.card
.card__number 4
.card__title Is filtering logic handled in controller if needed?
.card__what
.list.list--what
.list-heading What?
.list-item Filtering can be done in controller if the result is not affected by every <code>$digest</code> cycle
.card__why
.list.list--why
.list-heading Why?
.list-item To control manually when the filter should run instead of with every <code>$digest</code> cycle
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://toddmotto.com/use-controller-filters-to-prevent-digest-performance-issues/", target="_blank") https://toddmotto.com/use-controller-filters-to-prevent-digest-performance-issues/
.card
.card__number 5
.card__title Are expensive operations cached?
.card__what
.list.list--what
.list-heading What?
.list-item Cache operations that are expensive (e.g. CPU or bandwidth intensive)
.card__why
.list.list--why
.list-heading Why?
.list-item Optimizes speed by avoiding repetition of expensive operation
.card
.card__number 6
.card__title Are complex expressions avoided in templates?
.card__what
.list.list--what
.list-heading What?
.list-item Complex logic should be handled in controller or service
.card__why
.list.list--why
.list-heading Why?
.list-item View expressions are evaluated many times during <code>$digest</code> cycles
.list-item Putting the logic in a controller or services allows you to cache the result
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#templates", target="_blank") https://github.com/mgechev/angularjs-style-guide#templates
.card
.card__number 7
.card__title Is one-time binding used where possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code ng-non-bindable>{{ :: expression }}</code> for content that does not change after initialization
.card__why
.list.list--why
.list-heading Why?
.list-item AngularJS will stop watching the expression as soon as it evaluates to a non-null value
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/expression", target="_blank") https://docs.angularjs.org/guide/expression
.list-item
a(href="http://blog.thoughtram.io/angularjs/2014/10/14/exploring-angular-1.3-one-time-bindings.html", target="_blank") http://blog.thoughtram.io/angularjs/2014/10/14/exploring-angular-1.3-one-time-bindings.html
.list-item
a(href="http://www.bennadel.com/blog/2760-one-time-data-bindings-for-object-literal-expressions-in-angularjs-1-3.htm", target="_blank") http://www.bennadel.com/blog/2760-one-time-data-bindings-for-object-literal-expressions-in-angularjs-1-3.htm
.card
.card__number 8
.card__title Is logic in watchers kept as simple as possible?
.card__what
.list.list--what
.list-heading What?
.list-item Keep computations in <code>$watch</code> as simple as possible
.list-item Example: watch <code>data.property</code> instead of deep watching data
.card__why
.list.list--why
.list-heading Why?
.list-item Watchers are evaluated many times during <code>$digest</code> cycles so keeping them fast results in better performance
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#performance", target="_blank") https://github.com/mgechev/angularjs-style-guide#performance
.card
.card__number 9
.card__title Is <code>$watchCollection</code> used instead of deep watch where possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>$watchCollection</code> instead of a deep watch for collections
.card__why
.list.list--why
.list-heading Why?
.list-item <code>$watchCollection</code> performs a shallow equality check of the result of the watched expression and its previous value, resulting in better performance
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#performance", target="_blank") https://github.com/mgechev/angularjs-style-guide#performance
.list-item
a(href="https://docs.angularjs.org/guide/scope", target="_blank") https://docs.angularjs.org/guide/scope
.list-item
a(href="https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$watchCollection", target="_blank") https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$watchCollection
.card
.card__number 10
.card__title Is `$applyAsync` used when possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>$scope.$applyAsync()</code>
.list-item Configure <code>$httpProvider</code> to use <code>$applyAsync</code>: <code>$httpProvider.useApplyAsync(true);</code>
.card__why
.list.list--why
.list-heading Why?
.list-item To reduce number of <code>$digest</code> cycles when expressions are evaluated around the same time
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://code.angularjs.org/1.3.8/docs/api/ng/type/$rootScope.Scope#$applyAsync", target="_blank") https://code.angularjs.org/1.3.8/docs/api/ng/type/$rootScope.Scope#$applyAsync
.list-item
a(href="http://blog.thoughtram.io/angularjs/2015/01/14/exploring-angular-1.3-speed-up-with-applyAsync.html", target="_blank") http://blog.thoughtram.io/angularjs/2015/01/14/exploring-angular-1.3-speed-up-with-applyAsync.html
.card
.card__number 11
.card__title Do timers skip `$digest` cycle when possible?
.card__what
.list.list--what
.list-heading What?
.list-item Pass <code>false</code> as third parameter to <code>$timeout</code> when no watched variables are impacted by its callback
.card__why
.list.list--why
.list-heading Why?
.list-item To skip unnecessary <code>$digest</code> cycles
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#performance", target="_blank") https://github.com/mgechev/angularjs-style-guide#performance
.list-item
a(href="https://docs.angularjs.org/api/ng/service/$timeout", target="_blank") https://docs.angularjs.org/api/ng/service/$timeout
.card
.card__number 12
.card__title Are resources cleaned up when scope is destroyed?
.card__what
.list.list--what
.list-heading What?
.list-item use <code>$scope.$on(‘$destroy’, fn)</code> to clean up resources such as timers and intervals
.card__why
.list.list--why
.list-heading Why?
.list-item resources that are not cleaned up can chew up memory and CPU
.list-item every time the scope is recreated (e.g. when page is visited again and again) the problem grows bigger
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/guide/directive", target="_blank") https://docs.angularjs.org/guide/directive
.list-item
a(href="http://odetocode.com/blogs/scott/archive/2013/07/16/angularjs-listening-for-destroy.aspx", target="_blank") http://odetocode.com/blogs/scott/archive/2013/07/16/angularjs-listening-for-destroy.aspx
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#directives", target="_blank") https://github.com/mgechev/angularjs-style-guide#directives
.list-item
a(href="http://www.bennadel.com/blog/2723-unbinding-scope-on-event-handlers-in-angularjs.htm", target="_blank") http://www.bennadel.com/blog/2723-unbinding-scope-on-event-handlers-in-angularjs.htm
.list-item
a(href="http://www.bennadel.com/blog/2548-don-t-forget-to-cancel-timeout-timers-in-your-destroy-events-in-angularjs.htm", target="_blank") http://www.bennadel.com/blog/2548-don-t-forget-to-cancel-timeout-timers-in-your-destroy-events-in-angularjs.htm
.card
.card__number 13
.card__title Are templates bundled with main JavaScript file?
.card__what
.list.list--what
.list-heading What?
.list-item Bundle your templates with your scripts using tools like grunt-html2js or gulp-html2js
.card__why
.list.list--why
.list-heading Why?
.list-item Reduce number of network requests, especially when a large number of templates needs to be downloaded
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://github.com/mgechev/angularjs-style-guide#performance", target="_blank") https://github.com/mgechev/angularjs-style-guide#performance
.list-item
a(href="https://github.com/karlgoldstein/grunt-html2js", target="_blank") https://github.com/karlgoldstein/grunt-html2js
.list-item
a(href="https://github.com/fraserxu/gulp-html2js", target="_blank") https://github.com/fraserxu/gulp-html2js
.card
.card__number 14
.card__title Is ngModelOptions used where possible?
.card__what
.list.list--what
.list-heading What?
.list-item Use <code>ngModelOptions</code> to manually control when <code>$digest</code> cycle should run
.card__why
.list.list--why
.list-heading Why?
.list-item To prevent unnecessary <code>$digest</code> cycles
.card__links
.list.list--links
.list-heading Links
.list-item
a(href="https://docs.angularjs.org/api/ng/directive/ngModelOptions", target="_blank") https://docs.angularjs.org/api/ng/directive/ngModelOptions
.list-item
a(href="https://toddmotto.com/super-fast-angular-ng-model-options-limit-digest-cycles/", target="_blank") https://toddmotto.com/super-fast-angular-ng-model-options-limit-digest-cycles/
.list-item
a(href="http://blog.thoughtram.io/angularjs/2014/10/19/exploring-angular-1.3-ng-model-options.html", target="_blank") http://blog.thoughtram.io/angularjs/2014/10/19/exploring-angular-1.3-ng-model-options.html