Suggest API

[azu]

• RFC: textlint new message format #833

Purpose

We want to support suggestion on editor like VSCode.
--fix is useful but it provide only a single suggestion.
Also, User can not excludes some fix that is not want to fix.

Some rules want to provide multiple suggestions.
This proposal will near to current fix property.

LLM (Large Language Model) checking is becoming more and more practical.
On the other hand, machine learning-based is not an automatic modification like Lint, but is more appropriate for users to select modifications.　This is because it is a matter of probability.

This requires user-oriented interactivity.

Proposal

• Add suggest property to RuleError
  • suggest should have an array of object that has id and fix and message property
• The suggest property will be into TextlintMessage
• textlint cli may does not provide fixing function the suggest at first
  • This fixing need to use id of suggestion.(ESLint does not have the id)
  • It will need new funciton in kernel to fix text with message
    • https://github.com/textlint/textlint/tree/master/packages/%40textlint/source-code-fixer has the function
    • It is already separated module

const reporter = (context) => {
    const { Syntax, RuleError, fixer, report, getSource } = context;
    return {
        [Syntax.Str](node) {
            const text = getSource(node);
            // "You fix this"
            //      ^^^
            const matchRegexp = /\bfix\b/;
            if (!matchRegexp.test(text)) {
                return;
            }
            // found "fixable" error
            const index = text.search(matchRegexp);
            const length = "fix".length;
            report(
                node,
                new RuleError("Replaced", {
                    index,
                    suggest: [
                        {
                            id: "pattern1",
                            message: "pattern 1",
                            fix: fixer.replaceTextRange([index, index + length], "fixed 1")
                        },
                        {
                            id: "pattern2",
                            message: "pattern 2",
                            fix: fixer.replaceTextRange([index, index + length], "fixed 2")
                        }
                    ]
                })
            );
        }
    };
};
export default {
    linter: reporter,
    fixer: reporter
};

TODO:

• Message Format
• Suggest API is required?
  • new RuleSuggest(message, { suggest: [ ... ] }) or new RuleError(message, { serverity: "info" })
  • Current RuleError will be an error
• How to handle this by textlint CLI?

Similar Works:

• ESLint
  • https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions

[azu]

An editor like vscode-textlint can use it.