Skip to content

Commit b5b2444

Browse files
committed
docs(analyze): document the -mi "*" allow-list pattern
Show that `*` matches every code, so `-mi "*"` plus re-introducing specific codes builds an allow-list — and point out it remaps severity, unlike the --code filter.
1 parent e72ac55 commit b5b2444

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/03_reference/analyzing-code.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,15 @@ error = ["MultipleKeywords"]
112112
hint = ["KeywordNotUsed"]
113113
```
114114

115+
`*` is a wildcard that matches every code, so `-mi "*"` silences all diagnostics. Re-introducing specific codes at a chosen severity then gives you an allow-list:
116+
117+
```bash
118+
# show only KeywordNotFound — reported as a warning
119+
robotcode analyze code -mi "*" -mw KeywordNotFound
120+
```
121+
122+
This is a *remap* (the kept codes take the severity you assign). If you instead want to keep a code at its original severity, use the [`--code` filter](#reporting-only-some-diagnostics).
123+
115124
Because the severity is configurable, the text and SARIF/GitHub/GitLab output always carries the **effective** severity, not a hard-coded one. For the full modifier system — including inline `# robotcode:` comments — see [Controlling Diagnostics with Modifiers](diagnostics-modifiers.md).
116125

117126
### Reporting only some diagnostics

0 commit comments

Comments
 (0)