Skip to content
YAML syntax got you down? That's a YAMBURGER!
Branch: master
Clone or download
Latest commit 5866045 Oct 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Jun 1, 2018
examples
lib
script hello world Jun 1, 2018
test
.gitignore hello world Jun 1, 2018
.travis.yml
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 1, 2018
CONTRIBUTING.md Create CONTRIBUTING.md Jun 1, 2018
LICENSE
README.md
index.js redirect to github Jun 1, 2018
package.json
yarn.lock

README.md

YAMBURGER

Overview

Indentation got you down? Semicolons in the wrong spot? That's a YAMBURGER!

YAMBURGER is a YAML-linting GitHub App. Install it on any repository that contains YAML, and it'll point out burgers on any Pull Requests that you open like so:

Getting started

The authors of YAMBURGER maintain a hosted version of the source code you see here. Install it today!

Configuration

YAMBURGER supports validating YAML containing custom tags (like !tag). To configure the custom tags that are valid for your repository, add a .github/yamburger.yaml file to your repository like so:

tags:
- name: tag1
  kind: scalar # strings / numbers
- name: tag2
  kind: sequence # arrays / lists
- name: tag3
  kind: mapping # hashes / dictionaries

An example configuration that adds support for Home Assistant's custom YAML tags is available here.

Questions?

Please file an issue! If you'd prefer to reach out in private, please send an email to pal@urcomputeringpal.com.

Hacking

Testing

npm run test
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.