Metadata-Version: 2.1
Name: zuul-lint
Version: 0.1.1
Summary: Zuul Job Config Linter
Home-page: https://github.com/pycontribs/zuul-lint
Author: Sorin Sbarnea
Author-email: sorin.sbarnea@gmail.com
License: MIT
Project-URL: Source, https://github.com/pycontribs/zuul-lint
Project-URL: Tracker, https://github.com/tox-dev/pycontribs/zuul-lint
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: jsonschema
Requires-Dist: six
Requires-Dist: typing ; python_version < "3.5"

# zuul-lint

## Validate from the command line

```
pip install zuul-lint

zuul-lint .zuul.yaml
```

## Validate with pre-commit

Add the code below to your `.pre-commit-config.yaml` file:

```yaml
  - repo: https://github.com/pycontribs/zuul-lint.git
    rev: "0.1"
    hooks:
      - id: zuul-lint
```


## Validate with VS Code

To ease editing Zuul CI configuration file we added experimental support for
a Zuul JSON Schema. This should enable validation and auto-completion in
code editors.

For example on [VSCode](1) you can use the [YAML](2) extension to use such a schema
validation by adding the following to `settings.json`:


```json
"yaml.schemas": {
    "https://raw.githubusercontent.com/pycontribs/zuul-lint/master/zuul_lint/zuul-schema.json": ["*zuul.d/*.yaml", "*/.zuul.yaml"]
    },
"yaml.customTags": [
    "!encrypted/pkcs1-oaep array"
],
"sortJSON.orderOverride": ["title", "name", "$schema", "version", "description", "type"],
"sortJSON.orderUnderride": ["definitions"]

```

[1]: https://code.visualstudio.com/
[2]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml


