Skip to content

Commit 4da9fa3

Browse files
committed
chore: hightlight warnings section in output explanation
1 parent aa63b5f commit 4da9fa3

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

Diff for: README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,17 @@ npx vue-mess-detector analyze ./src --group=file
112112

113113
## ℹ️ Output explanation
114114

115-
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.
115+
**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.
116116

117-
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.
117+
**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.
118118

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

121-
File: Shows the path to the file where the rule is applied.
122-
123-
Description: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
124-
125-
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.
124+
> [!IMPORTANT]
125+
> Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
126126
127127
## 📚 Documentation
128128

Diff for: docs/get-started.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,13 @@ npx vue-mess-detector analyze ./src --group=file
112112

113113
**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.
114114

115-
- Rule: The blue line that defines the specific rule being evaluated.
116-
- File: Shows the path to the file where the rule is applied.
117-
- Description: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
118-
- 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.
115+
- **Rule**: The blue line that defines the specific rule being evaluated.
116+
- **File**: Shows the path to the file where the rule is applied.
117+
- **Description**: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
118+
- **Message**: Indicates the line of code where the rule was violated.
119+
120+
> [!IMPORTANT]
121+
> Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
119122
120123
## 📋 Rulesets
121124

0 commit comments

Comments
 (0)