What's Changed

Features

• feat(textlint): support plugins for --init option by @chick-p in https://github.com/textlint/textlint/pull/1039

$ npm install textlint textlint-plugin-html textlint-rule-preset-ja-technical-writing
$ npx textlint --init

will generate .textlintrc.json

{
  "plugins": {
    "html": true
  },
  "filters": {},
  "rules": {
    "preset-ja-technical-writing": true
  }
}

Testing

• test(textlint): remove it.only and use ts-node/esm by @azu in https://github.com/textlint/textlint/pull/1043

Dependency Updates

• chore(deps): update dependency textlint-rule-preset-ja-spacing to ^2.3.0 by @renovate in https://github.com/textlint/textlint/pull/1038
• chore(deps): update eslint to ^5.49.0 (minor) by @renovate in https://github.com/textlint/textlint/pull/1040

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.5...13.1.0

What's Changed

Bug Fixes

• fix(ast-node-types): remove markdown extension and fix TxtNodeType by @azu in https://github.com/textlint/textlint/pull/1033
• fix(ast-node-type): fix Node → TxtNode by @azu in https://github.com/textlint/textlint/pull/1035

This release correct ast-node-type types.

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.4...13.0.5

What's Changed

Dependency Updates

• chore(deps): update to rc-config-loader@4 by @azu in https://github.com/textlint/textlint/pull/1031

It will reduce textlint package size.

https://bundlephobia.com/package/[email protected]
https://bundlephobia.com/package/[email protected]

172.8kb ⬇️

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.3...13.0.4

What's Changed

Refactoring

• refactor(kernel): use fast-equals instead of deep-equal by @azu in https://github.com/textlint/textlint/pull/1027

It will reduce @textlint/kernel package size.

• https://bundlephobia.com/package/@textlint/[email protected]
• https://bundlephobia.com/package/@textlint/[email protected]

15.1kb ⬇️

Dependency Updates

• chore(deps): update dependency @types/glob to ^8.0.1 by @renovate in https://github.com/textlint/textlint/pull/1018
• chore(deps): update npm to v9.3.1 by @renovate in https://github.com/textlint/textlint/pull/1026

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.2...13.0.3

What's Changed

Bug Fixes

• fix(ast-node-types): export { TxtNodeType } by @azu in https://github.com/textlint/textlint/pull/1024

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.1...13.0.2

What's Changed

Bug Fixes

• fix(ast-node-types): export { TxtNodeRange, TxtNodeLocation, TxtNodePosition } by @azu in https://github.com/textlint/textlint/pull/1022

If you have used TextNodeRange, TxtNodeLineLocation, TxtNodePosition, please change following:

- import type { TextNodeRange, TxtNodeLineLocation, TxtNodePosition } from "@textlint/ast-node-types";
+ import type { TxtNodeRange, TxtNodeLocation, TxtNodePosition } from "@textlint/ast-node-types";

Refactoring

• refactor: add textlint-script/example* to workspaces by @azu in https://github.com/textlint/textlint/pull/1019
• refactor: use npm 9+ instead of yarn v1 by @azu in https://github.com/textlint/textlint/pull/1020

Full Changelog: https://github.com/textlint/textlint/compare/v13.0.0...13.0.1

textlint v13 support ESM rules/plugins 🎉

We have rewritten CLI and textlint package.
However, it is not a breaking change for most textlint CLI users.
Almost CLI behaviors are the same as textlint v12.

• Blog: https://textlint.github.io/blog/2023/01/27/textlint-13.html

Please share your feedback to us!

🔥 Breaking Changes

• Require Node.js 16+
• textlint --init output .textlintrc.json
  • Previously, textlint --init output .textlintrc
• Improve @textlint/ast-node-types types
  • Now, All node types are defined!
  • It changes the existing node type and it is a breaking change
  • If you want to know TxtAST, please read TxtAST Interface
  • See also Release v13.0.1 · textlint/textlint

  • - import type { TextNodeRange, TxtNodeLineLocation, TxtNodePosition } from "@textlint/ast-node-types";
    + import type { TxtNodeRange, TxtNodeLocation, TxtNodePosition } from "@textlint/ast-node-types";
    

• Use New-CLI instead of Old-CLI
  • textlint has introduced New-CLI and New-APIs in v12.3.0
  • New-CLI uses new APIs: createLinter/loadTextlintrc/loadLinterFormatter/loadFixerFormatter( If you want to know new APIs, please read Use as Node Modules)
  • It means that textlint support rules/plugins that are written by ESM 🎉
  • Remove Old-CLI

Difference between Old-CLI and New-CLI

