Project

lint_trap

0.0
No commit activity in last 3 years
No release in over 3 years
Parses the output of various linters.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

LintTrap

Circle CI

Detects languages of files, determines appropriate linters, and runs then. Created for LintCI.

Installation

Add this line to your application's Gemfile:

gem 'lint_trap'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lint_trap

Usage

Language Detection

require 'lint_trap'

language = LintTrap::Language.detect('bad.rb')
language.name #=> 'Ruby'
language.linters #=> [<Rubocop>]

Linting

require 'lint_trap'

container = LintTrap::Container::Docker.new('lintci/lint_trap')
linter = LintTrap::Linter.find('RuboCop')

linter.run(['bad.rb'], container, {}) do |violation|
  violation #=> {
            #     file: 'bad.rb',
            #     line: '2',
            #     column: '7',
            #     length: '4',
            #     rule: 'Style/MethodName',
            #     severity: 'convention',
            #     message: 'Use snake_case for methods.'
            #   }
end

Contributing

  1. Fork it ( https://github.com/[my-github-username]/lint_trap/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