Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minibill/elm-review-call-graph
Extract the call graph from an application
https://github.com/minibill/elm-review-call-graph
elm elm-review
Last synced: about 2 months ago
JSON representation
Extract the call graph from an application
- Host: GitHub
- URL: https://github.com/minibill/elm-review-call-graph
- Owner: miniBill
- License: bsd-3-clause
- Created: 2023-05-17T21:36:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T11:15:01.000Z (3 months ago)
- Last Synced: 2024-09-12T22:31:04.997Z (3 months ago)
- Topics: elm, elm-review
- Language: Elm
- Homepage: https://package.elm-lang.org/packages/miniBill/elm-review-call-graph/latest/
- Size: 585 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# elm-review-call-graph
Provides [`elm-review`](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/) rules to draw and/or explore the call graph in an application.
The call graph is a list of which functions calls which other function. It is useful to visualize the dependencies between the various parts of your codebase, at a function granularity.
## Provided rules
- [`ExtractCallGraph`](https://package.elm-lang.org/packages/miniBill/elm-review-call-graph/1.0.3/ExtractCallGraph/) - Extracts the call graph.
## Configuration
```elm
module ReviewConfig exposing (config)import ExtractCallGraph
import Review.Rule exposing (Rule)config : List Rule
config =
[ ExtractCallGraph.rule
]
```## Try it out
You can try the example configuration above out by running the following command:
```bash
elm-review --template miniBill/elm-review-call-graph/example --extract --report=json | jq ".extracts.ExtractCallGraph" > call-graph.json
```You can then open the call graph with the viewer in the `viewer` directory.