urcomputeringpal / yamburger

YAML syntax got you down? That's a YAMBURGER!

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 [e-mail].

Hacking

Testing

npm run test