Skip to content

Commit

Permalink
Add some documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
  • Loading branch information
Morriar committed Mar 1, 2024
1 parent 42f0715 commit 51dfeaa
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -359,6 +359,22 @@ require "spoom/backtrace_filter/minitest"
Minitest.backtrace_filter = Spoom::BacktraceFilter::Minitest.new
```

### Dead code removal

Run dead code detection in your project with:

```
$ spoom deadcode
```

This will list all the methods and constants that do not appear to be used in your project.

You can remove them with Spoom:

```
$ spoom deadcode remove path/to/file.rb:42:18-47:23
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Don't forget to run `bin/sanity` before pushing your changes.
Expand Down

0 comments on commit 51dfeaa

Please sign in to comment.