• New CLI support ESM rules/plugins
• New CLI must require --stdin-filename with --stdin
  • --stdin-filename may be optional in Old-CLI
• Correct exit status

Exit Status on new CLI

0: No Error

• Not found lint error
• --fix: found errors but fix all errors, so exit with 0
• --output-file: Found lint error but --output-file is specified
• --dryRun: Found lint error but --dryRun is specified

1: Lint Error

• found lint error
• --fix: found errors and could not fix all errors, so exit with 1

2: Fatal Error

• Crash textlint process
• Fail to load config/rule/plugin etc...

Remove undocumented way to override preset rule option

textlint v12 supported next textlintrc, but it is undocumented way.

{
  "rules": {
    "preset-ja-technical-writing": true,
    "ja-technical-writing/sentence-length": {
      "max": 100 // It override preset-ja-technical-writing's option
    }
  }
}

textlint v13 will remove this undocumented way.

You need to use next textlintrc.

{
  "rules": {
    "preset-ja-technical-writing": {
      "sentence-length": {
        "max": 100 // It override preset-ja-technical-writing's option
      }
    }
  }
}

For more details, see Configuring textlint · textlint

🆕 Features

Add individual Node type and Add Table/TableRow/TableCell node #1008

• Define all node types in @textlint/ast-node-types
• Add Table/TableRow/TableCell node to @textlint/ast-node-types

These types are defined in @textlint/ast-node-types.

Some nodes have additional properties.
For example, TxtHeaderNode has level property.

export interface TxtHeaderNode extends TxtParentNode {
    type: "Header";
    depth: 1 | 2 | 3 | 4 | 5 | 6;
    children: PhrasingContent[];
}

For more details, see @textlint/ast-node-types.

• @textlint/ast-node-types/src/NodeType.ts.

CHANGELOGS

Breaking Changes

• feat(ast-node-types): Add individual Node type and Add Table/TableRow/TableCell node by @azu in https://github.com/textlint/textlint/pull/1008
• refactor(textlint): use New CLI by default by @azu in https://github.com/textlint/textlint/pull/1011
• fix(textlint): textlint --init create .textlintrc.json by @azu in https://github.com/textlint/textlint/pull/1013
• chore: Change "target" to "ES2018" by @azu in https://github.com/textlint/textlint/pull/1014

Other Changes

• chore(deps): update node.js to v18 by @renovate in https://github.com/textlint/textlint/pull/917

Full Changelog: https://github.com/textlint/textlint/compare/v12.6.1...13.0.0

What's Changed

Refactoring

• refactor(kernel): remove node:events by @azu in https://github.com/textlint/textlint/pull/1003

Dependency Updates

• chore(deps): update eslint to ^5.48.2 (patch) by @renovate in https://github.com/textlint/textlint/pull/1006

Full Changelog: https://github.com/textlint/textlint/compare/v12.6.0...12.6.1

What's Changed

Features

• feat(kernel): report plugin parse error as lint error by @azu in https://github.com/textlint/textlint/pull/986

Bug Fixes

• chore(kernel): fix typo by @Sean0628 in https://github.com/textlint/textlint/pull/991

Refactoring

• refactor: update to structured-source@4 by @azu in https://github.com/textlint/textlint/pull/984
• refactor(kernel): replace assert with invariant function by @Sean0628 in https://github.com/textlint/textlint/pull/990

Dependency Updates

• fix(deps): update dependency rc-config-loader to ^4.1.2 by @renovate in https://github.com/textlint/textlint/pull/981
• chore(deps): update dependency @textlint/types to ^12.3.0 by @renovate in https://github.com/textlint/textlint/pull/982
• chore(deps): update eslint to ^5.48.0 (patch) by @renovate in https://github.com/textlint/textlint/pull/987
• chore(deps): update dependency eslint-config-prettier to ^8.6.0 by @renovate in https://github.com/textlint/textlint/pull/988
• chore(deps): update dependency @textlint/types to ^12.5.0 by @renovate in https://github.com/textlint/textlint/pull/992
• fix(deps): update dependency @babel/core to ^7.20.12 by @renovate in https://github.com/textlint/textlint/pull/993
• chore(deps): update patch updates (patch) by @renovate in https://github.com/textlint/textlint/pull/997
• chore(deps): update dependency lerna to ^6.4.0 by @renovate in https://github.com/textlint/textlint/pull/995
• chore(deps): update dependency lerna to ^6.4.1 by @renovate in https://github.com/textlint/textlint/pull/999
• chore(deps): update eslint to ^5.48.1 (patch) by @renovate in https://github.com/textlint/textlint/pull/998

Full Changelog: https://github.com/textlint/textlint/compare/v12.5.1...12.6.0

