-
Notifications
You must be signed in to change notification settings - Fork 26
/
Copy pathschema.v2.json
812 lines (812 loc) · 26.6 KB
/
schema.v2.json
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
{
"$ref": "#/definitions/schema",
"definitions": {
"schema": {
"type": "object",
"properties": {
"language": {
"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",
"nb",
"no",
"nl-NL",
"de-DE-x-simple-language-DE",
"es-ES",
"it-IT",
"fa-IR",
"sv-SE",
"de-LU",
"fr-FR"
],
"default": "en-US",
"description": "Set the language for reviews by using the corresponding ISO language code."
},
"tone_instructions": {
"type": "string",
"maxLength": 250,
"default": "",
"description": "Set the tone of reviews and chat. Example: 'You must use talk like Mr. T. I pity the fool who doesn't!'"
},
"early_access": {
"type": "boolean",
"default": false,
"description": "Enable early-access features."
},
"enable_free_tier": {
"type": "boolean",
"default": true,
"description": "Enable free tier features for users not on a paid plan."
},
"reviews": {
"type": "object",
"properties": {
"profile": {
"type": "string",
"enum": ["chill", "assertive"],
"default": "chill",
"description": "Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky."
},
"request_changes_workflow": {
"type": "boolean",
"default": false,
"description": "Approve the review once CodeRabbit's comments are resolved. Note: In GitLab, all discussions must be resolved."
},
"high_level_summary": {
"type": "boolean",
"default": true,
"description": "Generate a high level summary of the changes in the PR/MR description."
},
"high_level_summary_placeholder": {
"type": "string",
"default": "@coderabbitai summary",
"description": "Placeholder in the PR/MR description that gets replaced with the high level summary."
},
"auto_title_placeholder": {
"type": "string",
"default": "@coderabbitai",
"description": "Add this keyword in the PR/MR title to auto-generate the title."
},
"review_status": {
"type": "boolean",
"default": true,
"description": "Post review details on each review. Additionally, post a review status when a review is skipped in certain cases."
},
"poem": {
"type": "boolean",
"default": true,
"description": "Generate a poem in the walkthrough comment."
},
"collapse_walkthrough": {
"type": "boolean",
"default": false,
"description": "Generate walkthrough in a markdown collapsible section."
},
"sequence_diagrams": {
"type": "boolean",
"default": true,
"description": "Generate sequence diagrams in the walkthrough."
},
"changed_files_summary": {
"type": "boolean",
"default": true,
"description": "Generate a summary of the changed files in the walkthrough."
},
"labeling_instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Label to suggest for the PR/MR. Example: frontend"
},
"instructions": {
"type": "string",
"maxLength": 3000,
"description": "Instructions for the label. Example: Apply when the PR/MR contains changes to the react components."
}
},
"required": ["label", "instructions"],
"additionalProperties": false
},
"default": [],
"description": "Labeling Instructions | Provide guidelines for suggesting labels for the PR/MR. When specific labels or instructions are provided, only those labels are considered, though previous examples are still used to inform the suggestions. If no such labels are provided, suggestions are based solely on previous PR/MRs."
},
"path_filters": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Specify file patterns to exclude or include for a review. Accepts glob patterns. Example: !dist/**, src/**"
},
"path_instructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "File path glob pattern. Example: **/*.js"
},
"instructions": {
"type": "string",
"maxLength": 3000,
"description": "Provides specific additional guidelines for code review based on file paths."
}
},
"required": ["path", "instructions"],
"additionalProperties": false
},
"default": [],
"description": "Path Instructions | Provide specific additional guidelines for code review based on file paths."
},
"abort_on_close": {
"type": "boolean",
"default": true,
"description": "Abort the in-progress review if the pull request is closed or merged."
},
"auto_review": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Automatic Review | Automatic code review"
},
"auto_incremental_review": {
"type": "boolean",
"default": true,
"description": "Automatic Incremental Review | Automatic incremental code review on each push"
},
"ignore_title_keywords": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive)."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Restrict automatic reviews to only those pull requests that match one of the specified labels."
},
"drafts": {
"type": "boolean",
"default": false,
"description": "Review draft PRs/MRs."
},
"base_branches": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Base branches (other than the default branch) to review. Accepts regex patterns."
}
},
"additionalProperties": false,
"default": {}
},
"tools": {
"type": "object",
"properties": {
"ast-grep": {
"type": "object",
"properties": {
"rule_dirs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of rules directories."
},
"util_dirs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of utils directories."
},
"essential_rules": {
"type": "boolean",
"default": true,
"description": "Use ast-grep essentials package."
},
"packages": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Predefined packages to be used."
}
},
"additionalProperties": false,
"description": "ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns."
},
"shellcheck": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable ShellCheck | ShellCheck is a static analysis tool that finds bugs in your shell. | Enable shellcheck integration. | v0.9.0"
}
},
"additionalProperties": false,
"default": {},
"description": "Shellcheck is a static analysis tool that finds bugs in your shell scripts."
},
"ruff": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable ruff integration. | v0.6.5"
}
},
"additionalProperties": false,
"default": {},
"description": "Ruff is a Python linter and code formatter."
},
"markdownlint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Markdownlint\n\t\t\t\t| Markdownlint is a static analysis tool for Node.js with a library of rules to enforce standards and consistency for Markdown files.\n\t\t\t\t| Enable markdownlint integration.\n\t\t\t\t| v0.34.0"
}
},
"additionalProperties": false,
"default": {},
"description": "Markdownlint is a static analysis tool to enforce standards and consistency for Markdown files."
},
"github-checks": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable GitHub Checks\n\t\t\t| Enable integration, defaults to true\n\t\t\t| Enable GitHub Checks integration."
},
"timeout_ms": {
"type": "number",
"maximum": 300000,
"minimum": 0,
"default": 90000,
"description": "Time in milliseconds to wait for all GitHub Checks to conclude."
}
},
"additionalProperties": false,
"default": {},
"description": "GitHub Checks integration configuration."
},
"languagetool": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable LanguageTool | Enable LanguageTool integration."
},
"enabled_rules": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule."
},
"disabled_rules": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled."
},
"enabled_categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of categories to be enabled."
},
"disabled_categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled."
},
"enabled_only": {
"type": "boolean",
"default": false,
"description": "Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled."
},
"level": {
"type": "string",
"enum": ["default", "picky"],
"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."
}
},
"additionalProperties": false,
"default": {},
"description": "LanguageTool is a style and grammar checker for 30+ languages."
},
"biome": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v1.8.3"
}
},
"additionalProperties": false,
"default": {},
"description": "Biome is a fast formatter, linter, and analyzer for web projects."
},
"hadolint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Hadolint | Hadolint is a Dockerfile linter. | Enable Hadolint integration. | v2.12.0"
}
},
"additionalProperties": false,
"default": {},
"description": "Hadolint is a Dockerfile linter."
},
"swiftlint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable SwiftLint | SwiftLint is a Swift linter. | Enable SwiftLint integration. | v0.57.0"
},
"config_file": {
"type": "string",
"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'."
}
},
"additionalProperties": false,
"default": {},
"description": "SwiftLint integration configuration object."
},
"phpstan": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"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. | v1.11.7"
},
"level": {
"type": "string",
"enum": [
"default",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"max"
],
"default": "default",
"description": "Level | Specify the [rule level](https://phpstan.org/user-guide/rule-levels) to run. This setting is ignored if your configuration file already has a `level:` parameter."
}
},
"additionalProperties": false,
"default": {},
"description": "PHPStan is a tool to analyze PHP code."
},
"golangci-lint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v1.59.1"
},
"config_file": {
"type": "string",
"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'."
}
},
"additionalProperties": false,
"default": {},
"description": "golangci-lint is a fast linters runner for Go."
},
"yamllint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Yamllint | yamllint is a linter for YAML files. | Enable yamllint integration. | v1.29.0"
}
},
"additionalProperties": false,
"default": {},
"description": "yamllint is a linter for YAML files."
},
"gitleaks": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Gitleaks | Gitleaks is a secret scanner. | Enable Gitleaks integration. | v8.19.2"
}
},
"additionalProperties": false,
"default": {},
"description": "Gitleaks is a secret scanner."
},
"checkov": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Checkov | Checkov is a static code analysis tool for infrastructure-as-code files. | v3.2.254"
}
},
"additionalProperties": false,
"default": {},
"description": "Checkov is a static code analysis tool for infrastructure-as-code files."
},
"detekt": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Detekt | Detekt is a static code analysis tool for Kotlin files. | v1.23.7"
},
"config_file": {
"type": "string",
"description": "Optional path to the Detekt configuration file relative to the repository."
}
},
"additionalProperties": false,
"default": {},
"description": "Detekt is a static code analysis tool for Kotlin files."
},
"eslint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable ESLint | ESLint is a static code analysis tool for JavaScript files."
}
},
"additionalProperties": false,
"default": {},
"description": "ESLint is a static code analysis tool for JavaScript files."
},
"rubocop": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Rubocop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.65.0"
}
},
"additionalProperties": false,
"default": {},
"description": "RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter."
},
"buf": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Buf | Buf offers linting for Protobuf files. | v1.42.0"
}
},
"additionalProperties": false,
"default": {},
"description": "Buf offers linting for Protobuf files."
},
"regal": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Regal | Regal is a linter and language server for Rego. | v0.25.0"
}
},
"additionalProperties": false,
"default": {},
"description": "Regal is a linter and language server for Rego."
},
"actionlint": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Actionlint | is a static checker for GitHub Actions workflow files. | v1.7.1"
}
},
"additionalProperties": false,
"default": {},
"description": "actionlint is a static checker for GitHub Actions workflow files."
},
"pmd": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Pmd | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.5.0"
},
"config_file": {
"type": "string",
"description": "Optional path to the Pmd configuration file relative to the repository."
}
},
"additionalProperties": false,
"default": {},
"description": "PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java."
},
"cppcheck": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.10.2"
}
},
"additionalProperties": false,
"default": {},
"description": "Cppcheck is a static code analysis tool for the C and C++ programming languages."
},
"semgrep": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.29.0"
},
"config_file": {
"type": "string",
"description": "Optional path to the Semgrep configuration file relative to the repository."
}
},
"additionalProperties": false,
"default": {},
"description": "Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues."
},
"circleci": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Enable CircleCi | CircleCi tool is a static checker for CircleCi config files. | v0.1.30995"
}
},
"additionalProperties": false,
"default": {},
"description": "CircleCi tool is a static checker for CircleCi config files."
}
},
"additionalProperties": false,
"description": "Tools that provide additional context to code reviews.",
"default": {}
}
},
"additionalProperties": false,
"description": "Settings related to reviews.",
"default": {}
},
"chat": {
"type": "object",
"properties": {
"auto_reply": {
"type": "boolean",
"default": true,
"description": "Enable the bot to reply automatically without requiring the user to tag it."
}
},
"additionalProperties": false,
"default": {}
},
"knowledge_base": {
"type": "object",
"properties": {
"opt_out": {
"type": "boolean",
"default": false,
"description": "Opt out | Opt out of all knowledge base features."
},
"learnings": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["local", "global", "auto"],
"default": "auto",
"description": "Learnings | Specify the scope of learnings to use for the knowledge base. 'local' uses the repository's learnings, 'global' uses the organization's learnings, and 'auto' uses repository's learnings for public repositories and organization's learnings for private repositories."
}
},
"additionalProperties": false,
"default": {}
},
"issues": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["local", "global", "auto"],
"default": "auto",
"description": "Issues | Specify the scope of git platform (GitHub/GitLab) issues to use for the knowledge base. 'local' uses the repository's issues, 'global' uses the organization's issues, and 'auto' uses repository's issues for public repositories and organization's issues for private repositories."
}
},
"additionalProperties": false,
"default": {}
},
"jira": {
"type": "object",
"properties": {
"project_keys": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Jira Project Keys | Specify the Jira project keys to use for the knowledge base."
}
},
"additionalProperties": false,
"default": {}
},
"linear": {
"type": "object",
"properties": {
"team_keys": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Linear Team Keys | Specify the Linear team keys (identifiers) to use for the knowledge base. E.g. 'ENG'"
}
},
"additionalProperties": false,
"default": {}
},
"pull_requests": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["local", "global", "auto"],
"default": "auto",
"description": "Pull Requests | Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories."
}
},
"additionalProperties": false,
"default": {}
},
"pull_requests": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["local", "global", "auto"],
"default": "auto",
"description": "Pull Requests | Specify the scope of pull requests to use for the knowledge base. 'local' uses the repository's pull requests, 'global' uses the organization's pull requests, and 'auto' uses repository's pull requests for public repositories and organization's pull requests for private repositories."
}
},
"additionalProperties": false,
"default": {}
}
},
"additionalProperties": false,
"default": {}
}
},
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}