Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
emdoyle committed Oct 2, 2024
1 parent ad9ff90 commit 8d453c6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
7 changes: 6 additions & 1 deletion docs/usage/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,18 @@ To filter the output, the `-d` and `-u` options allow specifying which module pa
Tach will generate a visual representation of your dependency graph!
```bash
usage: tach show [-h] [--web] [-o [OUT]]
usage: tach show [-h] [--web] [--mermaid] [-o [OUT]] [included_paths ...]
Visualize the dependency graph of your project.
positional arguments:
included_paths Paths to include in the module graph. If not provided, the entire project is
included.
options:
-h, --help show this help message and exit
--web Open your dependency graph in a remote web viewer.
--mermaid Generate a mermaid.js graph instead of a DOT file.
-o [OUT], --out [OUT]
Specify an output path for a locally generated module graph file.
```
Expand Down
16 changes: 11 additions & 5 deletions docs/usage/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,17 @@ This is the project-level configuration file which should be in the root of your

`exclude` accepts a list of directory patterns to exclude from checking. These are treated as regex/glob paths (depending on `use_regex_matching`) which match from the beginning of a given file path. For example: when using glob matching `project/*.tests` would match any path beginning with `project/` and ending with `.tests`.

`ignore_type_checking_imports` is a boolean which, when enabled, silences `tach check` failures caused by imports under a `TYPE_CHECKING` conditional block
<Note>
Tach uses forward slashes to match path separators, even on Windows.
</Note>

`exact` is a boolean which causes `tach check` to fail if any declared dependencies are found to be unused
`ignore_type_checking_imports` is a boolean which, when enabled, silences `tach check` failures caused by imports under a `TYPE_CHECKING` conditional block.

`forbid_circular_dependencies` is a boolean which, when enabled, causes `tach check` to fail if any circular dependencies are detected
`exact` is a boolean which causes `tach check` to fail if any declared dependencies are found to be unused.

`use_regex_matching` is a boolean which, when enabled, uses regex (default) matching to exclude patterns else uses globs matching
`forbid_circular_dependencies` is a boolean which, when enabled, causes `tach check` to fail if any circular dependencies are detected.

`use_regex_matching` is a boolean which, when enabled, uses regex (default) matching to exclude patterns else uses globs matching.

```toml
exclude = [
Expand Down Expand Up @@ -79,7 +83,9 @@ Each module listed under the `modules` key above can accept the following attrib
- `visibility`: a list of other modules which can import from this module (default: `['*']`)
- `strict`: enables [strict mode](strict-mode) for the module

Tach also supports [deprecating individual dependencies](../usage/deprecate).
<Note>
Tach also supports [deprecating individual dependencies](../usage/deprecate).
</Note>

## Source Roots

Expand Down

0 comments on commit 8d453c6

Please sign in to comment.