https://github.com/siriusstarr/elm-review-import-graph

https://github.com/siriusstarr/elm-review-import-graph

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/siriusstarr/elm-review-import-graph
• Owner: SiriusStarr
• License: bsd-3-clause
• Created: 2022-11-05T17:10:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T20:42:30.000Z (2 months ago)
• Last Synced: 2024-10-28T21:32:44.614Z (2 months ago)
• Language: Elm
• Size: 584 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# elm-review-import-graph

Provides an [`elm-review`](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/) rule to display the

import graph of your project (in the [DOT language](https://graphviz.org/doc/info/lang.html)).

## Provided rules

- [`ExtractImportGraph`](https://package.elm-lang.org/packages/SiriusStarr/elm-review-import-graph/1.0.0/ExtractImportGraph) - Extract the import graph of your project's modules.

## Configuration

```elm

module ReviewConfig exposing (config)

import ExtractImportGraph

import Review.Rule exposing (Rule)

config : List Rule

config =

    [ ExtractImportGraph.rule

    ]

```

## Try it out

You can try the example configuration above out by running the following command:

```bash

elm-review --template SiriusStarr/elm-review-import-graph/preview --extract --report=json | jq -r '.extracts.ExtractImportGraph.onlineGraph'

```