https://github.com/ajm188/tattle

A static code analyzer for ruby
https://github.com/ajm188/tattle

Last synced: 4 days ago
JSON representation

A static code analyzer for ruby

• Host: GitHub
• URL: https://github.com/ajm188/tattle
• Owner: ajm188
• License: mit
• Created: 2015-03-03T00:22:36.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-10T19:30:45.000Z (almost 10 years ago)
• Last Synced: 2023-05-14T14:35:15.417Z (over 1 year ago)
• Language: Ruby
• Homepage:
• Size: 188 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Tattle

Tattle aims to be a static code analyzer for Ruby. Use it to inspect your code and find bugs that you may have overlooked.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'tattle'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install tattle

## Usage

Using Tattle is as simple as:

    $ tattle my_file.rb

## State of the Project

This project is still in its very early stages. It currently only handles straight-line code,

conditionals and module, class and method definitions. I am working to add more functionality as quickly as possible.

If you encounter a bug with tattle, first consult [KNOWN_ISSUES](KNOWN_ISSUES). If it's in there, I am aware of it and I'm

working on it (probably right now). If it's not there, check the open issues on the repo, and create a new one if no

issue exists for your bug.

## 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. 

## Contributing

1. Fork it ( https://github.com/ajm188/tattle/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