ruby-lint is a linter and static code analysis tool for Ruby. It is inspired by similar tools such as jshint, flake8 and similar tools. ruby-lint primarily focuses on logic related errors such as the use of non existing variables instead of focusing on semantics (e.g. the amount of characters per line).
- a Ruby implementation running 1.9 or newer
- a Unix based Operating System
The following Ruby implementations/versions are officially supported:
- Ruby 1.9.3 or 2.0 and newer
- Rubinius head running in 1.9 mode
- Jruby head running in 1.9 mode
Ruby implementations running a 1.8 based version of Ruby are not supported.
The easiest way to install ruby-lint is to install it from RubyGems:
gem install ruby-lint
If you prefer to install (and build) ruby-lint from the source code you can do so as following:
git clone git://github.com/YorickPeterse/ruby-lint.git
cd ruby-lint
bundle install # you can also install the dependencies manually
rake build
This builds a new version of the Gem and saves it in the pkg/ directory.
To ensure that people can't tamper with the ruby-lint Gem once it's being
distributed as a .gem file the Gem is signed using GNUPG (using the
rubygems-openpgp Gem). If you have this Gem installed it's
recommended that you install ruby-lint as following:
gem install ruby-lint --verify --trust
Unless you have my GPG public key and have marked it as trusted this process will fail. For signing Gems I use the public key 3649F444 registered to "Yorick Peterse" using Email address yorickpeterse@gmail.com.
You can add this key by running the following command:
gpg --recv-keys 3649F444
In case you don't use GPG but still want some form of verification you can use
the checksums that are located in the "checksum" directory. These checksums are
SHA512 checksums of entire Gem files and can be verified using the sha512sum
command.
Using ruby-lint from the CLI is very easy. To analyze a set of files you run the following:
ruby-lint file1.rb file2.rb
For more information specify either the -h or --help option.
Given the following code:
class Person
def initialize(name)
# oops, not setting @name
end
def greet
return "Hello, #{@name}"
end
end
user = Person.new('Alice')
greeting = user.greet
user.greet(:foo)
Analysing this file using ruby-lint (with the default settings) would result in the following output:
test.rb: error: line 7, column 21: undefined instance variable @name
test.rb: warning: line 12, column 0: unused local variable greeting
test.rb: error: line 14, column 0: wrong number of arguments (expected 0 but got 1)
- {file:contributing Contributing}
- {file:architecture Architecture}
- {file:code_analysis Code Analysis}
- {file:configuration Configuration}
All source code in this repository is licensed under the MIT license unless specified otherwise. A copy of this license can be found in the file "LICENSE" in the root directory of this repository.