Skip to content
Slamhound rips your namespace form apart and reconstructs it.
Clojure
Pull request Compare This branch is 1 commit ahead, 311 commits behind technomancy:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src
test/slamhound
.gitignore
README.md
project.clj

README.md

Slamhound

They sent a slamhound on Turner's trail in New Delhi, slotted it
to his pheromones and the color of his hair. It caught up with him
on a street called Chandni Chauk and came scrambling for his
rented BMW through a forest of bare brown legs and pedicab
tires. Its core was a kilogram of recrystallized hexogene and
flaked TNT. He didn't see it coming. The last he saw of India was
the pink stucco facade of a place called the Khush-Oil Hotel.

Because he had a good agent, he had a good contract. Because he
had a good contract, he was in Singapore an hour after the
explosion. Most of him, anyway. The Dutch surgeon liked to joke
about that, how an unspecified percentage of Turner hadn't made it
out of Palam International on that first flight and had to spend
the night there in a shed, in a support vat.

It took the Dutchman and his team three months to put Turner
together again. They cloned a square meter of skin for him, grew
it on slabs of collagen and shark-cartilage polysaccharides. They
bought eyes and genitals on the open market. The eyes were green.

-- Count Zero, page 1. By William Gibson

Slamhound rips your ns form apart and reconstructs it. No Dutch surgeon required.

Leiningen Usage

For this you will need to add Slamhound in both :dependencies and :dev-dependencies:

[slamhound "1.1.1"]

Then run from the command line:

$ cat src/my/namespace.clj # before: ns form is missing clauses

(ns my.namespace
  "I have a docstring.")

(defn -main [& args]
  (pprint args)
  (io/copy (ByteArrayInputStream. (.getBytes "hello"))
           (first args))) 

$ lein slamhound src/my/namespace.clj # after: spits out new ns form

(ns my.namespace
  "I have a doc string."
  (:use [clojure.pprint :only [pprint]])
  (:require [clojure.java.io :as io])
  (:import (java.io ByteArrayInputStream)))

For large projects, it can be slow to re-run from the command-line since it has to load every namespace on the classpath for every invocation. The interactive task can mitigate this:

$ lein int
Welcome to Leiningen. Type help for a list of commands.
lein> slamhound src/my/namespace.clj
[...]

The first run will be slower, but successive runs will be quick.

Repl Usage

You can also use any repl:

user=> (use 'slam.hound)
nil
user=> (reconstruct "src/my/namespace.clj")
(ns my.namespace
  "I have a doc string."
  (:use [clojure.pprint :only [pprint]])
  (:require [clojure.java.io :as io])
  (:import (java.io ByteArrayInputStream)))

Emacs Usage

Add this definition to your Emacs config, then start a slime session.

(defun slamhound ()
  (interactive)
  (save-excursion 
    (let ((result (first (slime-eval `(swank:eval-and-grab-output
                       (format "(do (require 'slam.hound)
                                                     (slam.hound/reconstruct \"%s\"))"
                           ,buffer-file-name))))))
      (goto-char (point-min))
      (kill-sexp)
      (insert result))))

Then you'll be able to run M-x slamhound to reconstruct your ns form. This also avoids the startup penalty.

The Rules

Slamhound can only rebuild your namespace if it follows the rules and doesn't do anything too fancy. If your code depends upon a :require clause, the required namespace must be aliased :as the last segment of its name. The only supported option to :use is :only.

Future Plans

  • Better pretty-printing
  • Piggy-backing elisp inside jar
  • Allow for custom disambiguator functions

License

Copyright (C) 2011 Phil Hagelberg

Distributed under the Eclipse Public License, the same as Clojure.

Something went wrong with that request. Please try again.