What's Changed

Features

• feat(kernel): report plugin parse error as lint error by @azu in https://github.com/textlint/textlint/pull/986

Bug Fixes

• chore(kernel): fix typo by @Sean0628 in https://github.com/textlint/textlint/pull/991

Refactoring

• refactor: update to structured-source@4 by @azu in https://github.com/textlint/textlint/pull/984
• refactor(kernel): replace assert with invariant function by @Sean0628 in https://github.com/textlint/textlint/pull/990

Dependency Updates

• fix(deps): update dependency rc-config-loader to ^4.1.2 by @renovate in https://github.com/textlint/textlint/pull/981
• chore(deps): update dependency @textlint/types to ^12.3.0 by @renovate in https://github.com/textlint/textlint/pull/982
• chore(deps): update eslint to ^5.48.0 (patch) by @renovate in https://github.com/textlint/textlint/pull/987
• chore(deps): update dependency eslint-config-prettier to ^8.6.0 by @renovate in https://github.com/textlint/textlint/pull/988
• chore(deps): update dependency @textlint/types to ^12.5.0 by @renovate in https://github.com/textlint/textlint/pull/992
• fix(deps): update dependency @babel/core to ^7.20.12 by @renovate in https://github.com/textlint/textlint/pull/993
• chore(deps): update patch updates (patch) by @renovate in https://github.com/textlint/textlint/pull/997
• chore(deps): update dependency lerna to ^6.4.0 by @renovate in https://github.com/textlint/textlint/pull/995
• chore(deps): update dependency lerna to ^6.4.1 by @renovate in https://github.com/textlint/textlint/pull/999
• chore(deps): update eslint to ^5.48.1 (patch) by @renovate in https://github.com/textlint/textlint/pull/998

Full Changelog: https://github.com/textlint/textlint/compare/v12.5.1...12.5.2

12.5.1 (2023-01-04)

Bug Fixes

• fix(textlint): fix an error on compats fixer formatter by @Sean0628 in https://github.com/textlint/textlint/pull/980

Full Changelog: https://github.com/textlint/textlint/compare/v12.5.0...v12.5.1

12.5.0 (2023-01-04)

Features

• add --format=fixed-result option to fixer format (755dba5), closes #967 by @Sean0628 in https://github.com/textlint/textlint/pull/978

Example:

$ cat README.md | npx textlint --stdin --stdin-filename README.md --fix --format fixed-result --output-file NEW.md

For more details, see https://textlint.github.io/docs/cli.html#pipe-to-textlint

New Contributors

• @Sean0628 made their first contribution in https://github.com/textlint/textlint/pull/978

Full Changelog: https://github.com/textlint/textlint/compare/v12.4.0...v12.5.0

12.4.0 (2023-01-02)

Features

• textlint: add --print-config flag (9aa400f)

What's Changed

• refactor(textlint-test): use @textlint/kernel by @azu in https://github.com/textlint/textlint/pull/974
• feat(textlint): add --print-config flag for New CLI by @azu in https://github.com/textlint/textlint/pull/975

Full Changelog: https://github.com/textlint/textlint/compare/v12.3.1...v12.4.0

12.3.1 (2022-12-30)

Bug Fixes

