Skip to content

Establish style guide #40

@corvus-ch

Description

@corvus-ch

Require all jsonnet code to be compliant with jsonnetfmt using the default options. For CI/CD pipelines, the command jsonnetfmt --test **/*.jsonnet can be used, while autoformatting can be done using jsonnetfmt -i **/*.jsonnet.

jsonnetfmt is documented at https://jsonnet.org/learning/tools.html.

For YAML files, we should use yamllint For CI/CD pipelines, the command yamllint -f parsable --no-warnings **/*.yml can be used. For checking before commiting, yamllint **/*.yml will do the trick.

Rule wise, we might opt to make line-length a warning instead an error and or increase the character count from 80 to something like 120. Subject to be discussed.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions