Skip to main content

Formatter

Result of linting​

Pass following array of TextLintResult to reporter module.

// results of linting
const results = [
    // TextLintResult object
    {
        filePath: "./myfile.md",
        messages: [
            // TextLintMessage object
            {
                type: "lint",
                ruleId: "semi",
                line: 1,
                column: 23,
                message: "Expected a semicolon.",
                severity: 2  // error
            },
            {
                type: "lint", 
                ruleId: "style-guide",
                line: 2,
                column: 1,
                message: "Consider using a more concise expression.",
                severity: 3  // info
            }
        ]
    }
];

TextLintMessage and TextLintResult are defined as follows.

export class TextlintMessage {
    // See src/shared/type/MessageType.js
    // Message Type
    type: string;
    // Rule Id
    ruleId: string;
    message: string;
    // optional data
    data?: any;
    // FixCommand
    fix?: TextlintFixCommand;
    // location info
    // Text -> AST TxtNode(0-based columns) -> textlint -> TextlintMessage(**1-based columns**)
    line: number; // start with 1
    column: number; // start with 1
    // indexed-location
    index: number; // start with 0
    // Severity Level
    // 1: warning, 2: error, 3: info
    severity: number;
}

// Linting result
export interface TextlintResult {
    filePath: string;
    messages: TextlintMessage[];
}

// "range" will be replaced by "text"
export class TextlintFixCommand {
    text: string;
    range: [number, number];
}

Severity Levels​

The severity property in TextlintMessage indicates the severity level of the message:

  • 1: warning - Issues that should be addressed but don't prevent the text from being processed
  • 2: error - Critical issues that need to be fixed
  • 3: info - Informational messages for guidance or suggestions

Example:

{
    ruleId: "example-rule",
    line: 1,
    column: 10,
    message: "This is an informational message",
    severity: 3  // info level
}

It is compatible for ESLint formatter.

Simple usage from Command line​

We can get the raw output to stdout using json formatter.

$ textlint --format json <file>
[
    // TextLintResult object
    {
        filePath: "./myfile.md",
        messages: [
            // TextLintMessage object
            {
                ruleId: "semi",
                line: 1,
                column: 23,
                message: "Expected a semicolon.",
                severity: 2
            }
        ]
    }
];

Result of fixing​

textlint support fixable rule

Fixable result is a bit difference for things of linting.

// results of fixing
const results = [
    // TextLintFixResult
    {
        filePath: "./myfile.md",
        // fixed content string
        output: "fixed content",
        // applied fixable messages
        // messages is an array of `TextLintMessage`
        applyingMessages: [],
        // not fixable messages
        // messages is an array of `TextLintMessage`
        remainingMessages: [],
        // messages is the same one of `TextLintResult`
        // pre-applyingMessages + remainingMessages
        // messages is an array of `TextLintMessage`
        messages: []
    }
];

TextLintFixResult is defined as follows.

// Fixing result
export interface TextlintFixResult {
    filePath: string;
    // fixed content
    output: string;
    // all messages = pre-applyingMessages + remainingMessages
    // it is same with one of `TextlintResult`
    messages: TextlintMessage[];
    // applied fixable messages
    applyingMessages: TextlintMessage[];
    // original means original for applyingMessages and remainingMessages
    // pre-applyingMessages + remainingMessages
    remainingMessages: TextlintMessage[];
}

It is not compatible for ESLint.

Simple usage from Command line​

We can get the raw output to stdout using json formatter.

$ textlint --fix --format json <file>
[
  {
    "filePath": "./myfile.md",
    "output": "content string",
    "messages": [],
    "applyingMessages": [],
    "remainingMessages": []
  }
]

How to get source code from result?​

You can read the source code from filePath property.

Built-in formatter​

textlint use @textlint/linter-formatter module as built-in formatter.

GitHub Formatter​

The github formatter outputs lint results in GitHub Actions annotation format. This allows lint messages to appear directly in pull request file views, job logs, and the annotations panel.

textlint --format github README.md

This formatter is particularly useful in CI/CD environments like GitHub Actions:

- name: Run textlint
  run: npm exec -- textlint --format github "docs/**/*.md"

When used in GitHub Actions, lint errors will be displayed as:

  • Inline annotations in the Files tab of pull requests
  • Annotations in the job summary
  • Detailed error messages in job logs

Custom Formatter​

textlint -f <package-name>

e.g.) textlint-formatter-codecov

textlint -f textlint-formatter-codecov
# ==
textlint -f codecov