Skip to content

Commit db1033a

Browse files
committed
feat: enabling filtering via excluded_globs param (Fix #21, Fix #27)
1 parent 2acdd5a commit db1033a

File tree

9 files changed

+2841
-38
lines changed

9 files changed

+2841
-38
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
node_modules
1+
node_modules

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,33 @@ Default: diagram.svg
1818

1919
## `excluded_paths`
2020

21-
A list of paths to exclude from the diagram, separated by commas.
21+
A list of paths to folders to exclude from the diagram, separated by commas.
2222

2323
For example: dist,node_modules
2424

2525
Default: node_modules,bower_components,dist,out,build,eject,.next,.netlify,.yarn,.vscode,package-lock.json,yarn.lock
2626

27+
## `excluded_globs`
28+
29+
A semicolon-delimited array of file [globs](https://globster.xyz/) to exclude from the diagram, using [micromatch](https://github.com/micromatch/micromatch) syntax. Provided as an array.
30+
31+
For example:
32+
33+
```yaml
34+
excluded_globs: 'frontend/*.spec.js;**/*.{png,jpg};**/!(*.module).ts'
35+
# Guide:
36+
# - 'frontend/*.spec.js' # exclude frontend tests
37+
# - '**/*.{png,ico,md}' # all png, ico, md files in any directory
38+
# - '**/!(*.module).ts' # all TS files except module files
39+
```
40+
2741
## `root_path`
2842

29-
The directory (and its children) that you want to visualize in the diagram.
43+
The directory (and its children) that you want to visualize in the diagram, relative to the repository root.
3044

31-
For example: `./src/`
45+
For example: `src/`
3246

33-
Default: `./`
47+
Default: `''` (current directory)
3448

3549
## `max_depth`
3650

0 commit comments

Comments
 (0)