├── README.md
├── configs
├── codestyles
│ ├── Prolific.xml
│ ├── ProlificAndroid.xml
│ └── SquareAndroid.xml
└── inspection
│ └── Prolific.xml
└── install.sh
/README.md:
--------------------------------------------------------------------------------
1 | Android Code Styles and Quality Checks
2 | ======================================
3 |
4 | Android Studio code style settings and code quality configs for Prolific's Android projects.
5 |
6 |
7 | Installation for Code Styles
8 | ----------------------------
9 |
10 | * Run the `install.sh` script.
11 | * Restart Android Studio if it's running.
12 | * Open Android Studio Project Settings -> Code Styles, change the code style for the
13 | project to the one you want.
14 |
15 | Adding Code Quality Checks to Project
16 | -------------------------------------
17 |
18 | * Copy the quality folder to your project folder.
19 | * In your `app/build.gradle` file add the following lines whereever you define plugins:
20 | - `apply from: '../quality/quality.gradle'`
21 | - `apply from: '../quality/jacoco/jacoco.gradle'`
22 |
23 | * __Run the task using `./gradlew check`__
24 |
25 | License
26 | -------
27 |
28 | [](https://creativecommons.org/publicdomain/zero/1.0/legalcode)
29 |
--------------------------------------------------------------------------------
/configs/codestyles/Prolific.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
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 |
--------------------------------------------------------------------------------
/configs/codestyles/ProlificAndroid.xml:
--------------------------------------------------------------------------------
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 | true
267 | true
268 | true
269 | true
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | true
279 | true
280 | true
281 | true
282 |
283 |
284 |
285 |
286 |
287 |
288 |
289 |
290 | true
291 | true
292 | true
293 | true
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
302 | true
303 | true
304 | true
305 | true
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 | true
315 | true
316 | true
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 | true
326 | true
327 | true
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 | true
337 | true
338 | true
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 | true
348 | true
349 | true
350 |
351 |
352 |
353 |
354 |
355 |
356 |
357 |
358 | true
359 | true
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 | true
369 | true
370 | true
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 | true
380 | true
381 | true
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 | true
391 | true
392 | true
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 | true
402 | true
403 | true
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 | true
413 | true
414 |
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 | true
423 | true
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 | true
433 | true
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 | true
443 | true
444 |
445 |
446 |
447 |
448 |
449 |
450 |
451 | true
452 |
453 |
454 |
455 |
456 |
457 |
458 | true
459 |
460 |
461 |
462 |
463 |
464 |
465 | true
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 | true
474 | true
475 |
476 |
477 | BY_NAME
478 |
479 |
480 |
481 |
482 |
483 |
484 | getLayoutId
485 |
486 |
487 |
488 |
489 |
490 |
491 |
492 |
493 |
494 | initializeDependencyInjector
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 | onAttach
505 |
506 |
507 |
508 |
509 |
510 |
511 |
512 |
513 |
514 | onCreate
515 |
516 |
517 |
518 |
519 |
520 |
521 |
522 |
523 |
524 | onCreateView
525 |
526 |
527 |
528 |
529 |
530 |
531 |
532 |
533 |
534 | onViewCreated
535 |
536 |
537 |
538 |
539 |
540 |
541 |
542 |
543 |
544 | onActivityCreated
545 |
546 |
547 |
548 |
549 |
550 |
551 |
552 |
553 |
554 | onStart
555 |
556 |
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 | onActivityResult
565 |
566 |
567 |
568 |
569 |
570 |
571 |
572 |
573 |
574 | onPostCreate
575 |
576 |
577 |
578 |
579 |
580 |
581 |
582 |
583 |
584 | onResume
585 |
586 |
587 |
588 |
589 |
590 |
591 |
592 |
593 |
594 | onPostResume
595 |
596 |
597 |
598 |
599 |
600 |
601 |
602 |
603 |
604 | onNewIntent
605 |
606 |
607 |
608 |
609 |
610 |
611 |
612 |
613 |
614 | onCreateOptionsMenu
615 |
616 |
617 |
618 |
619 |
620 |
621 |
622 |
623 |
624 | onPrepareOptionsMenu
625 |
626 |
627 |
628 |
629 |
630 |
631 |
632 |
633 |
634 | onOptionsItemSelected
635 |
636 |
637 |
638 |
639 |
640 |
641 |
642 |
643 |
644 | onPause
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 | onSaveInstanceState
655 |
656 |
657 |
658 |
659 |
660 |
661 |
662 |
663 |
664 | onStop
665 |
666 |
667 |
668 |
669 |
670 |
671 |
672 |
673 |
674 | onDestroyView
675 |
676 |
677 |
678 |
679 |
680 |
681 |
682 |
683 |
684 | onDestroy
685 |
686 |
687 |
688 |
689 |
690 |
691 |
692 |
693 |
694 | onDetach
695 |
696 |
697 |
698 |
699 |
700 |
701 |
702 |
703 |
704 | getSystemService
705 |
706 |
707 |
708 |
709 |
710 |
711 |
712 |
713 |
714 | true
715 | setUpViews
716 | true
717 |
718 |
719 |
720 |
721 |
722 |
723 |
724 |
725 | true
726 | observeView
727 |
728 |
729 |
730 |
731 |
732 |
733 |
734 |
735 |
736 | true
737 | toBuilder
738 |
739 |
740 |
741 |
742 |
743 |
744 |
745 |
746 | true
747 |
748 |
749 |
750 | BY_NAME
751 |
752 |
753 |
754 |
755 |
756 |
757 | true
758 |
759 | true
760 | true
761 |
762 |
763 | BY_NAME
764 |
765 |
766 |
767 |
768 |
769 |
770 | true
771 | true
772 |
773 |
774 | BY_NAME
775 |
776 |
777 |
778 |
779 |
780 |
781 | true
782 | true
783 |
784 |
785 | BY_NAME
786 |
787 |
788 |
789 |
790 |
791 |
792 | true
793 | true
794 |
795 |
796 | BY_NAME
797 |
798 |
799 |
800 |
801 |
802 |
803 | true
804 | true
805 |
806 |
807 | BY_NAME
808 |
809 |
810 |
811 |
812 |
813 | true
814 |
815 | BY_NAME
816 |
817 |
818 |
819 |
820 |
821 | true
822 |
823 | BY_NAME
824 |
825 |
826 |
827 |
828 |
829 | true
830 |
831 | BY_NAME
832 |
833 |
834 |
835 |
836 |
837 |
838 | true
839 | true
840 |
841 |
842 | BY_NAME
843 |
844 |
845 |
846 |
847 |
848 | true
849 |
850 | BY_NAME
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 | class
924 |
925 |
926 |
927 |
928 |
929 |
930 | layout
931 |
932 |
933 |
934 |
935 |
936 |
937 | xmlns:android
938 |
939 |
940 |
941 |
942 |
943 |
944 | xmlns:.*
945 |
946 | BY_NAME
947 |
948 |
949 |
950 |
951 |
952 | type
953 |
954 |
955 |
956 |
957 |
958 |
959 |
960 | .*:id
961 | http://schemas.android.com/apk/res/android
962 |
963 |
964 |
965 |
966 |
967 |
968 |
969 |
970 | .*:name
971 | http://schemas.android.com/apk/res/android
972 |
973 |
974 |
975 |
976 |
977 |
978 |
979 |
980 | .*:layout_width
981 | http://schemas.android.com/apk/res/android
982 |
983 |
984 |
985 |
986 |
987 |
988 |
989 |
990 | .*:layout_height
991 | http://schemas.android.com/apk/res/android
992 |
993 |
994 |
995 |
996 |
997 |
998 |
999 |
1000 | .*:layout_.*
1001 | http://schemas.android.com/apk/res/android
1002 |
1003 |
1004 | BY_NAME
1005 |
1006 |
1007 |
1008 |
1009 |
1010 | http://schemas.android.com/apk/res/android
1011 |
1012 | BY_NAME
1013 |
1014 |
1015 |
1016 |
1017 |
1018 | http://schemas.android.com/apk/res-auto
1019 |
1020 | BY_NAME
1021 |
1022 |
1023 |
1024 |
1025 |
1026 | http://schemas.android.com/tools
1027 |
1028 | BY_NAME
1029 |
1030 |
1031 |
1032 |
1033 |
1034 | .*
1035 |
1036 | BY_NAME
1037 |
1038 |
1039 |
1040 |
1041 |
1042 |
1043 |
1044 |
1045 |
1046 |
1047 |
1048 |
1049 |
1050 |
1051 |
1052 |
1053 |
1054 |
1055 |
1056 |
1057 |
--------------------------------------------------------------------------------
/configs/codestyles/SquareAndroid.xml:
--------------------------------------------------------------------------------
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 | class
278 |
279 |
280 |
281 |
282 |
283 |
284 | layout
285 |
286 |
287 |
288 |
289 |
290 |
291 | xmlns:android
292 |
293 |
294 |
295 |
296 |
297 |
298 | xmlns:.*
299 |
300 | BY_NAME
301 |
302 |
303 |
304 |
305 |
306 |
307 | .*:id
308 | http://schemas.android.com/apk/res/android
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 | .*:name
318 | http://schemas.android.com/apk/res/android
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | .*:layout_width
328 | http://schemas.android.com/apk/res/android
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 | .*:layout_height
338 | http://schemas.android.com/apk/res/android
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 | .*:layout_.*
348 | http://schemas.android.com/apk/res/android
349 |
350 |
351 | BY_NAME
352 |
353 |
354 |
355 |
356 |
357 |
358 | .*
359 | http://schemas.android.com/apk/res/android
360 |
361 |
362 | BY_NAME
363 |
364 |
365 |
366 |
367 |
368 | .*(?<!style)$
369 |
370 | BY_NAME
371 |
372 |
373 |
374 |
375 |
376 | style
377 |
378 |
379 |
380 |
381 |
382 |
383 |
--------------------------------------------------------------------------------
/configs/inspection/Prolific.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/install.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | # Installs Prolific's IntelliJ configs into your user configs.
3 |
4 | echo "Installing Prolific code style configs..."
5 |
6 | CONFIGS="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )/configs"
7 |
8 | for i in $HOME/Library/Preferences/IntelliJIdea* \
9 | $HOME/Library/Preferences/IdeaIC* \
10 | $HOME/Library/Preferences/AndroidStudio* \
11 | $HOME/.IntelliJIdea*/config \
12 | $HOME/.IdeaIC*/config \
13 | $HOME/.AndroidStudio*/config
14 | do
15 | if [[ -d $i ]]; then
16 |
17 | # Install codestyles
18 | mkdir -p $i/codestyles
19 | cp -frv "$CONFIGS/codestyles"/* $i/codestyles
20 |
21 | # Install inspections
22 | mkdir -p $i/inspection
23 | cp -frv "$CONFIGS/inspection"/* $i/inspection
24 | fi
25 | done
26 |
27 | echo "Done."
28 | echo ""
29 | echo "Restart IntelliJ and/or AndroidStudio, go to preferences, and apply 'Prolific' or 'ProlificAndroid'."
30 |
31 |
--------------------------------------------------------------------------------