https://github.com/urcomputeringpal/yamburger

YAML syntax got you down? That's a YAMBURGER!
https://github.com/urcomputeringpal/yamburger

ansible github-app hiera home-assistant home-assistant-config home-assistant-configuration kubernetes lint linter probot-app yaml yaml-configuration

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/urcomputeringpal/yamburger
• Owner: urcomputeringpal
• License: mit
• Created: 2018-06-01T15:31:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T19:24:42.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T16:25:42.351Z (almost 2 years ago)
• Topics: ansible, github-app, hiera, home-assistant, home-assistant-config, home-assistant-configuration, kubernetes, lint, linter, probot-app, yaml, yaml-configuration
• Language: JavaScript
• Homepage: https://github.com/apps/yamburger
• Size: 313 KB
• Stars: 32
• Watchers: 3
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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:

![](https://urcomputeringpal.com/assets/yamburger.gif)

## Getting started

The authors of YAMBURGER maintain a hosted version of the source code you see here. [Install it today!](https://github.com/apps/yamburger)

## 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:

```yaml

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](https://home-assistant.io)'s [custom YAML tags](https://www.home-assistant.io/docs/configuration/yaml/#using-environment-variables) is available [here](https://github.com/jnewland/ha-config/blob/master/.github/yamburger.yaml).

## Questions?

Please [file an issue](https://github.com/urcomputeringpal/yamburger/issues/new/choose)! If you'd prefer to reach out in private, please send an email to [email protected].

## Hacking

### Testing

    npm run test