clj-usage-graph

KO | EN

gitlite — search

#typescript #llm #go #golang #machine-learning #deep-learning #linux #docker #nodejs #cli #kubernetes #security #pytorch #mcp

clj-usage-graph

(★ 28)

Haxy usage graphs for Clojure projects

clj-usage-graph Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# clj-usage-graph

A Clojure library that emits usage diagrams for your project.

![Example](https://raw.githubusercontent.com/gfredericks/clj-usage-graph/master/g.svg)

## Caveats

1. For some graph types it will load all the source files you give it,
   so beware of any top-level side-effects.
2. It doesn't reflect macro usage at all. Any macros in your project
   will appear unused, as only the expanded code is analyzed.
3. Needs better support for top level effects, protocols, and records.

## Obtention

Leiningen coordinates:

``` clojure
[com.gfredericks/clj-usage-graph "0.3.0"]
```

## User Profile Setup

You can use `clj-usage-graph` simply by adding it as a dependency
and calling the appropriate functions, but I like this setup in my
`~/.lein/profiles.clj`:

``` clojure
{:user
 {...
  :aliases {"var-graph"
            ["with-profile" "+clj-usage-graph" "run"
             "-m" "com.gfredericks.clj-usage-graph/var-graph"]
            "namespace-graph"
            ["with-profile" "+clj-usage-graph" "run"
             "-m" "com.gfredericks.clj-usage-graph/namespace-graph"]}}

;; separate profile so that we only have these deps when we're
 ;; actually using clj-usage-graph
 :clj-usage-graph
 {... :dependencies [...
                     [com.gfredericks/clj-usage-graph "0.3.0"]]}
```

## Usage

Make sure you have graphviz installed and thus the `dot` command
available. The following examples use the aliases defined above.

### Var Usage Graphs

```
find src -type f | \
xargs lein var-graph | \
dot -Tsvg -o g.svg
```

### Namespace Dependency Graphs

```
find src -type f | \
xargs lein namespace-graph | \
dot -Tsvg -o g.svg
```

## License

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

clj-usage-graph

clj-usage-graph Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

clj-usage-graph

clj-usage-graph Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README