feat: implement `info` severity level #1610

azu · 2025-06-29T13:39:36Z

Summary

This PR implements proper support for the info severity level across all formatters and adds comprehensive test coverage, resolving the confusion between none and info severity levels.

Fixes #1608

Changes Made

1. Updated Severity Level Definitions

Updated TextlintRuleSeverityLevelKeys.ts: Changed info from value 0 to 3 to make it distinct from none
Updated TextlintRuleSeverityLevel.ts: Added proper type support for info level
Updated SeverityLevel.ts: Aligned CLI severity definitions

2. Enhanced All Formatters

Updated all formatters to properly handle the three distinct severity levels:

Linter Formatters:

stylish.ts: Added green "info" display with proper counting
compact.ts: Added "Info" prefix for info messages
unix.ts: Added "[Info/rule_id]" format
table.ts: Added "info" type in table format
checkstyle.ts: Added severity="info" in XML output
junit.ts: Added "Info" severity in test output
tap.ts: Added severity: info in YAML output
pretty-error.ts: Added info level handling with proper counting

Fixer Formatter:

stylish.ts: Added info level support for fix output

3. Updated Core Logic

rule-severity.ts: Updated error message to include "info" in severity options
filter-severity-process.ts: Maintained --quiet behavior to show only errors

4. Comprehensive Test Coverage

Added test cases for info severity level across all formatters:

Added info level tests for all 10 formatter test files
Added CLI snapshot tests for info severity with different formatters
Ensured proper output formatting for info messages

Behavior Changes

Before

// Confusing: info had same value as none
TextlintRuleSeverityLevelKeys.info === 0  // Same as none
// Info messages displayed as warnings in all formatters

After

// Clear distinction
TextlintRuleSeverityLevelKeys.none === 0     // Disabled
TextlintRuleSeverityLevelKeys.warning === 1  // Warning (yellow)
TextlintRuleSeverityLevelKeys.error === 2    // Error (red)  
TextlintRuleSeverityLevelKeys.info === 3     // Info (green)

Formatter Output Examples

Stylish:

  5:10  info  Unexpected foo  foo
✖ 1 problem (0 Errors, 0 Warning, 1 info)

Compact:

foo.js: line 5, col 10, Info - Unexpected foo. (foo)

Table:

║ 5        │ 10       │ info     │ Unexpected foo. │ foo ║

Backward Compatibility

No breaking changes: Existing configurations continue to work
--quiet flag: Still shows only errors (severity 2) as before
Rule configurations: Existing severity: "info" now works as expected

Testing

✅ All existing tests pass
✅ Added comprehensive test coverage for info severity
✅ Added CLI snapshot tests for different formatters
✅ Verified --quiet flag behavior is preserved

Benefits

Clear semantic meaning: Info messages are visually distinct from warnings
Better user experience: Users can use info level for non-critical suggestions
Consistent behavior: All formatters handle severity levels uniformly
Improved maintainability: Using constants instead of magic numbers

…matters

…yle formatters

… tests

Copilot

Pull Request Overview

This PR adds support for a new "info" severity level across the codebase, ensuring that all formatters and tests correctly handle this additional level. Key changes include updating severity level definitions, enhancing formatter outputs to differentiate "info" from other severities, and adding comprehensive test coverage to validate the new behavior.

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

File	Description
packages/textlint/src/shared/type/SeverityLevel.ts	Updates the severity level mapping to distinguish info from none, warning, and error
packages/@textlint/types/src/Rule/TextlintRuleSeverityLevel.ts	Revises type definitions to support info as a distinct severity
Various formatter source and test files	Modify message type calculations and summary constructions to handle "info" severity consistently
packages/@textlint/kernel/src/shared/rule-severity.ts and related	Updates error messages and doc details to include the new "info" severity

Comments suppressed due to low confidence (1)

packages/@textlint/kernel/src/messages/filter-severity-process.ts:8

Consider adding tests to verify that info severity messages are correctly filtered out when the --quiet flag is enabled, ensuring that only error messages (severity 2) are displayed in quiet mode.

 * Filter messages by their severity.

Copilot · 2025-06-29T13:40:16Z

packages/@textlint/linter-formatter/src/formatters/stylish.ts

