Skip to content

Commit

Permalink
chore: hightlight warnings section in output explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
David-Pena committed Aug 12, 2024
1 parent aa63b5f commit 4da9fa3
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,17 +112,17 @@ npx vue-mess-detector analyze ./src --group=file

## ℹ️ Output explanation

Group by Rule: In this view, the first line is highlighted in blue, representing the rule being evaluated. Following this, you'll see blocks of information structured as follows: file path, description, and message.
**Group by Rule:** In this view, the first line is highlighted in blue, representing the rule being evaluated. Following this, you'll see blocks of information structured as follows: file path, description, and message.

Group by File: In this view, the first line displays the file path being evaluated. Below this, you'll see blocks of information with the following structure: rule, description, and message.
**Group by File:** In this view, the first line displays the file path being evaluated. Below this, you'll see blocks of information with the following structure: rule, description, and message.

Rule: The blue line that defines the specific rule being evaluated.
- **Rule**: The blue line that defines the specific rule being evaluated.
- **File**: Shows the path to the file where the rule is applied.
- **Description**: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
- **Message**: Indicates the line of code where the rule was violated.

File: Shows the path to the file where the rule is applied.

Description: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.

Message: Indicates the line of code where the rule was violated. Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
> [!IMPORTANT]
> Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
## 📚 Documentation

Expand Down
11 changes: 7 additions & 4 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,13 @@ npx vue-mess-detector analyze ./src --group=file

**Group by File:** In this view, the first line displays the file path being evaluated. Below this, you'll see blocks of information with the following structure: rule, description, and message.

- Rule: The blue line that defines the specific rule being evaluated.
- File: Shows the path to the file where the rule is applied.
- Description: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
- Message: Indicates the line of code where the rule was violated. Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
- **Rule**: The blue line that defines the specific rule being evaluated.
- **File**: Shows the path to the file where the rule is applied.
- **Description**: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
- **Message**: Indicates the line of code where the rule was violated.

> [!IMPORTANT]
> Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
## 📋 Rulesets

Expand Down

0 comments on commit 4da9fa3

Please sign in to comment.