Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skippypeanutbutter/yaml_bot
Validate the content of a yaml file according to a set of rules
https://github.com/skippypeanutbutter/yaml_bot
rspec ruby ruby-gem yaml
Last synced: 28 days ago
JSON representation
Validate the content of a yaml file according to a set of rules
- Host: GitHub
- URL: https://github.com/skippypeanutbutter/yaml_bot
- Owner: skippyPeanutButter
- License: mit
- Created: 2016-09-16T01:15:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-01T21:58:12.000Z (over 6 years ago)
- Last Synced: 2024-09-17T02:22:30.512Z (about 2 months ago)
- Topics: rspec, ruby, ruby-gem, yaml
- Language: Ruby
- Homepage:
- Size: 93.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/skippyPeanutButter/yaml_bot)
[](https://codeclimate.com/github/skippyPeanutButter/yaml_bot)
[](https://codeclimate.com/github/skippyPeanutButter/yaml_bot/coverage)
# YamlBot
YamlBot is not a Yaml linter, it is a Yaml format validator.
### Why
Mistakes can often be made when working with yaml-based configuration. Systems
such as travis-ci, rubocop, and other tools that utilize yaml files to govern
how they work often present users with a multitude of keys and options that can
take on many possible values. `yamlbot` allows users to feed it a set of rules
that a yaml-based system follows and then validate any yaml file against those
rules.
If a tool works off of a yaml-based configuration then a rules file can be
crafted for validating the configuration is correct. Create a rules file, share
it with others, and have them use `yamlbot` to validate their configuration
against the specified rules.
See the [RULES FILE](RULES_DEFINITION.md) specification for details on creating
a `.yamlbot.yml` rules file.
### Installation
Add this line to your application's Gemfile:
```ruby
gem 'yaml_bot'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install yaml_bot
### Usage
Create a `.yamlbot.yml` file with a set of rules that you want to validate yaml
files against [yamlbot file specification](RULES_DEFINITION.md).
Usage assuming the existence `.yamlbot.yml` in the current directory:
```bash
yamlbot -f yaml_file_to_validate
```
Usage passing the path to a rules file
(doesn't have to be named `.yamlbot.yml`):
```bash
yamlbot -f yaml_file_to_validate [-r path_to_rules_file]
```
```bash
Usage: yamlbot -f yaml_file_to_validate [-r path_to_rules_file]
-r, --rule-file rules The rules you will be evaluating your yaml against
-f, --file file The file to validate against
-h, --help help
```
### 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.
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](https://rubygems.org).
### Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/skippyPeanutButter/yaml_bot. This project is intended to be a
safe, welcoming space for collaboration, and contributors are expected to adhere
to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
### License
The gem is available as open source under the terms of the [MIT
License](http://opensource.org/licenses/MIT).