0.0
No commit activity in last 3 years
No release in over 3 years
Dead simple .yml/.yaml checker.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.11
~> 10.0
~> 3.0
 Project Readme

YamlChecker

Dead simple .yml/.yaml checker.

Installation

Add this line to your application's Gemfile:

gem "yaml_checker"

And then execute:

$ bundle

Or install it yourself as:

$ gem install yaml_checker

Usage

usage: yaml_checker <file(.yml/.yaml) or directory path>

e.g.

$ yaml_checker path/to/directory
$ yaml_checker path/to/directory/foo.yml
$ yaml_checker path/to/directory/bar.yaml

if includes invalid YAML files then output all invalid files as below.

$ yaml_checker examples/
(/path/to/examples/dir1/dir2/invalid.yml): did not find expected key while parsing a block mapping at line 1 column 3
(/path/to/examples/dir1/invalid.yml): did not find expected key while parsing a block mapping at line 1 column 3
(/path/to/examples/invalid.yml): did not find expected key while parsing a block mapping at line 1 column 3
(/path/to/examples/dir1/dir2/invalid.yaml): did not find expected key while parsing a block mapping at line 1 column 3
(/path/to/examples/dir1/invalid.yaml): did not find expected key while parsing a block mapping at line 1 column 3
(/path/to/examples/invalid.yaml): did not find expected key while parsing a block mapping at line 1 column 3

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec yaml_checker to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yaml_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.