/linter-yaml

YAML Linter for Atom

Primary LanguageJavaScriptMIT LicenseMIT

Linter-YAML-Linting

Linter-YAML-Linting aims to provide functional and robust YAML linting functionality within Atom.

Installation

The Linter Atom package is required and the yamllint executable.

Usage

  • This linter must be used on YAML files.
  • To quickly and easily access issues in other files, you will need to change the settings inside Linter-UI-Default. For Panel Represents and/or Statusbar Represents, you will need to change their options to Entire Project. This will allow you to use either display to quickly access issues in other files by clicking on the displayed information.

Example .yamllint configuration file

You can place the following example configuration file in your Atom project folder.

---

yaml-files:
  - '*.yaml'
  - '*.yml'
  - '.yamllint'

rules:
  braces: enable
  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