joshuaclayton/unused
1
1
Fork 0
mirror of https://github.com/joshuaclayton/unused.git synced 2024-08-15 15:50:26 +03:00
Code Issues Projects Releases Wiki Activity

Discuss what it can be used on

Browse Source
This commit is contained in:
Joshua Clayton 2016-05-12 06:37:30 -04:00
parent b90cddf460
commit 731381a0f8
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,9 +1,29 @@
# Unused [![Build Status](https://travis-ci.org/joshuaclayton/unused.svg?branch=master)](https://travis-ci.org/joshuaclayton/unused)
A command line tool in Haskell to identify unused code.
A command line tool to identify unused code.
![Image of Unused Output](http://i.giphy.com/3oEjHGgyV2EDdy1Ogw.gif)
## "What kinds of projects can I used it on?"
Anything.
Yes, literally anything.
It's probably best if you have a ctags file you can pipe into it, but if you
have another way to pipe a bunch of methods/functions/classes/modules/whatever
in, that works too.
Right now, there are some special cases built in for Rails and Phoenix apps
(specifically, assumptions about what's fine to only have one reference to,
e.g. Controllers in Rails and Views in Phoenix), but it'll work on Rubygems,
Elixir packages, or anything else.
That said, be confident the code you're removing won't break your program.
Especially with projects built in Ruby, Elixir, or JavaScript, there are ways
to dynamically trigger or define behavior that may be surprising. A test suite
can help here, but still cannot determine every possible execution path.
## Installing
### Homebrew