Skip to content

Commit

Permalink
doc: updates alerts to use GH markdown alerts
Browse files Browse the repository at this point in the history
  • Loading branch information
sverweij committed Dec 9, 2023
1 parent 7abbe47 commit 83fafe1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ npx depcruise src --include-only "^src" --output-type dot | dot -T svg > depende
> <details>
> <summary>dependency-cruiser v12 and older: add --config option</summary>
>
> While not necessary from dependency-cruiser v13, in v12 and older you'll have
> to pass the --config option to make it find the .dependency-cruiser.js
> While not necessary from dependency-cruiser v13 and later, in v12 and older
> you'll have to pass the --config option to make it find the .dependency-cruiser.js
> configuration file:
>
> ```shell
Expand Down
6 changes: 4 additions & 2 deletions doc/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ results in a PR - potentially along with the mermaid reporter. The markdown
reporter is fairly configurable - see the [markdown](./options-reference.md#markdown)
section in the options reference for details.

> [!note]
> As compared to the `err-html` reporter this one doesn't emit links or show
> a complete list of all run validations. If you need that: create a feature
> request in the dependency-cruiser repo.
Expand Down Expand Up @@ -1232,6 +1233,7 @@ want to do this in a configuration file - see
[tsConfig](./options-reference.md#tsconfig-use-a-typescript-configuration-file-project)
section in the options reference for details.

> [!tip]
> If you happen to use a [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig)
> you can pass that as well - the syntax for tsconfig.json and jsconfig.json
> is identical for all practical purposes.
Expand Down Expand Up @@ -1444,8 +1446,8 @@ GraphViz dot into html that is geared to make the graph easier to use. It adds a

Typical use:

```sh
depcruise -v -T dot src | dot -T svg | depcruise-wrap-stream-in-html > dependency-graph.html
```console
$ depcruise -v -T dot src | dot -T svg | depcruise-wrap-stream-in-html > dependency-graph.html
```

This works for all dot-based reporters, including `archi` and `ddot`
Expand Down
6 changes: 4 additions & 2 deletions doc/options-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,8 @@ Only cruise the specified depth, counting from the specified root-module(s). Thi
command is mostly useful in combination with visualization output like _dot_ to
keep the generated output to a manageable size.

> :bulb: If you use this to get a high level overview of your dependencies, be sure
> [!tip]
> If you use this to get a high level overview of your dependencies, be sure
> to check out the [archi](#archi) reporter. That's more flexible, while still
> taking into account all your rules and dependencies. You can also consider the
> [collapse](#collapse-summarize-to-folder-depth-or-pattern) option for this.
Expand All @@ -510,7 +511,8 @@ And with `"maxDepth": 3` like this:

<img width="623" alt="dependency-cruiser cruised with max depth 3" src="real-world-samples/dependency-cruiser-max-depth-3.svg">

> :bulb: The `maxDepth` option is there to help with visualising. If your goal is to _validate_
> [!tip]
> The `maxDepth` option is there to help with visualizing. If your goal is to _validate_
> this option is best left alone as you'll miss a dependency or two otherwise.
## Matching your environment
Expand Down

0 comments on commit 83fafe1

Please sign in to comment.