Commit9d01dfe

committed

Add Yamllint documentation and configuration

1 parentba5b505 commit9d01dfeCopy full SHA for 9d01dfe

File tree

+48

-0

lines changed

+48

-0

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -44,3 +44,5 @@ Remove extraneous f prefix`
`44`	`44`	`-[Hadolint](./hadolint.md)`
`45`	`45`	`-[SwiftLint](./swiftlint.md)`
`46`	`46`	`-[PHPStan](./phpstan.md)`
	`47`	`+-[golangci-lint](./golangci-lint.md)`
	`48`	`+-[YamlLint](./yamllint.md)`

Lines changed: 46 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,46 @@`
	`1`	`+---`
	`2`	`+title:Yamllint`
	`3`	`+sidebar_label:Yamllint`
	`4`	`+description:CodeRabbit's guide to Yamllint.`
	`5`	`+sidebar_position:8`
	`6`	`+---`
	`7`	`+`
	`8`	`+[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.`
	`9`	`+`
	`10`	`+##Files`
	`11`	`+`
	`12`	`+Yamllint will run on files with the following extensions:`
	`13`	`+`
	`14`	+-`.yaml`
	`15`	+-`.yml`
	`16`	`+`
	`17`	`+##Configuration`
	`18`	`+`
	`19`	`+Yamllint supports the following config files:`
	`20`	`+`
	`21`	+-`.yamllint`
	`22`	+-`.yamllint.yaml`
	`23`	+-`.yamllint.yml`
	`24`	`+`
	`25`	`+CodeRabbit will use the following settings based on the profile selected if no config file is found:`
	`26`	`+`
	`27`	`+###Chill`
	`28`	`+`
	`29`	+```yaml
	`30`	`+extends:relaxed`
	`31`	`+rules:`
	`32`	`+line-length:disable`
	`33`	+```
	`34`	`+`
	`35`	`+### Assertive`
	`36`	`+`
	`37`	+```yaml
	`38`	`+extends:default`
	`39`	`+rules:`
	`40`	`+line-length:disable`
	`41`	`+document-start:disable`
	`42`	+```
	`43`	`+`
	`44`	`+## Links`
	`45`	`+`
	`46`	`+- [Yamllint Configuration](https://yamllint.readthedocs.io/en/stable/configuration.html)`

Comments

(0)