@@ -101,19 +111,19 @@ function formatter(results: TextlintResult[], options: FormatterOptions) {
    });

    if (total > 0) {
+        const problemParts = [];


The logic for building the summary string for problem counts is duplicated across multiple formatter files. Consider extracting this common logic into a shared utility function to improve maintainability.

The test was expecting '1 warning' but should expect '1 info' when severity is 3. This aligns with the actual formatter output that correctly displays info messages.

- Replace TextlintRuleSeverityLevelKeys with numeric values (1: warning, 2: error, 3: info) - Remove dependency on @textlint/kernel from formatter packages to maintain clean architecture - Update all 10 formatters: stylish, compact, unix, table, checkstyle, junit, tap, pretty-error, fixer-formatter - All tests continue to pass with numeric severity level checks

- Add detailed explanation of severity levels (1: warning, 2: error, 3: info) - Update examples to include severity property - Remove outdated reference to SeverityLevel.js file - Add practical examples showing info level usage

github-actions · 2025-06-29T14:00:23Z

PR Preview Action v1.6.1
🚀 View preview at https://textlint.github.io/textlint/pr-preview/pr-1610/
Built to branch `gh-pages` at 2025-06-29 14:56 UTC. Preview will be ready when the GitHub Pages deployment is complete.

- Add tests for filterWarningMessages function to ensure it filters out info messages (severity 3) and warning messages (severity 1) - Add tests for through function to verify it passes all messages unchanged - Add tests for createSeverityFilter to verify --quiet flag behavior - Ensure info messages are properly filtered when using --quiet mode - Tests validate that only error messages (severity 2) are shown in quiet mode

- Fix test case to expect '1 Info' instead of '1 Warning' for info severity (3) - Update warningCount from 1 to 0 in test data to match actual behavior - Info messages should be counted separately from warnings and errors - Table formatter correctly displays info messages with their own category

…r tests

- Implement tests for the pretty-error formatter to validate error output formatting. - Add tests for the stylish formatter to ensure correct handling of messages and severity levels. - Create tests for the table formatter to verify the output structure for different message scenarios. - Introduce tests for the tap formatter to check the output format for single and multiple messages. - Develop tests for the unix formatter to confirm the correct formatting of error messages across multiple files.

…hots

… formatter functionality

…d tests

…yaml

azu · 2025-06-29T14:57:13Z

packages/@textlint/types/src/Rule/TextlintRuleSeverityLevel.ts

 type none = 0;
-type info = 0;
 type warning = 1;
 type error = 2;
-export type TextlintRuleSeverityLevel = none | info | warning | error;
+type info = 3;
+export type TextlintRuleSeverityLevel = none | warning | error | info;


main change

azu added 3 commits June 29, 2025 22:09

feat: add support for 'info' severity level in textlint rules and for…

f510e7b

…matters

feat: implement 'info' severity level handling in stylish and checkst…

89e3e49

…yle formatters

feat: add support for 'info' severity level in various formatters and…

10195a1

… tests

Copilot AI review requested due to automatic review settings June 29, 2025 13:39

Copilot AI reviewed Jun 29, 2025

View reviewed changes

azu added 3 commits June 29, 2025 22:50

fix: correct stylish formatter test expectation for info severity level

298f5d4

The test was expecting '1 warning' but should expect '1 info' when severity is 3. This aligns with the actual formatter output that correctly displays info messages.

docs: update formatter.md to document severity levels

f78e584

- Add detailed explanation of severity levels (1: warning, 2: error, 3: info) - Update examples to include severity property - Remove outdated reference to SeverityLevel.js file - Add practical examples showing info level usage

azu added the Type: Feature New Feature label Jun 29, 2025

azu self-assigned this Jun 29, 2025

azu changed the title ~~feat: implement 'info' severity level support across formatters and tests~~ feat: implement info severity level Jun 29, 2025

azu added 7 commits June 29, 2025 23:08

refactor: remove deprecated createFormatter test from linter formatte…

6a90e37

…r tests

refactor: update table formatter tests to use expect and inline snaps…

d6b39bb

…hots

refactor: remove deprecated tests and add new comprehensive tests for…

a55fda7

… formatter functionality

refactor: streamline error summary formatting in stylish formatter an…

89f118d

…d tests

refactor: remove unused dependencies from package.json and pnpm-lock.…

e9e406f

…yaml

azu commented Jun 29, 2025

View reviewed changes

azu merged commit 7d56491 into master Jun 29, 2025
18 checks passed

azu deleted the severity-info branch June 29, 2025 14:58

github-actions bot mentioned this pull request Jun 29, 2025

v15.1.0 #1611

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: implement `info` severity level #1610

feat: implement `info` severity level #1610

Uh oh!

azu commented Jun 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jun 29, 2025

Uh oh!

github-actions bot commented Jun 29, 2025 •

edited

Loading

Built to branch `gh-pages` at 2025-06-29 14:56 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

azu Jun 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: implement info severity level #1610

feat: implement info severity level #1610

Uh oh!

Conversation

azu commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes Made

1. Updated Severity Level Definitions

2. Enhanced All Formatters

3. Updated Core Logic

4. Comprehensive Test Coverage

Behavior Changes

Before

After

Formatter Output Examples

Backward Compatibility

Testing

Benefits

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 29, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2025-06-29 14:56 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

azu Jun 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feat: implement `info` severity level #1610

feat: implement `info` severity level #1610

azu commented Jun 29, 2025 •

edited

Loading

github-actions bot commented Jun 29, 2025 •

edited

Loading

Built to branch `gh-pages` at 2025-06-29 14:56 UTC.
Preview will be ready when the GitHub Pages deployment is complete.