Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/packsaddle/ruby-checkstyle_filter-git
https://github.com/packsaddle/ruby-checkstyle_filter-git
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/packsaddle/ruby-checkstyle_filter-git
- Owner: packsaddle
- License: mit
- Created: 2015-02-14T13:04:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-03-05T11:31:26.000Z (almost 3 years ago)
- Last Synced: 2024-08-09T05:53:22.267Z (5 months ago)
- Language: Ruby
- Homepage: http://packsaddle.org
- Size: 71.3 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CheckstyleFilter::Git
[](http://badge.fury.io/rb/checkstyle_filter-git)
[](https://circleci.com/gh/packsaddle/ruby-checkstyle_filter-git)
## What is this?
1. checkstyle format errors
```xml
```
2. git diff
```diff
diff --git a/example/invalid.rb b/example/invalid.rb
new file mode 100644
index 0000000..b13da3a
--- /dev/null
+++ b/example/invalid.rb
@@ -0,0 +1,5 @@
+class Invalid
+ def foo
+ 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+ end
+end
diff --git a/lib/checkstyle_filter/git/cli.rb b/lib/checkstyle_filter/git/cli.rb
index 6d503a3..e45bdef 100644
--- a/lib/checkstyle_filter/git/cli.rb
+++ b/lib/checkstyle_filter/git/cli.rb
@@ -61,10 +61,12 @@ def file_element_file_in_git_diff?(file_name, parsed_git_diff)
.include?(Pathname.new(file_name).expand_path)
end
- def file_element_error_line_no_in_modified?(file_name, parsed_git_diff, line)
+ def file_element_error_line_no_in_modified?(file_name, parsed_git_diff, line_no)
require 'pathname'
diff_pairs = parsed_git_diff
- .select { |diff| Pathname.new(diff[:file_name]).expand_path == Pathname.new(file_name).expand_path }
+ .select do |diff|
+ Pathname.new(diff[:file_name]).expand_path == Pathname.new(file_name).expand_path
+ end
return false if diff_pairs.empty?
modified_lines = Set.new
diff_pairs.map do |diff_pair|
@@ -72,7 +74,7 @@ def file_element_error_line_no_in_modified?(file_name, parsed_git_diff, line)
modified_lines << line.number
end
end
- modified_lines.include?(line)
+ modified_lines.include?(line_no)
end
end
end
```
3. filter! output **only errors** on modified lines
```
$ cat checkstyle.xml | checkstyle_filter-git diff HEAD~1..origin/master
```
```xml
```
## Expected usage
```
git diff -z --name-only origin/master.. \
| xargs -0 rubocop-select \
| xargs rubocop \
--require rubocop/formatter/checkstyle_formatter \
--format RuboCop::Formatter::CheckstyleFormatter \
| checkstyle_filter-git diff origin/master.. \
| saddler report \
--require saddler/reporter/github \
--reporter Saddler::Reporter::Github::PullRequestReviewComment
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'checkstyle_filter-git'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install checkstyle_filter-git
## Help
```
$ checkstyle_filter-git
Commands:
checkstyle_filter-git diff # Filter using `git diff`
checkstyle_filter-git exec # Exec command `"git diff --no-color origin/master | iconv -f EUCJP -t UTF8"`
checkstyle_filter-git help [COMMAND] # Describe available commands or one specific command
checkstyle_filter-git version # Show the CheckstyleFilter/Git version
$ checkstyle_filter-git help diff
Usage:
checkstyle_filter-git diff
Options:
[--data=DATA]
[--file=FILE]
Filter using `git diff`
$ checkstyle_filter-git help exec
Usage:
checkstyle_filter-git exec
Exec command `"git diff --no-color origin/master | iconv -f EUCJP -t UTF8"`
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec checkstyle_filter-git` to use the code located in this directory, ignoring other installed copies of this gem.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
1. Fork it ( https://github.com/packsaddle/ruby-checkstyle_filter-git/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request