Carve out the essentials of your Clojure app.
Carve will search through your code for unused vars and will remove them.
Experimental. Use with caution! Breaking changes may happen. Feedback and bugfix PRs welcome.
Add to your deps.edn under the :aliases key:
:carve {:extra-deps {borkdude/carve {:git/url "https://github.com/borkdude/carve"
:sha "8e219572f55485244fdc35ac605d19bc74e9be0e"}}
:main-opts ["-m" "carve.main"]}or use any later SHA.
Carve invokes clj-kondo and uses the analysis information to check which vars are unused. To remove the relevant bits of code it uses rewrite-cljc.
The usage for a typical Clojure app looks like:
clojure -A:carve --opts '{:paths ["src" "test"]}'
Currently carve only has one command line option, --opts, which
expects an EDN map of the following options of which only :paths is required:
:paths: a list of paths to analyze. Can be a mix of individual files and directories.:ignore-vars: a list of vars to ignore. Useful for when the analyzer has it wrong or you just want to keep the var for whatever reason.:api-namespaces: a list of namespaces of which only unused private vars will be reported.:carve-ignore-file: a file where ignored vars can be stored,.carve_ignoreby default.:interactive?: ask what to do with an unused var: remove from the file, add to.carve_ignoreor continue. Set totrueby default.:out-dir: instead of writing back to the original file, write to this dir.:dry-run?: just print the unused var expression.:aggressive?: runs multiple times until no unused vars are left. Defaults tofalse.:report: when truthy, prints unused vars to stdout. Implies:dry-dun? true. The output format may be set using:report {:format ...}where format can be:ednor:text. The text output can be interpreted by editors like Emacs. This option can be combined with:aggressive?.
$ clojure -A:carve --opts '{:paths ["test-resources"] :dry-run? true}'
Carving test-resources/app.clj
Found unused var:
(defn unused-function [])
...
Carving test-resources/api.clj
Found unused var:
(defn- private-lib-function [])
...$ clojure -A:carve --opts '{:paths ["test-resources"]}'
Carving test-resources/app.clj
Found unused var:
(defn unused-function [])
Type Y to remove or i to add app/unused-function to .carve_ignore
n
Found unused var:
(defn another-unused-function [])
Type Y to remove or i to add app/another-unused-function to .carve_ignore
i
Found unused var:
(defn -main []
(used-function))
Type Y to remove or i to add app/another-unused-function to .carve_ignore
i
...
$ cat .carve_ignore
app/another-unused-function
app/-mainIn Emacs you might want to invoke carve using the :report option in eshell. When you enable compilation-minor-mode the links become clickable.
Copyright © 2019 Michiel Borkent
Distributed under the EPL License. See LICENSE.