• deps: update babel monorepo to ^7.20.7 (30a1386)
• textlint: fix ESM loading issue on Windows (#972) (a6b9bf5)

12.3.0 (2022-12-29)

Features

• monorepo: upgrade to lerna@6 and use NX (#964) (e372795)
• textlint: add new APIs and new CLI for ESM (#965) (3be8e39)

Overview

• Support Rules/Filter/Pluugins that are written in ECMAScript Modules
• Add new CLI
• Add new APIs: createLinter/loadTextlintrc/loadLinterFormatter/loadFixerFormatter
  • It will replace TextLintCore/TextFixEngine/TextLintEngine

📝 ESM Rules/Filter/Pluugins only works in createLinter API.
This is because TextLintCore/TextFixEngine/TextLintEngine were assumed to be synchronous processes.
createLinter API does loading as async.

Breaking Changes

No changes in existing CLI.

Difference between Old-CLI and New-CLI

• New CLI support ESM
• New CLI must require --stdin-filename with --stdin
  • --stdin-filename may be optional in Old-CLI
• Correct exit status

Exit Status on new CLI

0: No Error

• Not found lint error
• --fix: found errors but fix all errors, so exit with 0
• --output-file: Found lint error but --output-file is specified
• --dryRun: Found lint error but --dryRun is specified

1: Lint Error

• found lint error
• --fix: found errors and could not fix all errors, so exit with 1

2: Fatal Error

• Crash textlint process
• Fail to load config/rule/plugin etc...

New APIs

Ww introduce new API like createLinter for supporting Async APIs.
v13 continue to support current TextLintEngine and TextFixEngine for backward compatible.

• #902

New createLinter and loadTextlintrc support ESM rules/plugins.
In other hands, TextLintEngine and TextFixEngine can not support ESM rules/plugins.

https://github.com/textlint/textlint/blob/60cea514f7eaefbff4411087d16a51daf68f12a4/packages/textlint/src/index.ts

• createLinter: create linter instance
  • lintFiles(files): lint files and return linter messages
  • lintText(text, filePath) lint text with virtual filePath and return linter messages
  • fixFiles(files lint text and return fixer messages
  • fixText(text, filePath) lint text with virtual filePath and return fixer messages
    • fixFiles and fixText does not modify files
• loadTextlintrc: load .textlintrc config file and return a descriptor object
• loadLinerFormatter and loadFixerFormatter: load formatter

Lint files and output to console.

import { createLinter, loadTextlintrc, loadLinterFormatter } from "textlint";
// descriptor is a structure object for linter
// It includes rules, plugins, and options
const descriptor = await loadTextlintrc();
const linter = createLinter({
    descriptor
});
const results = await linter.lintFiles(["*.md"]);
// textlint has two types formatter sets for linter and fixer
const formatter = await loadLinterFormatter({ formatterName: "stylish" })
const output = formatter.format(results);
console.log(output);

For more details, see https://textlint.github.io/docs/use-as-modules.html

How to use New CLI

New CLI is opt-in for avoiding Breaking Changes.
It will be default in next major version.

You can try new textlint CLI via textlint-esm command.

- $ textlint "**/*.md"
+ $ textlint-esm "**/*.md"

Or, when TEXTLINT_USE_NEW_CLI=1 is set, textlint use new CLI

$ TEXTLINT_USE_NEW_CLI=1 textlint "**/*.md"

🔥 Welcome to feedback on Discussion: https://github.com/textlint/textlint/discussions/968

fix #868
fix https://github.com/textlint/textlint/issues/744 - new CLI fix this
fix https://github.com/textlint/textlint/issues/103 - new CLI fix this
fix #797 - extends descriptor instead of Config
fix #293 - TextlintCore will be removed in the future

12.2.4 (2022-12-04)

Bug Fixes

• deps: update babel monorepo to ^7.20.2 (4f0364a)
• deps: update dependency @babel/cli to ^7.19.3 (c7124c6)
• textlint: support linting dot files (#947) (8811922) by @kellyselden

This release allow to lint dot file when setting dot file name for extensions.

{
  plugins: {
    '@textlint/text': {
      extensions: ['.lint-todo'],
    },
  }
  rules: {
    'eol-last': true,
  }
};

This version can lint .lint-todo file.

npx textlint .lint-todo

12.2.3 (2022-11-10)

Bug Fixes

• deps: update babel monorepo to ^7.19.1 (6a0dbb8)
• deps: update babel monorepo to ^7.19.3 (e5c80eb)
• deps: update dependency @babel/core to ^7.19.6 (3ba99ea)
• deps: update dependency @babel/preset-env to ^7.19.4 (d1049bd)
• deps: update dependency table to ^6.8.1 (abcb864)
• deps: update dependency traverse to ^0.6.7 (fc0ea91)
• linter-formatter: added lodash to dependencies (#934) (e97efb8)
• types: expose TextlintPluginPreProcessResult/TextlintPluginPostProcessResult type #920 (49d990a)

12.2.2 (2022-09-20)

Bug Fixes

• markdown-to-ast: add mdast-util-gfm-autolink-literal to explicit deps (#904) (d2888a5)

This will fix pnpm issue #903

Dependencies Updates

• deps: update babel monorepo to ^7.18.10 (dc0c555)
• deps: update babel monorepo to ^7.18.6 (d8e30ae)
• deps: update babel monorepo to ^7.18.6 (0f1b0fb)
• deps: update babel monorepo to ^7.18.9 (558b4ee)
• deps: update dependency @babel/core to ^7.18.13 (5c3ac1b)
• deps: update dependency @babel/core to ^7.18.5 (17ab0d4)

12.2.1 (2022-06-25)

What's Changed

• fix(textlint/kernel): improve RuleError error handlong by @azu in https://github.com/textlint/textlint/pull/877

Full Changelog: https://github.com/textlint/textlint/compare/v12.1.0...v12.2.1

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 https://github.com/textlint/textlint/pull/836/commits/c8a670f9b4fd7ce628a940dc4c8faabd5e62d396
• 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)