https://github.com/shortdudey123/yamllint

Checks YAML files for correct syntax
https://github.com/shortdudey123/yamllint

cli linter linting ruby yaml yamllint

Last synced: about 2 months ago
JSON representation

Checks YAML files for correct syntax

• Host: GitHub
• URL: https://github.com/shortdudey123/yamllint
• Owner: shortdudey123
• License: mit
• Created: 2015-01-07T23:47:56.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-06-01T22:58:12.000Z (over 2 years ago)
• Last Synced: 2024-12-11T05:03:46.483Z (about 2 months ago)
• Topics: cli, linter, linting, ruby, yaml, yamllint
• Language: Ruby
• Size: 85 KB
• Stars: 20
• Watchers: 2
• Forks: 16
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# YamlLint

[![Gitter chat](https://badges.gitter.im/shortdudey123/yamllint.svg)](https://gitter.im/shortdudey123/yamllint)

[![Build Status](https://travis-ci.org/shortdudey123/yamllint.svg?branch=master)](https://travis-ci.org/shortdudey123/yamllint)

[![Gem Version](http://img.shields.io/gem/v/yamllint.svg)](https://rubygems.org/gems/yamllint)

[![Coverage Status](https://img.shields.io/coveralls/shortdudey123/yamllint/master.svg)](https://coveralls.io/r/shortdudey123/yamllint?branch=master)

[![Code Climate](https://codeclimate.com/github/shortdudey123/yamllint/badges/gpa.svg)](https://codeclimate.com/github/shortdudey123/yamllint)

[![Dependency Status](https://img.shields.io/gemnasium/shortdudey123/yamllint.svg)](https://gemnasium.com/shortdudey123/yamllint)

Checks YAML files for correct syntax.  Currently it checks for:

 * Valid YAML syntax

 * Overlapping key definitions in YAML files, where the last definition would win

This is a YAML version of [jsonlint](https://github.com/dougbarth/jsonlint)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'yamllint'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install yamllint

## Usage

### CLI

You can run yamllint against a set of files in the command line. Any errors will be printed and the process will exit with a non-zero exit code.

```

$ yamllint spec/data/*

spec/data/invalid.yaml

  (): found character that cannot start any token while scanning for the next token at line 1 column 6

spec/data/overlapping_keys.yaml

  The same key is defined more than once: foo

spec/data/overlapping_keys_complex.yaml

  The same key is defined more than once: foo

spec/data/overlapping_keys_deep.yaml

  The same key is defined more than once: foo

spec/data/spaces.yaml

  The YAML should not just be spaces

$

```

#### CLI options

| Short | Long | Description | Default |

| ------------- | ------------- | ------------- | ------------- |

| `-D` | `--debug` | Debug logging | `false` |

| `-d` | `--disable-ext-check` | Disable file extension check | `false` |

| `-e` | `--extensions=` | Add more allowed extensions (comma delimited list) | `nil` |

| `-h` | `--help` | Show help message | `false` |

| `-v` | `--version` | Print version and exit | `false` |

### Rake task

You can integrate yamllint into your build process by adding a Rake task to your project

```ruby

require 'yamllint/rake_task'

YamlLint::RakeTask.new do |t|

  t.paths = %w(

    spec/**/*.yaml

  )

end

```

Then run the rake task.

```

$ rake yamllint

spec/data/invalid.yaml

  (): found character that cannot start any token while scanning for the next token at line 1 column 6

spec/data/overlapping_keys.yaml

  The same key is defined more than once: foo

spec/data/overlapping_keys_complex.yaml

  The same key is defined more than once: foo

spec/data/overlapping_keys_deep.yaml

  The same key is defined more than once: foo

spec/data/spaces.yaml

  The YAML should not just be spaces

$

```

#### Rake task options

Add these options similarly to the path option seen above.

| Option | Description | Default |

| ------------- | ------------- | ------------- |

| `debug` | Debug logging | `false` |

| `disable_ext_check` | Disable file extension check | `false` |

| `exclude_paths` | List of files or paths to exclude from linting | `nil` |

| `extensions` | Add more allowed extensions (list) | `nil` |

| `fail_on_error` | Continue on to the next rake task and don't fail even if YamlLint finds errors | `true` |

| `paths` | List of files or paths to lint | `nil` |

## Contributing

1. Fork it ( https://github.com/shortdudey123/yamllint/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request