pronto-yamllint 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -8
  3. data/lib/pronto/yamllint_runner.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3b28534e56b775e4c791fce9de8bb4e7f0dcaf53
4
- data.tar.gz: 756fc9ed34ffa05056089d2e7cf968a64c1a93ce
3
+ metadata.gz: 60b2f1c05a578d672c81802b7be3523b43dcb878
4
+ data.tar.gz: 4e08d68d552233ff12b56e259e992c7705345f89
5
5
  SHA512:
6
- metadata.gz: 937c110f5797d33fa3bcdea50008cb66e7ad022bc0c2aa8ab479d98ac71dcd362defec7557b344102743d44997314dcd88396d6df6d8d4231cd4e778a53ca6e3
7
- data.tar.gz: ff0c9159ebfe191c09b4d99acc5fb60248aaba9adef2cc6337595a85d8846e073fd4ec1f97e2345e5b6a53d773ed0a07ff56f0849f62f820b5ac5c7a1a0ba9b6
6
+ metadata.gz: 10c3d3cb08c5defc121d53696eed085ecca65a4d78849ff06f916ea366f1bd38fdabe4f0f83586605463a6d2a8ef26fafeff13f6388a4ee43e1fca65e5d0965e
7
+ data.tar.gz: 1760cb714c1aeb216ce27141e5da918ffb67227c947e6f521397a098ef646b09a52fac443d0acf93ef4c3244f21ec4394394efc16cf399b6d71459faa5cb4d21
data/README.md CHANGED
@@ -1,17 +1,32 @@
1
- # Pronto runner for ShellCheck
1
+ # Pronto runner for YAMLlint
2
2
 
3
- [![Code Climate](https://codeclimate.com/github/pclalv/pronto-shellcheck.svg)](https://codeclimate.com/github/pclalv/pronto-shellcheck)
4
- [![Build Status](https://travis-ci.org/pclalv/pronto-shellcheck.svg?branch=master)](https://travis-ci.org/pclalv/pronto-shellcheck)
3
+ [![Gem Version](https://badge.fury.io/rb/pronto-yamllint.svg)](https://badge.fury.io/rb/pronto-yamllint)
5
4
 
6
-
7
- Pronto runner for [ShellCheck](https://www.shellcheck.net). [What is Pronto?](https://github.com/mmozuras/pronto)
5
+ Pronto runner for [YAMLlint](https://yamllint.readthedocs.io). [What is Pronto?](https://github.com/prontolabs/pronto)
8
6
 
9
7
  ## Prerequisites
10
8
 
11
- You'll need to install [shellcheck by yourself](https://github.com/koalaman/shellcheck#installing). If `shellcheck` is in your `PATH`, everything will simply work.
9
+ * [install](https://yamllint.readthedocs.io/en/latest/quickstart.html#installing-yamllint) YAMLlint
10
+ * Ensure it is your `$PATH`
11
+
12
+ ## Installation
13
+
14
+ Run `gem install pronto-yamllint`
12
15
 
13
16
  ## Configuration
14
17
 
15
- Pass any options you would pass to `shellcheck` with the [`SHELLCHECK_OPTS` environment variable](shellcheck_opts) to `pronto run`; e.g., `SHELLCHECK_OPTS='-x' pronto run`.
18
+ (If needed) set `YAMLLINT_OPTS` environment variable with yamllint [options](https://yamllint.readthedocs.io/en/latest/configuration.html). They will be passed to yamllint.
19
+
20
+ ## Usage
21
+
22
+ Run `pronto`. Also it is quite nice to set git pre-push hook for pronto like in `.git/hooks/pre-push`:
23
+
24
+ ```
25
+ #!/bin/sh
26
+
27
+ pronto run --exit-code
28
+ ```
29
+
30
+ ## Changelog
16
31
 
17
- [shellcheck_opts]: [https://github.com/koalaman/shellcheck/wiki/Integration#allow-passing-through-or-configuring-the-environment-variable-shellcheck_opts]
32
+ 0.1.0 Initial public version. Based heavily on https://kevinjalbert.com/create-your-own-pronto-runner/
data/lib/pronto/yamllint_runner.rb CHANGED
@@ -3,7 +3,7 @@ require 'shellwords'
3
3
 
4
4
  module Pronto
5
5
  # runner for yamllint
6
- class YAMLLintRunner < Runner
6
+ class YAMLLint < Runner
7
7
  def yamllint_opts
8
8
  ENV['YAMLLINT_OPTS']
9
9
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pronto-yamllint
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Paulius Mazeika
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
55
55
  requirements:
56
56
  - yamllint (in PATH)
57
57
  rubyforge_project:
58
- rubygems_version: 2.6.13
58
+ rubygems_version: 2.6.14
59
59
  signing_key:
60
60
  specification_version: 4
61
61
  summary: Pronto runner for yamllint