YAML文件检查器。
项目描述
YAML文件检查器。
yamllint不仅检查语法有效性,还检查诸如键重复和如行长度、尾随空格、缩进等外观问题。
用Python编写(仅与Python 3兼容)。
文档
概览
屏幕截图
安装
使用pip,Python包管理器
pip install --user yamllint
yamllint也打包适用于所有主要操作系统,请参阅安装示例(dnf,apt-get…)在文档中。
用法
# Lint one or more files
yamllint my_file.yml my_other_file.yaml ...
# Lint all YAML files in a directory
yamllint .
# Use a pre-defined lint configuration
yamllint -d relaxed file.yaml
# Use a custom lint configuration
yamllint -c /path/to/myconfig file-to-lint.yaml
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
yamllint -f parsable file.yaml
特性
以下是一个yamllint配置文件示例
extends: default
rules:
# 80 chars should be enough, but don't fail if a line is longer
line-length:
max: 80
level: warning
# don't bother me with this rule
indentation: disable
在YAML文件中,可以使用特殊注释来禁用对单行的检查
This line is waaaaaaaaaay too long # yamllint disable-line
或对整个块的检查
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable
可以使用.gitignore风格的模式忽略特定文件(完全或仅针对某些规则)
# For all rules
ignore: |
*.dont-lint-me.yaml
/bin/
!/bin/*.lint-me-anyway.yaml
rules:
key-duplicates:
ignore: |
generated
*.template.yaml
trailing-spaces:
ignore: |
*.ignore-trailing-spaces.yaml
/ascii-art/*
许可证
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。
源分布
yamllint-1.35.1.tar.gz (134.6 kB 查看哈希值)
构建分布
yamllint-1.35.1-py3-none-any.whl (66.7 kB 查看哈希值)
关闭
yamllint-1.35.1.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7a003809f88324fd2c877734f2d575ee7881dd9043360657cc8049c809eba6cd |
|
MD5 | 17d33f3ac5b2808fb299d27291977364 |
|
BLAKE2b-256 | da06d8cee5c3dfd550cc0a466ead8b321138198485d1034130ac1393cc49d63e |
关闭
yamllint-1.35.1-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 2e16e504bb129ff515b37823b472750b36b6de07963bd74b307341ef5ad8bdc3 |
|
MD5 | a3f5c2c6902e01be0afe8f86f0c9121b |
|
BLAKE2b-256 | 09282abf1ec14df2d584b9e7ce3b0be458838741e6aaff7a540374ba9af83916 |