{"id":17310444,"url":"https://github.com/shortdudey123/yamllint","last_synced_at":"2025-08-22T00:32:02.254Z","repository":{"id":25508214,"uuid":"28939718","full_name":"shortdudey123/yamllint","owner":"shortdudey123","description":"Checks YAML files for correct syntax","archived":false,"fork":false,"pushed_at":"2022-06-01T22:58:12.000Z","size":87,"stargazers_count":20,"open_issues_count":4,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-11T05:03:46.483Z","etag":null,"topics":["cli","linter","linting","ruby","yaml","yamllint"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shortdudey123.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-07T23:47:56.000Z","updated_at":"2023-10-20T09:48:26.000Z","dependencies_parsed_at":"2022-09-07T20:20:32.506Z","dependency_job_id":null,"html_url":"https://github.com/shortdudey123/yamllint","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortdudey123%2Fyamllint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortdudey123%2Fyamllint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortdudey123%2Fyamllint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shortdudey123%2Fyamllint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shortdudey123","download_url":"https://codeload.github.com/shortdudey123/yamllint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230542288,"owners_count":18242332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","linter","linting","ruby","yaml","yamllint"],"created_at":"2024-10-15T12:37:10.040Z","updated_at":"2024-12-20T06:07:04.287Z","avatar_url":"https://github.com/shortdudey123.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YamlLint\n\n[![Gitter chat](https://badges.gitter.im/shortdudey123/yamllint.svg)](https://gitter.im/shortdudey123/yamllint)\n[![Build Status](https://travis-ci.org/shortdudey123/yamllint.svg?branch=master)](https://travis-ci.org/shortdudey123/yamllint)\n[![Gem Version](http://img.shields.io/gem/v/yamllint.svg)](https://rubygems.org/gems/yamllint)\n[![Coverage Status](https://img.shields.io/coveralls/shortdudey123/yamllint/master.svg)](https://coveralls.io/r/shortdudey123/yamllint?branch=master)\n[![Code Climate](https://codeclimate.com/github/shortdudey123/yamllint/badges/gpa.svg)](https://codeclimate.com/github/shortdudey123/yamllint)\n[![Dependency Status](https://img.shields.io/gemnasium/shortdudey123/yamllint.svg)](https://gemnasium.com/shortdudey123/yamllint)\n\nChecks YAML files for correct syntax.  Currently it checks for:\n\n * Valid YAML syntax\n * Overlapping key definitions in YAML files, where the last definition would win\n\nThis is a YAML version of [jsonlint](https://github.com/dougbarth/jsonlint)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'yamllint'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install yamllint\n\n## Usage\n\n### CLI\n\nYou 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.\n\n```\n$ yamllint spec/data/*\nspec/data/invalid.yaml\n  (\u003cunknown\u003e): found character that cannot start any token while scanning for the next token at line 1 column 6\nspec/data/overlapping_keys.yaml\n  The same key is defined more than once: foo\nspec/data/overlapping_keys_complex.yaml\n  The same key is defined more than once: foo\nspec/data/overlapping_keys_deep.yaml\n  The same key is defined more than once: foo\nspec/data/spaces.yaml\n  The YAML should not just be spaces\n$\n```\n\n#### CLI options\n\n| Short | Long | Description | Default |\n| ------------- | ------------- | ------------- | ------------- |\n| `-D` | `--debug` | Debug logging | `false` |\n| `-d` | `--disable-ext-check` | Disable file extension check | `false` |\n| `-e` | `--extensions=` | Add more allowed extensions (comma delimited list) | `nil` |\n| `-h` | `--help` | Show help message | `false` |\n| `-v` | `--version` | Print version and exit | `false` |\n\n### Rake task\n\nYou can integrate yamllint into your build process by adding a Rake task to your project\n\n```ruby\nrequire 'yamllint/rake_task'\nYamlLint::RakeTask.new do |t|\n  t.paths = %w(\n    spec/**/*.yaml\n  )\nend\n```\n\nThen run the rake task.\n\n```\n$ rake yamllint\nspec/data/invalid.yaml\n  (\u003cunknown\u003e): found character that cannot start any token while scanning for the next token at line 1 column 6\nspec/data/overlapping_keys.yaml\n  The same key is defined more than once: foo\nspec/data/overlapping_keys_complex.yaml\n  The same key is defined more than once: foo\nspec/data/overlapping_keys_deep.yaml\n  The same key is defined more than once: foo\nspec/data/spaces.yaml\n  The YAML should not just be spaces\n$\n```\n\n#### Rake task options\n\nAdd these options similarly to the path option seen above.\n\n| Option | Description | Default |\n| ------------- | ------------- | ------------- |\n| `debug` | Debug logging | `false` |\n| `disable_ext_check` | Disable file extension check | `false` |\n| `exclude_paths` | List of files or paths to exclude from linting | `nil` |\n| `extensions` | Add more allowed extensions (list) | `nil` |\n| `fail_on_error` | Continue on to the next rake task and don't fail even if YamlLint finds errors | `true` |\n| `paths` | List of files or paths to lint | `nil` |\n\n## Contributing\n\n1. Fork it ( https://github.com/shortdudey123/yamllint/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshortdudey123%2Fyamllint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshortdudey123%2Fyamllint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshortdudey123%2Fyamllint/lists"}