일부 파이프라인에서 또는 프로젝트 빌드 시 일부 파일이 YAML 파일처럼 올바르게 빌드되는지 확인하려고 합니다!

여기 YamlLint가 있습니다!

당신은 그들의 website 당신이 그것을 사용하는 데 필요한 모든 것을 찾을 수 있지만, 여기 간략히 살펴보겠습니다!

한눈에

설정

프로젝트/기계에 따라 다음을 수행할 수 있습니다.

Linux를 사용하는 경우 컴퓨터에 직접 설치합니다.

sudo apt-get install yamllint

추출과 함께 설치

brew install yamllint

Python 프로젝트에 추가합니다.

python setup.py sdist
pip install --user dist/yamllint-*.tar.gz

그런 다음 기본 구성으로 직접 사용하거나 구성으로 재정의할 수 있습니다.

구성 재정의

이렇게 하려면 프로젝트의 최상위 수준에서 .yamllint 파일을 만듭니다. 그런 다음 이 파일에서 규칙을 활성화/비활성화하거나 규칙을 재정의할 수 있습니다...

예시

---

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

문서 링크

YamlLint config

Rules

운영

그런 다음 yaml lint를 실행하여 테스트할 수 있습니다!

일부 파일을 확인하고 싶을 때

yamllint file.yml other-file.yaml

폴더에 있는 모든 파일을 확인하고 싶을 때

yamllint .

대안

Maven 프로젝트로 작업하는 경우 빌드 중에 확인하고 싶을 수 있습니다! 이 경우 다음 라이브러리를 사용할 수 있습니다.

스보두인 / 얌린트

Java로 작성된 YAML Linter

YAML 린트

Java로 작성된 YAML 린트
주요 목적은 YAML 문서를 분석하기 위한 API 및 스크립트를 제공하는 것입니다.
YAML 문서는 규칙뿐만 아니라 구문적으로도 검사됩니다. 규칙 목록을 얻으려면 클래스를 참조하십시오.
com.github.sbaudoin.yamllint.rules 패키지의. 의 사이에
다른 하나는 시작 및 끝 YAML 문서 마커의 존재 여부, 올바르고 일관된 들여쓰기 등을 확인하는 규칙이 있습니다.

API 사용

메이븐 종속성:

<dependency>
    <groupId>com.github.sbaudoin</groupId>
    <artifactId>yamllint</artifactId>
    <version>1.5.0</version>
</dependency>

사용 방법은 JavaDoc을 참조하십시오.
가장 관심을 가질 클래스는 com.github.sbaudoin.yamllint.Linter입니다. 여기에는 정적 메서드가 포함되어 있습니다.
YAML 문자열 또는 파일을 분석하는 데 사용할 수 있습니다.
정보, 경고 및 오류의 3가지 오류 수준이 정의되었습니다.
linter는 파일당 하나의 구문 오류만 반환할 수 있습니다(구문 오류가 충족되면 나머지에서 많은 것을 기대할 수 없음)
의…

View on GitHub

연결

YAML 린트: https://yamllint.readthedocs.io/en/stable/

GitHub 자바 YamlLint: https://github.com/sbaudoin/yamllint

그것이 당신을 도울 수 있기를 바랍니다!

주저하지 말고 이 게시물에 대한 피드백을 제공하여 내 작문 실력을 향상시키십시오. 감사!