forked from sds/overcommit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdefault.yml
1287 lines (1126 loc) · 33.5 KB
/
default.yml
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
# Default configuration that all Overcommit configurations inherit from.
#
# This is an opinionated list of which hooks are valuable to run and what their
# out-of-the-box settings should be.
#-------------------------------------------------------------------------------
# Loads Bundler context from a Gemfile. If false, does nothing (default).
#
# Specifying a Gemfile for Bundler to load allows you to control which gems are
# available in the load path (i.e. loadable via `require`) within your hook
# runs. Note that having a Gemfile requires you to include `overcommit` itself
# in your Gemfile (otherwise Overcommit can't load itself!).
#
# This is useful if you want to:
#
# - Enforce a specific version of Overcommit to use for all hook runs
# (or to use a version from the master branch that has not been released yet)
# - Enforce a specific version or unreleased branch is used for a gem you want
# to use in your git hooks
#
# WARNING: This makes your hook runs slower, but you can work around this!
#
# Loading a Bundler context necessarily adds a startup delay to your hook runs
# as Bundler parses the Gemfile and checks that the dependencies are satisfied.
# Thus for projects with many gems this can introduce a noticeable delay.
#
# The recommended workaround is to create a separate Gemfile in the root of your
# repository (call it `.overcommit_gems.rb`), and include only the gems that
# your Overcommit hooks need in order to run. This significantly reduces the
# startup delay in your hook runs. Make sure to commit both
# `.overcommit_gems.rb` and the resulting `.overcommit_gems.rb.lock` file to
# your repository, and then set the `gemfile` option below to the name you gave
# the file.
# (Generate lock file by running `bundle install --gemfile=.overcommit_gems.rb`)
gemfile: false
# Where to store hook plugins specific to a repository. These are loaded in
# addition to the default hooks Overcommit comes with. The location is relative
# to the root of the repository.
plugin_directory: '.git-hooks'
# Whether to hide hook output by default. This results in completely silent hook
# runs except in the case of warning or failure.
quiet: false
# Number of hooks that can be run concurrently. Typically this won't need to be
# adjusted, but if you know that some of your hooks themselves use multiple
# processors you can lower this value accordingly. You can define
# single-operator mathematical expressions, e.g. '%{processors} * 2', or
# '%{processors} / 2'.
concurrency: '%{processors}'
# Whether to check if a hook plugin has changed since Overcommit last ran it.
# This is a defense mechanism when working with repositories which can contain
# untrusted code (e.g. when you fetch a pull request from a third party).
# See https://github.com/brigade/overcommit#security for more information.
verify_signatures: true
# Hooks that are run against every commit message after a user has written it.
# These hooks are useful for enforcing policies on commit messages written for a
# project.
CommitMsg:
ALL:
requires_files: false
quiet: false
CapitalizedSubject:
enabled: true
description: 'Check subject capitalization'
EmptyMessage:
enabled: true
description: 'Check for empty commit message'
quiet: true
GerritChangeId:
enabled: false
description: 'Ensure Gerrit Change-Id is present'
required: true
HardTabs:
enabled: false
description: 'Check for hard tabs'
MessageFormat:
enabled: false
description: 'Check commit message matches expected pattern'
pattern: '(.+)[|](.+)[|](.+)'
expected_pattern_message: '<Issue Id> | <Commit Message Description> | <Developer(s)>'
sample_message: 'DEFECT-1234 | Refactored Onboarding flow | John Doe'
RussianNovel:
enabled: false
description: 'Check length of commit message'
quiet: true
SingleLineSubject:
enabled: true
description: 'Check subject line'
SpellCheck:
enabled: false
description: 'Check for misspelled words'
required_executable: 'hunspell'
flags: ['-a']
TextWidth:
enabled: true
description: 'Check text width'
max_subject_width: 60
min_subject_width: 0
max_body_width: 72
TrailingPeriod:
enabled: true
description: 'Check for trailing periods in subject'
# Hooks that are run after `git commit` is executed, before the commit message
# editor is displayed. These hooks are ideal for syntax checkers, linters, and
# other checks that you want to run before you allow a commit object to be
# created.
PreCommit:
ALL:
problem_on_unmodified_line: report
requires_files: true
required: false
quiet: false
AuthorEmail:
enabled: true
description: 'Check author email'
requires_files: false
required: true
quiet: true
pattern: '^[^@]+@.*$'
AuthorName:
enabled: true
description: 'Check for author name'
requires_files: false
required: true
quiet: true
BerksfileCheck:
enabled: false
description: 'Check Berksfile lock'
required_executable: 'berks'
flags: ['list', '--quiet']
install_command: 'gem install berks'
include:
- 'Berksfile'
- 'Berksfile.lock'
BrokenSymlinks:
enabled: true
description: 'Check for broken symlinks'
quiet: true
BundleAudit:
enabled: false
description: 'Check for vulnerable versions of gems'
required_executable: 'bundle-audit'
install_command: 'gem install bundler-audit'
BundleCheck:
enabled: false
description: 'Check Gemfile dependencies'
required_executable: 'bundle'
flags: ['check']
install_command: 'gem install bundler'
include:
- 'Gemfile'
- 'Gemfile.lock'
- '*.gemspec'
BundleOutdated:
enabled: false
description: 'List installed gems with newer versions available'
required_executable: 'bundle'
flags: ['outdated', '--strict', '--parseable']
install_command: 'gem install bundler'
CaseConflicts:
enabled: true
description: 'Check for case-insensitivity conflicts'
quiet: true
ChamberCompare:
enabled: false
description: 'Check that settings are equivalent between namespaces'
required_executable: 'chamber'
flags: ['compare']
install_command: 'gem install chamber'
namespaces:
- ['development']
- ['test']
- ['production']
exclusions: []
include: &chamber_settings_files
- 'config/settings*.yml'
- 'config/settings*.yml.erb'
- 'config/settings/**/*.yml'
- 'config/settings/**/*.yml.erb'
- 'settings*.yml'
- 'settings*.yml.erb'
- 'settings/**/*.yml'
- 'settings/**/*.yml.erb'
ChamberSecurity:
enabled: false
description: 'Check that settings have been secured with Chamber'
required_executable: 'chamber'
flags: ['secure', '--files']
install_command: 'gem install chamber'
include: *chamber_settings_files
ChamberVerification:
enabled: false
description: 'Verify that all settings changes have been approved'
required_executable: 'chamber'
flags: ['sign', '--verify']
install_command: 'gem install chamber'
include: *chamber_settings_files
CoffeeLint:
enabled: false
description: 'Analyze with coffeelint'
required_executable: 'coffeelint'
flags: ['--reporter=csv']
install_command: 'npm install -g coffeelint'
include: '**/*.coffee'
CookStyle:
enabled: false
description: 'Analyze with CookStyle'
required_executable: 'cookstyle'
flags: ['--format=emacs', '--force-exclusion', '--display-cop-names']
install_command: 'gem install cookstyle'
include:
- '**/*.rb'
- '**/*.erb'
Credo:
enabled: false
description: 'Analyze with credo'
required_executable: 'mix'
flags: ['credo', '--all', '--strict', '--format', 'flycheck']
include:
- '**/*.ex'
- '**/*.exs'
CssLint:
enabled: false
description: 'Analyze with csslint'
required_executable: 'csslint'
flags: ['--quiet', '--format=compact']
install_command: 'npm install -g csslint'
include: '**/*.css'
Dogma:
enabled: false
description: 'Analyze with dogma'
required_executable: 'mix'
flags: ['dogma']
include:
- '**/*.ex'
- '**/*.exs'
EsLint:
enabled: false
description: 'Analyze with ESLint'
required_executable: 'eslint'
flags: ['--format=compact']
install_command: 'npm install -g eslint'
include: '**/*.js'
ExecutePermissions:
enabled: false
description: 'Check for file execute permissions'
quiet: true
Fasterer:
enabled: false
description: 'Analyzing for potential speed improvements'
required_executable: 'fasterer'
install_command: 'gem install fasterer'
include: '**/*.rb'
FixMe:
enabled: false
description: 'Check for "token" strings'
required_executable: 'grep'
flags: ['-IEHnw']
keywords: ['BROKEN', 'BUG', 'ERROR', 'FIXME', 'HACK', 'NOTE', 'OPTIMIZE', 'REVIEW', 'TODO', 'WTF', 'XXX']
FileSize:
enabled: false
description: 'Check for oversized files'
size_limit_bytes: 1_000_000
Flay:
enabled: false
description: 'Analyze ruby code for structural similarities with Flay'
required_executable: 'flay'
install_command: 'gem install flay'
mass_threshold: 16
fuzzy: 1
liberal: false
include: '**/*.rb'
Foodcritic:
enabled: false
description: 'Analyze with Foodcritic'
required_executable: 'foodcritic'
flags: ['--epic-fail=any']
install_command: 'gem install foodcritic'
ForbiddenBranches:
enabled: false
description: 'Check for commit to forbidden branch'
quiet: true
branch_patterns: ['master']
GoLint:
enabled: false
description: 'Analyze with golint'
required_executable: 'golint'
install_command: 'go get github.com/golang/lint/golint'
include: '**/*.go'
GoVet:
enabled: false
description: 'Analyze with go vet'
required_executable: 'go'
flags: ['tool', 'vet']
install_command: 'go get golang.org/x/tools/cmd/vet'
include: '**/*.go'
Hadolint:
enabled: false
description: 'Analyze with hadolint'
required_executable: 'hadolint'
include:
- '**/Dockerfile*'
HamlLint:
enabled: false
description: 'Analyze with haml-lint'
required_executable: 'haml-lint'
install_command: 'gem install haml-lint'
flags: ['--no-summary']
include: '**/*.haml'
HardTabs:
enabled: false
description: 'Check for hard tabs'
quiet: true
required_executable: 'grep'
flags: ['-IHn', "\t"]
exclude:
- '**/Makefile'
- '**/*.go'
Hlint:
enabled: false
description: 'Analyze with hlint'
required_executable: 'hlint'
install_command: 'cabal install hlint'
include: '**/*.hs'
HtmlHint:
enabled: false
description: 'Analyze with HTMLHint'
required_executable: 'htmlhint'
install_command: 'npm install -g htmlhint'
include: '**/*.html'
HtmlTidy:
enabled: false
description: 'Analyze HTML with tidy'
required_executable: 'tidy'
flags: ['-errors', '-quiet', '-utf8']
include: '**/*.html'
ImageOptim:
enabled: false
description: 'Check for optimizable images'
required_executable: 'image_optim'
install_command: 'gem install image_optim'
include:
- '**/*.gif'
- '**/*.jpeg'
- '**/*.jpg'
- '**/*.png'
- '**/*.svg'
JavaCheckstyle:
enabled: false
description: 'Analyze with checkstyle'
required_executable: 'checkstyle'
flags: ['-c', '/sun_checks.xml']
include: '**/*.java'
Jscs:
enabled: false
description: 'Analyze with JSCS'
required_executable: 'jscs'
flags: ['--reporter=inline']
install_command: 'npm install -g jscs'
include: '**/*.js'
JsHint:
enabled: false
description: 'Analyze with JSHint'
required_executable: 'jshint'
flags: ['--verbose']
install_command: 'npm install -g jshint'
include: '**/*.js'
JsLint:
enabled: false
description: 'Analyze with JSLint'
required_executable: 'jslint'
flags: ['--terse']
install_command: 'npm install -g jslint'
include: '**/*.js'
Jsl:
enabled: false
description: 'Analyze with JSL'
required_executable: 'jsl'
flags: ['-nologo', '-nofilelisting', '-nocontext', '-nosummary']
include: '**/*.js'
JsonSyntax:
enabled: false
description: 'Validate JSON syntax'
required_library: 'json'
install_command: 'gem install json'
include: '**/*.json'
KtLint:
enabled: false
description: 'Analyze with KtLint'
required_executable: 'ktlint'
flags: []
include: '**/*.kt'
LicenseFinder:
enabled: false
description: 'Analyze with LicenseFinder'
required_executable: 'license_finder'
install_command: 'gem install license_finder'
include:
- 'Gemfile'
- 'requirements.txt'
- 'package.json'
- 'pom.xml'
- 'build.gradle'
- 'bower.json'
- 'Podfile'
- 'rebar.config'
LicenseHeader:
enabled: false
license_file: 'LICENSE.txt'
description: 'Check source files for license headers'
LocalPathsInGemfile:
enabled: false
description: 'Check for local paths in Gemfile'
required_executable: 'grep'
flags: ['-IHnE', "^[^#]*((\\bpath:)|(:path[ \t]*=>))"]
include: '**/Gemfile'
Mdl:
enabled: false
description: 'Analyze markdown files with mdl'
required_executable: 'mdl'
install_command: 'gem install mdl'
include: '**/*.md'
MergeConflicts:
enabled: true
description: 'Check for merge conflicts'
quiet: true
required_executable: 'grep'
flags: ['-IHn', "^<<<<<<<[ \t]"]
PuppetMetadataJsonLint:
enabled: false
description: 'Checking module metadata'
flags: ['--strict-license', '--strict-dependencies', '--fail-on-warning']
include: 'metadata.json'
required_executable: 'metadata-json-lint'
install_command: 'gem install metadata-json-lint'
NginxTest:
enabled: false
description: 'Test nginx configs'
required_executable: 'nginx'
flags: ['-t']
include: '**/nginx.conf'
Pep257: # Deprecated – use Pydocstyle instead.
enabled: false
description: 'Analyze docstrings with pep257'
required_executable: 'pep257'
install_command: 'pip install pep257'
include: '**/*.py'
Pep8: # Deprecated – use Pycodestyle instead.
enabled: false
description: 'Analyze with pep8'
required_executable: 'pep8'
install_command: 'pip install pep8'
include: '**/*.py'
PhpLint:
enabled: false
description: 'Testing with PHP lint'
required_executable: 'php'
command: 'php'
flags: ['-l']
include: '**/*.php'
PhpCs:
enabled: false
description: 'Analyze with PHP_CodeSniffer'
command: 'vendor/bin/phpcs'
flags: ['--standard=PSR2', '--report=csv']
include: '**/*.php'
PhpCsFixer:
enabled: false
description: 'Fix non compliant PHP files'
required_executable: 'php-cs-fixer'
command: 'vendor/bin/php-cs-fixer'
flags: ['fix', '-v', '--path-mode=intersection']
install_command: 'composer global require friendsofphp/php-cs-fixer'
include: '**/*.php'
PhpStan:
description: 'Analyze with phpstan'
enabled: false
command: 'phpstan'
flags: ['analyze', '--errorFormat=raw']
include:
- '**/*.php'
Pronto:
enabled: false
description: 'Analyzing with pronto'
required_executable: 'pronto'
install_command: 'gem install pronto'
flags: ['run', '--staged', '--exit-code']
PuppetLint:
enabled: false
description: 'Analyze with puppet-lint'
required_executable: 'puppet-lint'
install_command: 'gem install puppet-lint'
flags:
- '--log-format="%{fullpath}:%{line}:%{column}:%{KIND}: %{message} (%{check})"'
- '--fail-on-warnings'
- '--error-level=all'
include: '**/*.pp'
Pycodestyle:
enabled: false
description: 'Analyze with pycodestyle'
required_executable: 'pycodestyle'
install_command: 'pip install pycodestyle'
include: '**/*.py'
Pydocstyle:
enabled: false
description: 'Analyze docstrings with pydocstyle'
required_executable: 'pydocstyle'
install_command: 'pip install pydocstyle'
include: '**/*.py'
Pyflakes:
enabled: false
description: 'Analyze with pyflakes'
required_executable: 'pyflakes'
install_command: 'pip install pyflakes'
include: '**/*.py'
Pylint:
enabled: false
description: 'Analyze with Pylint'
required_executable: 'pylint'
install_command: 'pip install pylint'
flags:
- '--msg-template="{path}:{line}:{C}: {msg} ({symbol})"'
- '--reports=n'
- '--persistent=n'
include: '**/*.py'
PythonFlake8:
enabled: false
description: 'Analyze with flake8'
required_executable: 'flake8'
install_command: 'pip install flake8'
include: '**/*.py'
RakeTarget:
enabled: false
description: 'Run rake targets'
# targets:
# - 'lint'
# - 'validate'
# - '...'
required_executable: 'rake'
install_command: 'gem install rake'
RailsBestPractices:
enabled: false
description: 'Analyze with RailsBestPractices'
required_executable: 'rails_best_practices'
flags: ['--without-color']
install_command: 'gem install rails_best_practices'
RailsSchemaUpToDate:
enabled: false
description: 'Check if database schema is up to date'
include:
- 'db/migrate/*.rb'
- 'db/schema.rb'
- 'db/structure.sql'
Reek:
enabled: false
description: 'Analyze with Reek'
required_executable: 'reek'
flags: ['--single-line', '--no-color', '--force-exclusion']
install_command: 'gem install reek'
include:
- '**/*.gemspec'
- '**/*.rake'
- '**/*.rb'
- '**/Gemfile'
- '**/Rakefile'
RstLint:
enabled: false
description: 'Analyze reStructuredText files with rst-lint'
required_executable: 'rst-lint'
install_command: 'pip install restructuredtext_lint'
include: '**/*.rst'
RuboCop:
enabled: false
description: 'Analyze with RuboCop'
required_executable: 'rubocop'
flags: ['--format=emacs', '--force-exclusion', '--display-cop-names']
install_command: 'gem install rubocop'
include:
- '**/*.gemspec'
- '**/*.rake'
- '**/*.rb'
- '**/*.ru'
- '**/Gemfile'
- '**/Rakefile'
RubyLint:
enabled: false
description: 'Analyze with ruby-lint'
required_executable: 'ruby-lint'
flags: ['--presenter=syntastic', '--levels=error,warning']
install_command: 'gem install ruby-lint'
include:
- '**/*.gemspec'
- '**/*.rb'
Scalariform:
enabled: false
description: 'Check formatting with Scalariform'
required_executable: 'scalariform'
flags: ['--test']
include: '**/*.scala'
Scalastyle:
enabled: false
description: 'Analyze with Scalastyle'
required_executable: 'scalastyle'
include: '**/*.scala'
ScssLint:
enabled: false
description: 'Analyze with scss-lint'
required_library: 'json'
required_executable: 'scss-lint'
flags: ['--format', 'JSON']
install_command: 'gem install scss_lint'
include: '**/*.scss'
SemiStandard:
enabled: false
description: 'Analyze with semistandard'
required_executable: 'semistandard'
flags: ['--verbose']
install_command: 'npm install -g semistandard'
include: '**/*.js'
ShellCheck:
enabled: false
description: 'Analyze with ShellCheck'
required_executable: 'shellcheck'
flags: ['--format=gcc']
include: '**/*.sh'
SlimLint:
enabled: false
description: 'Analyze with slim-lint'
required_executable: 'slim-lint'
install_command: 'gem install slim_lint'
include: '**/*.slim'
Sqlint:
enabled: false
description: 'Analyze with sqlint'
required_executable: 'sqlint'
install_command: 'gem install sqlint'
include: '**/*.sql'
Standard:
enabled: false
description: 'Analyze with standard'
required_executable: 'standard'
flags: ['--verbose']
install_command: 'npm install -g standard'
include: '**/*.js'
Stylelint:
enabled: false
description: 'Check styles with Stylelint'
require_executable: 'stylelint'
flags: ['-f', 'compact']
install_command: 'npm install -g stylelint'
include:
- '**/*.scss'
- '**/*.css'
- '**/*.less'
SwiftLint:
enabled: false
description: 'Analyze with SwiftLint'
required_executable: 'swiftlint'
flags: ['lint', '--strict']
install_command: 'brew install swiftlint'
include: '**/*.swift'
TerraformFormat:
enabled: false
description: 'Analyze with Terraform'
required_executable: 'terraform'
flags: ['fmt', '-check=true', '-diff=false']
include: '**/*.tf'
TsLint:
enabled: false
description: 'Analyze with TSLint'
required_executable: 'tslint'
install_command: 'npm install -g tslint typescript'
include: '**/*.ts'
TrailingWhitespace:
enabled: false
description: 'Check for trailing whitespace'
required_executable: 'grep'
flags: ['-IHn', "[ \t]$"]
TravisLint:
enabled: false
description: 'Check Travis CI configuration'
required_executable: 'travis'
flags: ['lint']
install_command: 'gem install travis'
include: '.travis.yml'
Vint:
enabled: false
description: 'Analyze with Vint'
required_executable: 'vint'
install_command: 'pip install vim-vint'
include:
- '**/*.vim'
- '**/*.vimrc'
W3cCss:
enabled: false
description: 'Analyze with W3C CSS validation service'
required_library: 'w3c_validators'
install_command: 'gem install w3c_validators'
validator_uri: 'http://jigsaw.w3.org/css-validator/validator'
language: 'en'
profile: 'css3'
warn_level: 2
include:
- '**/*.css'
W3cHtml:
enabled: false
description: 'Analyze with W3C HTML validation service'
required_library: 'w3c_validators'
install_command: 'gem install w3c_validators'
validator_uri: 'https://validator.w3.org/nu'
charset: 'utf-8'
doctype: 'HTML5'
include:
- '**/*.html'
LineEndings:
description: 'Check line endings'
enabled: false
eol: "\n" # or "\r\n" for Windows-style newlines
XmlLint:
enabled: false
description: 'Analyze with xmllint'
required_executable: 'xmllint'
flags: ['--noout']
include:
- '**/*.xml'
- '**/*.svg'
XmlSyntax:
enabled: false
description: 'Check XML syntax'
required_library: 'rexml/document'
include:
- '**/*.xml'
- '**/*.svg'
YamlLint:
enabled: false
description: 'Analyze with YAMLlint'
required_executable: 'yamllint'
flags: ['--format=parsable']
install_command: 'pip install yamllint'
include:
- '**/*.yaml'
- '**/*.yml'
YamlSyntax:
enabled: false
description: 'Check YAML syntax'
required_library: 'yaml'
include:
- '**/*.yaml'
- '**/*.yml'
YardCoverage:
enabled: false
description: 'Checking for yard coverage'
command: ['yard', 'stats', '--list-undoc', '--compact']
flags: ['--private', '--protected']
required_executable: 'yard'
install_command: 'gem install yard'
min_coverage_percentage: 100
include:
- '/**/*.rb'
YarnCheck:
enabled: false
description: 'Check yarn.lock dependencies'
required_executable: 'yarn'
flags: ['check', '--silent', '--no-progress', '--non-interactive']
install_command: 'npm install --global yarn'
include:
- 'package.json'
- 'yarn.lock'
# Hooks that run after HEAD changes or a file is explicitly checked out.
PostCheckout:
ALL:
required: false
quiet: false
skip_file_checkout: true
BowerInstall:
enabled: false
description: 'Install bower dependencies'
requires_files: true
required_executable: 'bower'
install_command: 'npm install -g bower'
flags: ['install']
include: 'bower.json'
BundleInstall:
enabled: false
description: 'Install Bundler dependencies'
requires_files: true
required_executable: 'bundle'
install_command: 'gem install bundler'
flags: ['install']
include:
- 'Gemfile'
- 'Gemfile.lock'
- '*.gemspec'
ComposerInstall:
enabled: false
description: 'Install composer dependencies'
requires_files: true
required_executable: 'composer'
install_command: 'curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer'
flags: ['install']
include: 'composer.json'
GitLfs:
enabled: false
description: 'Check status of lockable files tracked by Git LFS'
required_executable: 'git-lfs'
install_command: 'brew install git-lfs'
IndexTags:
enabled: false
description: 'Generate tags file from source'
quiet: true
required_executable: 'ctags'
NpmInstall:
enabled: false
description: 'Install NPM dependencies'
requires_files: true
required_executable: 'npm'
flags: ['install']
include:
- 'package.json'
- 'npm-shrinkwrap.json'
SubmoduleStatus:
enabled: false
description: 'Check submodule status'
quiet: true
recursive: false
YarnInstall:
enabled: false
description: 'Install Yarn dependencies'
requires_files: true
required_executable: 'yarn'
flags: ['install']
include:
- 'package.json'
- 'yarn.lock'
# Hooks that run after a commit is created.
PostCommit:
ALL:
requires_files: false
required: false
quiet: false
BowerInstall:
enabled: false
description: 'Install bower dependencies'
requires_files: true
required_executable: 'bower'
install_command: 'npm install -g bower'
flags: ['install']
include: 'bower.json'
BundleInstall:
enabled: false
description: 'Install Bundler dependencies'
requires_files: true
required_executable: 'bundle'
install_command: 'gem install bundler'
flags: ['install']
include:
- 'Gemfile'
- 'Gemfile.lock'
- '*.gemspec'
Commitplease:
enabled: false
description: 'Analyze with Commitplease'
required_executable: './node_modules/.bin/commitplease'
install_command: 'npm install --save-dev commitplease'
flags: ['-1']
ComposerInstall:
enabled: false
description: 'Install composer dependencies'
requires_files: true
required_executable: 'composer'
install_command: 'curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer'
flags: ['install']
include: 'composer.json'
GitGuilt:
enabled: false
description: 'Calculate changes in blame since last commit'
requires_files: true
required_executable: 'git-guilt'
flags: ['HEAD~', 'HEAD']