Мощные инструменты (19 части серии)
В некоторых трубопроводах или когда проект построен, мы хотим проверить, правильно ли будут строить некоторые файлы, например, наши файлы YAML!
Так вот Yamllint Действительно
Вы можете найти на своих Сайт Все, что вам нужно будет использовать, но вот быстрый взгляд!
Настраивать
В зависимости от вашего проекта/машины вы можете:
- Установите его прямо на вашу машину, если вы находитесь на Linux
sudo apt-get install yamllint
- Установите его с помощью заваривать
brew install yamllint
- Добавьте его в свой проект Python
python setup.py sdist pip install --user dist/yamllint-*.tar.gz
Затем вы можете использовать его непосредственно с помощью конфигуров по умолчанию или переопределить его своими конфигами.
Переопределенные конфиги
Чтобы сделать это, создайте .имиллинт Файл на верхнем уровне вашего проекта. Затем в этом файле вы можете включить/отключить правила или правила переопределения …
пример
---
yaml-files:
- '*.yaml'
- '*.yml'
- '.yamllint'
rules:
braces:
level: warning
max-spaces-inside: 1
brackets: enable
colons: enable
commas: enable
comments:
level: warning
comments-indentation:
level: warning
document-end: disable
document-start:
level: warning
empty-lines: enable
empty-values: disable
hyphens: enable
indentation: enable
key-duplicates: enable
key-ordering: disable
line-length: enable
new-line-at-end-of-file: enable
new-lines: enable
octal-values: disable
quoted-strings: disable
trailing-spaces: enable
truthy:
level: warning
Ссылки документации
Запустить
Затем вы можете запустить yaml Lint, чтобы проверить его!
Когда вы хотите проверить некоторые файлы
yamllint file.yml other-file.yaml
Когда вы хотите проверить все файлы в папке
yamllint .
Если вы работаете с проектом Maven, возможно, вы хотите проверить его во время вашей сборки! В этом случае вы можете использовать эту библиотеку:
Sbaudoin/yamllint.
Ямл Линтер написан в Java
YAML LINT, написанный в Java, его главная цель — предоставить API и сценарии для анализа документов YAML, документы YAML синтаксически проверяются, а также против правил. Чтобы получить список правил, пожалуйста, обратитесь к классам com.github.sbaudoin.yamllint.rules упаковка. Помимо прочего, у нас есть правило, чтобы проверить наличие начальной и конец документа YAML, правильный и постоянный отступ и т. Д.
Использование API
Зависимость Maven:
com.github.sbaudoin yamllint 1.4.0
Для использования, пожалуйста, обратитесь к Javadoc Отказ
Класс, который в основном интересует вас com.gitub.sbaudoin.yamllint. Линтер : Он содержит статические методы, которые можно использовать для анализа строки YAML или файла.
Были определены 3 уровня ошибок: информация, предупреждение и ошибка.
Линтер может вернуть только одну ошибку синтаксиса на файл (после того, как ошибка синтаксиса была выполнена, мы не можем ожидать многого от остальных …
- YAML LINT: https://yamllint.readtheDocs.io/en/stable/
- Github Java yamllint: https://github.com/sbaudoin/yamllint.
Я надеюсь, что это поможет вам!
Пожалуйста, не стесняйтесь дать мне обратную связь об этом посте, чтобы улучшить свои навыки письма. Спасибо!
Мощные инструменты (19 части серии)
Оригинал: «https://dev.to/adaendra/yaml-validations-5941»