12.2.0 (2022-06-25)

Features

Implement Improve error location RFC #835
It will make the error location more details.

This change is for rule developer.

• Add loc and range property to TextlintMessage(result)
• Add padding prorperty to RuleError(message, details).
• Add locator object to rule's context
  • lcoator.at(index), locator.range([startIndex, endIndex]), and locator.loc({ start: { line, column }, end: { line, column }}).
• textlint-tester's valid and invalid support range property
• Deprecate index, line and column property on TextlintMessage and report function
  • Preserve current behavior for backward compatible
• Update filterMessages to use new range property on TextlintMessage
• Use readonly [number, number] as range in all packages
• Fix filterMessages bug c8a670f
• Refactor tests
• Update rule.md documentation
  • Add padding and locator object
  • Add peerDependencies note

textlint v12.2.0 will introduce padding and locator.
If your will use it, please add peerDependencies to package.json on your rule package.

• Edit: No more peerDependencies. It is complex and there are less advantages.

  "peerDependencies": {
    "textlint": ">= 12.2.0"
  },
  "peerDependenciesMeta": {
    "textlint": {
      "optional": true
    }
  }

For textlint rule creator

Before:

const { Syntax, report, RuleError } = context;
// .....
report(node, new RuleError(message, {
  index: 1
}));

After:

const { Syntax, report, RuleError, locator } = context;
// .....
report(node, new RuleError(message, {
  padding: locator.at(1)
}));

If you want to get more correct location, please use locator.range or locator.loc

const { Syntax, report, RuleError, locator } = context;
// .....
report(node, new RuleError(message, {
  padding: locator.range([1, 5]) // The error related to 1 - 5 index.
}));

For more details, see https://textlint.github.io/docs/rule.html#ruleerror

• #835

Changelogs

Bug Fixes

• deps: update babel monorepo (89b2395)
• deps: update babel monorepo (6a3e841)
• deps: update babel monorepo (a91e594)
• deps: update babel monorepo (c9f1957)
• deps: update babel monorepo to ^7.16.5 (#834) (dcbc196)
• deps: update babel monorepo to ^7.16.7 (e8c10aa)
• deps: update babel monorepo to ^7.17.10 (1539f0a)
• deps: Update chalk (#842) (56ba52c)
• deps: update dependency @babel/core to ^7.17.12 (add5313)
• deps: update dependency @babel/core to ^7.17.9 (db74d3a)
• deps: update dependency @babel/core to ^7.18.2 (73c2047)
• deps: update dependency table to ^6.7.5 (fdfcce6)
• deps: update dependency table to ^6.8.0 (5e1aa18)
• deps: Update packages that depend on ansi-regex (#841) (17c03cd)
• deps: Update string-width (#844) (675bc93)
• textlint: remove log-symbols (#845) (000d07a)

Features

• textlint: add padding property and locator (#836) (f94d5f8)