Skip to content

Commit

Permalink
fix description for unknown-preprocessor-directives
Browse files Browse the repository at this point in the history
  • Loading branch information
slavaleleka committed Nov 7, 2023
1 parent f4429ac commit 1a47a6d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,8 @@ Checks if the same modifier is used multiple times in a single network rule.

Checks if the used preprocessor directives are known.

> **Note**: Preprocessor directives are case-sensitive, so `!#IF` is to be considered as invalid.

- **Severity:** `error` (2)
- **Options:** none
- **Fixable:** no
Expand All @@ -611,6 +613,7 @@ Checks if the used preprocessor directives are known.
- **Additional information:**
- Currently, the following preprocessor directives are supported:
- `if`: [reference][if-kb]
- `else`: [reference][if-kb]
- `endif`: [reference][if-kb]
- `include`: [reference][include-kb]
- `safari_cb_affinity`: [reference][safari-cb-kb]
Expand Down
4 changes: 3 additions & 1 deletion src/linter/rules/unknown-preprocessor-directives.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ function isKnownPreProcessorDirective(name: string): boolean {
}

/**
* Rule that checks if a preprocessor directive is known
* Rule that checks if a preprocessor directive is known.
*
* Directives are case-sensitive, so `!#IF` is to be considered as invalid.
*/
export const UnknownPreProcessorDirectives: LinterRule = {
meta: {
Expand Down

0 comments on commit 1a47a6d

Please sign in to comment.