1
0
Fork 0
Schema analysis, linting, and transformation for YAML
Go to file
ssube 5e05c72b7e feat: add modes, basic readme 2019-06-15 18:07:46 -05:00
config feat: make node selectors work 2019-06-15 17:53:07 -05:00
docs feat: working bundle, example config 2019-06-15 16:17:26 -05:00
rules feat: make node selectors work 2019-06-15 17:53:07 -05:00
src feat: add modes, basic readme 2019-06-15 18:07:46 -05:00
vendor/jsonpath-plus feat: make node selectors work 2019-06-15 17:53:07 -05:00
.gitignore feat: project, build, and bundle 2019-06-15 15:20:04 -05:00
.npmignore feat: project, build, and bundle 2019-06-15 15:20:04 -05:00
LICENSE.md feat: add modes, basic readme 2019-06-15 18:07:46 -05:00
Makefile feat: project, build, and bundle 2019-06-15 15:20:04 -05:00
README.md feat: add modes, basic readme 2019-06-15 18:07:46 -05:00
package.json feat: make node selectors work 2019-06-15 17:53:07 -05:00
tsconfig.json feat: project, build, and bundle 2019-06-15 15:20:04 -05:00
yarn.lock feat: make node selectors work 2019-06-15 17:53:07 -05:00

README.md

SALTY DOG

Schema analysis, linting, and transformation for YAML with defaults, optional fields, and other good stuff.

Build

> git clone
> make bundle

Usage

> cat rules/examples/kubernetes-require-resources-pass.yml |\
    node out/bundle.js \
      --rules rules/kubernetes.yml \
      --source - \
      --tag important

Options

Excludes take priority over includes: a rule matching some of both will be excluded.

Exclude Level

Exclude rules by log level.

Exclude Name

Exclude rules by name.

Exclude Tag

Exclude rules by tag.

Include Level

Include rules by log level.

Include Name

Include rules by name.

Include Tag

  • Alias: t, tag

Include rules by tag.

Mode

  • Alias: m
  • Default: check

The application mode.

Options:

  • check runs each rule and exits with an indicative status
  • clean runs each rule and updates the source data with any defaults or other changes before running the next rule

Rules

The path to a file containing some rules.

Source

  • Alias: s
  • Default: -

The source file to validate.

Defaults to stdin (-) to work with pipes: cat file.yml | salty --source -