rubocop-junit_formatter 0.1 → 0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -1
  3. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4576a49e7879e14885f77226dcc298974fc1a31456c02c5836430c6fdb66f21a
4
- data.tar.gz: 8dc8d5f746439b6caab9df72f38303c8a30933dc03400dd9e8da832cece3ed88
3
+ metadata.gz: 4e7db949545828cf4f0c5cc6d5f43d8cce1f4b9fe552560ee7b7fa385a9bf24a
4
+ data.tar.gz: daa487dd40a457ce7b43f3be7509112c7ec2bd529bd16578bfea24b236c6b7a1
5
5
  SHA512:
6
- metadata.gz: d2a83f7905f351449d5b5e2bf69dc13a49f926f597da59df4fd00221db970880aef34e541f670191a8bccdfb904a147818f41152e26a8d84fe2f41cb0d13471e
7
- data.tar.gz: 1a1a5e9cc7c4e19ce470dc4f91d3fcefdc33f367f78077666d3c33cec8fdcf648a3dcdc7af239078b6a1ab881ab62f5e57ceca338939c61c59b68b4198dc3390
6
+ metadata.gz: 778b4f388626f9726d74707b59c91c7243aa72f40ce943e8332c440213794bcc6aeabc79c54a99d6a2c3d3263f63289d72e5d3ca392d6a77aa3fc88e70c81c61
7
+ data.tar.gz: 49cfe475567203dff05113c590fce7dc369b33716ed3f9129f12755256db32bb54dad255f689809468347b0757f3020b83cb141fcef30d7b01d6a81adb9d9456
data/README.md CHANGED
@@ -1,2 +1,28 @@
1
1
  # rubocop-junit_formatter
2
- A JUnit Formatter for RuboCop
2
+ A JUnit Formatter for RuboCop. Usable with continuous integration services (eg. CircleCI) and IDEs.
3
+
4
+ ## Usage
5
+ You *must* require the formatter file through the RuboCop CLI.
6
+
7
+ ```bash
8
+ $ rubocop --require rubocop/formatter/junit_formatter --format RuboCop::Formatter::JUnitFormatter
9
+ ```
10
+
11
+ To output the results to a file, use the `-o`/`--out` option:
12
+ ```bash
13
+ $ rubocop --require rubocop/formatter/junit_formatter \
14
+ --format RuboCop::Formatter::JUnitFormatter \
15
+ --out /tmp/test-results/rubocop.xml
16
+ ```
17
+
18
+ You can even have use multiple formatters (see RuboCop manual). This is good for CIs where you want to stdout to be a more human readable formatter and output the JUnit XML to a file.
19
+
20
+ ## Installation
21
+
22
+ Add this line to your application's Gemfile:
23
+
24
+ ```ruby
25
+ gem 'rubocop-junit_formatter"
26
+ ```
27
+
28
+ You'll probably only need to scope it to the `test` group.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubocop-junit_formatter
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.1'
4
+ version: '0.2'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ngan Pham
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.9'
19
+ version: '0.49'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0.9'
26
+ version: '0.49'
27
27
  description:
28
28
  email:
29
29
  - nganpham@gmail.com