Skip to content

embargiel/jarvis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jarvis

Jarvis helps you find out problems with your code and offers to fix them for you. It currently does a couple of simple checks and fixes, but I'd like it to do everything, from dead code elimination and suboptimal code fixing to enforcing html/css code styling or looking for n+1 queries.

Installation

Add this line to your application's Gemfile:

gem 'jarvis', git: 'git@github.com:KillaPL/jarvis.git'

And then execute:

$ bundle

Usage

jarvis checkers

lists all available checkers

jarvis find NAME

looks through all valid files and looks for problems according to passed checker

jarvis seek_and_destroy NAME

looks through all valid files and fixes them according to passed checker NAME.

Adding strategies:

Simply add a file to jarvis/checker lib. It should be a class namespaced with Jarvis::Checker. Inside the strategy file you have access to @file variable, which is instance of Jarvis::File, which is a wrapper over actual file. Your strastegy must respond to 3 methods:

- #should_check? Should return true/false. Typically, if it returns true, problem_present? will be called. For example, if strategy only is valid for ruby files, it should check if @file.path contains '.rb' substring. Also, usually it might need to check if the file is nonempty.

- #problem_present? Should open the file and actually check if it violates the strategies purpose. For example, Jarvis::Checker::TrailingWhitespace looks line by line to determine if the file contains any trailing whitespace.

- #solve. Should solve the issue, assuming it is found. For example, Jarvis::Checker::TrailingWhitespace goes line by line and removes the trailing whitespace

Contributing

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages