-
Notifications
You must be signed in to change notification settings - Fork 51
Expand file tree
/
Copy pathschema.v2.json
More file actions
2145 lines (2145 loc) · 68.3 KB
/
Copy pathschema.v2.json
File metadata and controls
2145 lines (2145 loc) · 68.3 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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"language": {
"default": "en-US",
"description": "Set the language for reviews by using the corresponding ISO language code.",
"type": "string",
"enum": [
"de",
"de-DE",
"de-AT",
"de-CH",
"en",
"en-US",
"en-AU",
"en-GB",
"en-CA",
"en-NZ",
"en-ZA",
"es",
"es-AR",
"fr",
"fr-CA",
"fr-CH",
"fr-BE",
"nl",
"nl-BE",
"pt-AO",
"pt",
"pt-BR",
"pt-MZ",
"pt-PT",
"ar",
"ast-ES",
"ast",
"be-BY",
"be",
"br-FR",
"br",
"ca-ES",
"ca",
"ca-ES-valencia",
"ca-ES-balear",
"da-DK",
"da",
"de-DE-x-simple-language",
"el-GR",
"el",
"eo",
"fa",
"ga-IE",
"ga",
"gl-ES",
"gl",
"it",
"ja-JP",
"ja",
"km-KH",
"km",
"ko-KR",
"ko",
"pl-PL",
"pl",
"ro-RO",
"ro",
"ru-RU",
"ru",
"sk-SK",
"sk",
"sl-SI",
"sl",
"sv",
"ta-IN",
"ta",
"tl-PH",
"tl",
"tr",
"uk-UA",
"uk",
"zh-CN",
"zh",
"crh-UA",
"crh",
"cs-CZ",
"cs",
"nb",
"no",
"nl-NL",
"de-DE-x-simple-language-DE",
"es-ES",
"it-IT",
"fa-IR",
"sv-SE",
"de-LU",
"fr-FR",
"bg-BG",
"bg",
"he-IL",
"he",
"hi-IN",
"hi",
"vi-VN",
"vi",
"th-TH",
"th",
"bn-BD",
"bn"
],
"enumNames": [
"German",
"German (Germany)",
"German (Austria)",
"German (Swiss)",
"English",
"English (US)",
"English (Australian)",
"English (GB)",
"English (Canadian)",
"English (New Zealand)",
"English (South African)",
"Spanish",
"Spanish (voseo)",
"French",
"French (Canada)",
"French (Switzerland)",
"French (Belgium)",
"Dutch",
"Dutch (Belgium)",
"Portuguese (Angola preAO)",
"Portuguese",
"Portuguese (Brazil)",
"Portuguese (Moçambique preAO)",
"Portuguese (Portugal)",
"Arabic",
"Asturian",
"Asturian",
"Belarusian",
"Belarusian",
"Breton",
"Breton",
"Catalan",
"Catalan",
"Catalan (Valencian)",
"Catalan (Balearic)",
"Danish",
"Danish",
"Simple German",
"Greek",
"Greek",
"Esperanto",
"Persian",
"Irish",
"Irish",
"Galician",
"Galician",
"Italian",
"Japanese",
"Japanese",
"Khmer",
"Khmer",
"Korean",
"Korean",
"Polish",
"Polish",
"Romanian",
"Romanian",
"Russian",
"Russian",
"Slovak",
"Slovak",
"Slovenian",
"Slovenian",
"Swedish",
"Tamil",
"Tamil",
"Tagalog",
"Tagalog",
"Turkish",
"Ukrainian",
"Ukrainian",
"Chinese",
"Chinese",
"Crimean Tatar",
"Crimean Tatar",
"Czech",
"Czech",
"Norwegian",
"Norwegian (Bokmål)",
"Dutch (Netherlands)",
"Simple German",
"Spanish",
"Italian",
"Persian",
"Swedish",
"German (Luxembourg)",
"French",
"Bulgarian",
"Bulgarian",
"Hebrew",
"Hebrew",
"Hindi",
"Hindi",
"Vietnamese",
"Vietnamese",
"Thai",
"Thai",
"Bengali",
"Bengali"
]
},
"tone_instructions": {
"default": "",
"description": "Set the tone of reviews and chat. Example: 'You must talk like Mr. T. I pity the fool who doesn't!'",
"type": "string",
"maxLength": 250
},
"early_access": {
"default": false,
"description": "Enable early-access features.",
"type": "boolean"
},
"enable_free_tier": {
"default": true,
"description": "Enable free tier features for users not on a paid plan.",
"type": "boolean"
},
"inheritance": {
"default": false,
"description": "Inheritance | Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level.",
"type": "boolean"
},
"reviews": {
"default": {},
"description": "Settings related to reviews.",
"type": "object",
"properties": {
"profile": {
"default": "chill",
"description": "Set the review profile: `chill` for lighter feedback, `assertive` for more feedback (which may feel nitpicky).",
"type": "string",
"enum": ["chill", "assertive"]
},
"request_changes_workflow": {
"default": false,
"description": "Automatically approve once CodeRabbit’s comments are resolved and no pre-merge checks are failing. Note: In GitLab, all discussions must be resolved.",
"type": "boolean"
},
"high_level_summary": {
"default": true,
"description": "Generate a high-level summary of the changes in the PR description or walkthrough.",
"type": "boolean"
},
"high_level_summary_instructions": {
"default": "",
"description": "By default, CodeRabbit generates release notes in the description. Use this to customize the summary content and format. Example: 'Create concise release notes as a bullet-point list, followed by a Markdown table showing lines added and removed by each contributing author.' Note: Use `high_level_summary_in_walkthrough` to place the summary in the walkthrough instead of the description.",
"type": "string"
},
"high_level_summary_placeholder": {
"default": "@coderabbitai summary",
"description": "Placeholder in the PR description that CodeRabbit replaces with the high-level summary. If `high_level_summary` is false, the summary is still generated when this placeholder is present.",
"type": "string"
},
"high_level_summary_in_walkthrough": {
"default": false,
"description": "Include the high-level summary in the walkthrough comment.",
"type": "boolean"
},
"auto_title_placeholder": {
"default": "@coderabbitai",
"description": "Add this keyword to the PR title to auto-generate a title.",
"type": "string"
},
"auto_title_instructions": {
"default": "",
"description": "Auto Title Instructions | Customize how CodeRabbit generates the PR title.",
"type": "string"
},
"review_status": {
"default": true,
"description": "Post review status messages (e.g., when a review is skipped) in the walkthrough summary comment.",
"type": "boolean"
},
"review_details": {
"default": false,
"description": "Post review details (ignored files, extra context used, suppressed comments, etc.).",
"type": "boolean"
},
"commit_status": {
"default": true,
"description": "Set the commit status to 'pending' when the review is in progress and 'success' when it is complete.",
"type": "boolean"
},
"fail_commit_status": {
"default": false,
"description": "Set the commit status to 'failure' when the PR cannot be reviewed by CodeRabbit for any reason.",
"type": "boolean"
},
"collapse_walkthrough": {
"default": true,
"description": "Wrap the walkthrough in a Markdown collapsible section.",
"type": "boolean"
},
"changed_files_summary": {
"default": true,
"description": "Include a summary of the changed files in the walkthrough.",
"type": "boolean"
},
"sequence_diagrams": {
"default": true,
"description": "Include sequence diagrams in the walkthrough.",
"type": "boolean"
},
"estimate_code_review_effort": {
"default": true,
"description": "Include an estimated code review effort in the walkthrough.",
"type": "boolean"
},
"assess_linked_issues": {
"default": true,
"description": "Include an assessment of how well the changes address linked issues in the walkthrough.",
"type": "boolean"
},
"related_issues": {
"default": true,
"description": "Include potentially related issues in the walkthrough.",
"type": "boolean"
},
"related_prs": {
"default": true,
"description": "Related PRs | Include potentially related PRs in the walkthrough.",
"type": "boolean"
},
"suggested_labels": {
"default": true,
"description": "Suggest labels based on the changes, and include them in the walkthrough.",
"type": "boolean"
},
"labeling_instructions": {
"default": [],
"description": "Labeling Instructions | Define allowed labels and when to suggest them. When provided, CodeRabbit suggests only from this list (still informed by prior PRs); when empty, suggestions rely entirely on prior PRs.",
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label to suggest for the PR. Example: frontend"
},
"instructions": {
"type": "string",
"maxLength": 3000,
"description": "Instructions for the label. Example: Apply when the PR contains changes to React components."
}
},
"required": ["label", "instructions"]
}
},
"mutually_exclusive_groups": {
"default": {},
"description": "Mutually Exclusive Groups | Define labels that should not coexist. Example: { risk: ['critical', 'high', 'medium', 'low'] }.",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1
},
"additionalProperties": {
"minItems": 2,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"auto_apply_labels": {
"default": false,
"description": "Automatically apply suggested labels to the PR.",
"type": "boolean"
},
"suggested_reviewers": {
"default": true,
"description": "Suggest reviewers based on the changes, and include them in the walkthrough.",
"type": "boolean"
},
"auto_assign_reviewers": {
"default": false,
"description": "Automatically assign the suggested reviewers to the PR.",
"type": "boolean"
},
"suggested_reviewers_instructions": {
"default": [],
"description": "Reviewer Instructions | Map reviewers (users or team) to PR scenarios where they should be assigned. When empty, suggestions rely on prior PRs. Team handles are supported only on GitHub.",
"type": "array",
"items": {
"type": "object",
"properties": {
"reviewers": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"handle": {
"type": "string",
"minLength": 1,
"description": "Reviewer username or team slug to assign. Example: security-pdl"
},
"type": {
"default": "user",
"description": "Whether the reviewer is an individual user or a team/group.",
"type": "string",
"enum": ["user", "group"]
}
},
"required": ["handle"]
},
"description": "List of reviewers to assign when the PR matches the instructions below. Each entry pairs a handle (username or team slug) with its type (user or group)."
},
"instructions": {
"type": "string",
"minLength": 1,
"maxLength": 3000,
"description": "Instructions for when to assign these reviewers. Example: Assign when the PR contains Windows registry changes."
}
},
"required": ["reviewers", "instructions"]
}
},
"in_progress_fortune": {
"default": true,
"description": "Post a fortune message while the review is running.",
"type": "boolean"
},
"poem": {
"default": true,
"description": "Generate a poem in the walkthrough comment.",
"type": "boolean"
},
"enable_prompt_for_ai_agents": {
"default": true,
"description": "Prompt for AI Agents | Include the '🤖 Prompt for AI Agents' section in inline review comments to provide codegen instructions for AI agents.",
"type": "boolean"
},
"path_filters": {
"default": [],
"description": "Specify file patterns to include or exclude in a review using glob patterns (e.g., `!dist/**`, `src/**`). These patterns also apply to 'git sparse-checkout', including specified patterns and ignoring excluded ones (starting with '!') when cloning the repository.",
"type": "array",
"items": {
"type": "string"
}
},
"path_instructions": {
"default": [],
"description": "Path Instructions | Add path-specific guidance for code review.",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "File path glob pattern. Example: `**/*.js`."
},
"instructions": {
"type": "string",
"maxLength": 20000,
"description": "Additional review guidance for matching paths."
}
},
"required": ["path", "instructions"]
}
},
"abort_on_close": {
"default": true,
"description": "Abort the in-progress review if the PR is closed or merged.",
"type": "boolean"
},
"disable_cache": {
"default": false,
"description": "Disable caching of code and dependencies; fetch them fresh on each run.",
"type": "boolean"
},
"slop_detection": {
"description": "Anti-Slop | Settings for detecting and managing spam or low-quality PRs. Only for public repos, only for GitHub as of now.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable or disable slop and low-quality PR detection.",
"type": "boolean"
},
"label": {
"description": "Label to apply to the PR when it is classified as slop. Example: slop",
"type": "string",
"minLength": 1
}
}
},
"auto_review": {
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Automatic Review | Review PRs automatically.",
"type": "boolean"
},
"description_keyword": {
"default": "",
"description": "Keyword in the PR description that triggers a review when automatic reviews are disabled. If `enabled` is false and this field is not empty, CodeRabbit reviews the PR only when this keyword is present in the description.",
"type": "string"
},
"auto_incremental_review": {
"default": true,
"description": "Incremental Review | Re-run the review on each push.",
"type": "boolean"
},
"auto_pause_after_reviewed_commits": {
"default": 5,
"description": "Auto Pause After Reviewed Commits | Pause automatic reviews after this many reviewed commits since the last pause. Set to 0 to disable.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"ignore_title_keywords": {
"default": [],
"description": "Skip reviews when the PR title contains any of these keywords (case-insensitive).",
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"default": [],
"description": "Labels that control which PRs are reviewed. Labels starting with '!' are negative matches. Examples: ['bug', 'feature'] reviews PRs with either label. ['!wip'] reviews all PRs except those labeled 'wip'. ['bug', '!wip'] reviews PRs labeled 'bug' but not 'wip'. This setting also triggers a review when `enabled` is false.",
"type": "array",
"items": {
"type": "string"
}
},
"drafts": {
"default": false,
"description": "Include draft PRs.",
"type": "boolean"
},
"base_branches": {
"default": [],
"description": "Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches.",
"type": "array",
"items": {
"type": "string"
}
},
"ignore_usernames": {
"default": [],
"description": "Skip reviews for PRs authored by these usernames (exact match; not email addresses).",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"finishing_touches": {
"default": {},
"type": "object",
"properties": {
"docstrings": {
"description": "Docstrings | Configure docstring generation.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Docstrings | Enable the docstrings finishing touch (trigger via the 📝 Generate docstrings checkbox or `@coderabbitai generate docstrings`). CodeRabbit generates or improves docstrings for functions changed in the PR and opens a follow-up PR containing the docstring edits.",
"type": "boolean"
}
}
},
"unit_tests": {
"description": "Unit Tests | Configure unit test generation.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Unit Tests | Generate unit tests for changes in PRs.",
"type": "boolean"
}
}
},
"simplify": {
"description": "Simplify | Configure code simplification.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": false,
"description": "Simplify | Enable the simplify finishing touch (trigger via the ✨ Simplify code checkbox). CodeRabbit reviews changed code for reuse, quality, and efficiency, then applies targeted improvements.",
"type": "boolean"
}
}
},
"custom": {
"default": [],
"description": "Custom Recipes | Define up to 5 custom finishing touch recipes. Trigger a recipe with `@coderabbitai run <recipe name>`.",
"maxItems": 5,
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enabled | Enable this custom finishing touch recipe.",
"type": "boolean"
},
"name": {
"default": "",
"description": "Name | Recipe name used in commands (for example: `@coderabbitai run cleanup stale imports`). Run with `@coderabbitai run <recipe name>`.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"instructions": {
"default": "",
"description": "Instructions | Describe what this recipe should do. Trigger with `@coderabbitai run <recipe name>` or the checkbox under \"✨ Finishing Touches\". CodeRabbit provides PR context and runs this with an agent.",
"type": "string",
"minLength": 1,
"maxLength": 10000
}
}
}
}
}
},
"pre_merge_checks": {
"default": {},
"type": "object",
"properties": {
"override_requested_reviewers_only": {
"default": false,
"description": "Override Requested Reviewers Only | When enabled, only requested reviewers (and not the pull request author) can override/ignore failing pre-merge checks.",
"type": "boolean"
},
"docstrings": {
"description": "Docstring Coverage | Check that docstring coverage meets the configured threshold.",
"default": {},
"type": "object",
"properties": {
"mode": {
"default": "warning",
"description": "Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes.",
"type": "string",
"enum": ["off", "warning", "error"]
},
"threshold": {
"default": 80,
"description": "Threshold | Minimum docstring coverage (%) required to pass.",
"type": "number",
"minimum": 0,
"maximum": 100
}
}
},
"title": {
"description": "Title Check | Validate the PR title against the requirements.",
"default": {},
"type": "object",
"properties": {
"mode": {
"default": "warning",
"description": "Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes.",
"type": "string",
"enum": ["off", "warning", "error"]
},
"requirements": {
"default": "",
"description": "Requirements | Describe title requirements. Example: 'Title should be concise and descriptive, ideally under 50 characters.'",
"type": "string"
}
}
},
"description": {
"description": "Description Check | Check that the PR description follows best practices.",
"default": {},
"type": "object",
"properties": {
"mode": {
"default": "warning",
"description": "Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes.",
"type": "string",
"enum": ["off", "warning", "error"]
}
}
},
"issue_assessment": {
"description": "Linked Issue Assessment | Assess how well the PR addresses linked issues.",
"default": {},
"type": "object",
"properties": {
"mode": {
"default": "warning",
"description": "Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes.",
"type": "string",
"enum": ["off", "warning", "error"]
}
}
},
"custom_checks": {
"default": [],
"description": "Custom Pre-merge Checks | Define custom checks that must pass before merging. Each check needs a unique name (≤50 chars) and deterministic instructions (≤10,000 chars).",
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"mode": {
"default": "warning",
"description": "Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes.",
"type": "string",
"enum": ["off", "warning", "error"]
},
"name": {
"default": "",
"description": "Name | Display name (max 50 characters).",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"instructions": {
"default": "",
"description": "Instructions | Deterministic pass/fail criteria (max 10,000 characters).",
"type": "string",
"minLength": 1,
"maxLength": 10000
}
}
}
}
}
},
"tools": {
"default": {},
"description": "Tools that provide additional context to code reviews.",
"type": "object",
"properties": {
"ast-grep": {
"description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.44.0",
"default": {},
"type": "object",
"properties": {
"rule_dirs": {
"default": [],
"description": "List of rules directories.",
"type": "array",
"items": {
"type": "string"
}
},
"util_dirs": {
"default": [],
"description": "List of utils directories.",
"type": "array",
"items": {
"type": "string"
}
},
"essential_rules": {
"default": true,
"description": "Use ast-grep essentials package.",
"type": "boolean"
},
"packages": {
"default": [],
"description": "Predefined packages to be used.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"shellcheck": {
"description": "ShellCheck is a static analysis tool that finds bugs in your shell scripts.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable ShellCheck | ShellCheck is a static analysis tool that finds bugs in your shell. | Enable ShellCheck integration. | v0.11.0",
"type": "boolean"
}
}
},
"ruff": {
"description": "Ruff is a Python linter and code formatter.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.15.18",
"type": "boolean"
}
}
},
"markdownlint": {
"description": "markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.22.1",
"type": "boolean"
}
}
},
"github-checks": {
"description": "GitHub Checks integration configuration.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable GitHub Checks\n\t\t\t| Enable integration, defaults to true\n\t\t\t| Enable GitHub Checks integration.",
"type": "boolean"
},
"timeout_ms": {
"default": 90000,
"description": "Time in milliseconds to wait for all GitHub Checks to conclude. Default 90 seconds, max 15 minutes (900000ms).",
"type": "number",
"minimum": 0,
"maximum": 900000
}
}
},
"languagetool": {
"description": "LanguageTool is a style and grammar checker for 30+ languages.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable LanguageTool | Enable LanguageTool integration.",
"type": "boolean"
},
"enabled_rules": {
"default": [],
"description": "IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule.",
"type": "array",
"items": {
"type": "string"
}
},
"disabled_rules": {
"default": [],
"description": "IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled.",
"type": "array",
"items": {
"type": "string"
}
},
"enabled_categories": {
"default": [],
"description": "IDs of categories to be enabled.",
"type": "array",
"items": {
"type": "string"
}
},
"disabled_categories": {
"default": [],
"description": "IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled.",
"type": "array",
"items": {
"type": "string"
}
},
"enabled_only": {
"default": false,
"description": "Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled.",
"type": "boolean"
},
"level": {
"default": "default",
"description": "If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text.",
"type": "string",
"enum": ["default", "picky"]
}
}
},
"biome": {
"description": "Biome is a fast formatter, linter, and analyzer for web projects.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.5.0",
"type": "boolean"
}
}
},
"hadolint": {
"description": "Hadolint is a Dockerfile linter.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable Hadolint | Hadolint is a Dockerfile linter. | Enable Hadolint integration. | v2.14.0",
"type": "boolean"
}
}
},
"swiftlint": {
"description": "SwiftLint integration configuration object.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable SwiftLint | SwiftLint is a Swift linter. | Enable SwiftLint integration. | v0.64.0",
"type": "boolean"
},
"config_file": {
"description": "Optional path to the SwiftLint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.swiftlint.yml' or '.swiftlint.yaml'.",
"type": "string"
}
}
},
"phpstan": {
"description": "PHPStan is a tool to analyze PHP code.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.2.2",
"type": "boolean"
},
"level": {
"default": "default",
"description": "Level | Specify the [rule level](https://phpstan.org/user-guide/rule-levels) to run. When set to `default`, the level is determined by the review profile: `chill` uses level 3 (real bugs only — return/property type mismatches, array offset errors) and `assertive` uses level 8 (adds dead code detection, argument type checking, null safety, and typehint checks). This setting is ignored if your configuration file already has a `level:` parameter.",
"type": "string",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"default",
"max"
]
}
}
},
"phpmd": {
"description": "PHPMD is a tool to find potential problems in PHP code.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable PHPMD | PHPMD is a tool to find potential problems in PHP code. | v2.15.0",
"type": "boolean"
}
}
},
"phpcs": {
"description": "PHP CodeSniffer is a PHP linter and coding standard checker.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable PHP CodeSniffer | PHP CodeSniffer is a PHP linter and coding standard checker. | v3.7.2",
"type": "boolean"
}
}
},
"golangci-lint": {
"description": "golangci-lint is a fast linters runner for Go.",
"default": {},
"type": "object",
"properties": {
"enabled": {
"default": true,
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.12.2",
"type": "boolean"
},
"config_file": {
"description": "Optional path to the golangci-lint configuration file relative to the repository. Useful when the configuration file is named differently than the default '.golangci.yml', '.golangci.yaml', '.golangci.toml', '.golangci.json'.",