Features

• config: --config @textlint/textlint-config support (a059df7)

See Sharable Configuration for details.

Example : azu/textlint-config-readme: Sharable config for textlint

You can use the config via two step.

npm i -D @azu/textlint-config-readme textlint
$(npm bin)/textlint --config @azu/textlint-config-readme README.md

Features

• core: sort messages by line and column (9b2b400), closes #126

EDIT It is reverted and released 6.1.1.

https://github.com/textlint/textlint/commit/3651f9df61738d1ab49752885138cf436d8675e5
https://github.com/textlint/textlint/commit/106da2f7fa8ae927266df346cbbc89759417c6f7

This change break some test case that has a implementation dependent.

Bug Fixes

• JSDoc: fix jSDoc using jsdoc-to-assert (3082435)
• plugin: fix 3rd party plugin is not working (0fae5bc), closes #180
• config: Config's extensions can include plugin's availableExtensions. (98fb11d)

Fixes

• 3rd party plugins doesn't work #180 #181

e.g.) https://github.com/textlint/textlint-plugin-html

When load a plugin, then textlint take cognizance available extensions like ".html".
But, textlint v6.0.3 could not add the additional extension to engine.availableExtensions.
As as result, alway passed! It is wrong.

Summary of Breaking

@azer has unpublished all his npm module.

• I’ve Just Liberated My Modules — Medium
• npmjs.org tells me that left-pad is not available (404 page) · Issue #4 · azer/left-pad

textlint-formatter depened on his modules.

We have fixed ths issue and patch release.

• textlint is broken · Issue #175 · textlint/textlint

Bug Fixes

• npm: fix installing of textlint (81cb2c4)

Features

• d.t.s: Add TextLintRuleContext to textlint.d.ts (df2cb9d), closes #171
• source-location: improve error message (0b1a792)

Docs

• Document: update rule example(no-todo) #168
• Document: versioning of rule module #167
• Document: add rule example using Paragraph #166
  • https://github.com/textlint/textlint/blob/master/docs/rule-advanced.md
  • textlint-rule-en-max-word-count

TxtNode/TxtAST #170

• Rename TxtSyntax to TxtAST https://github.com/textlint/textlint/blob/master/docs/txtnode.d.ts
• Split TxtNodeto ParentNode(block) and TextNode(inline)
• Define value property to TextNode
• Add Compliance tests tool https://github.com/textlint/textlint-ast-test
• Add note about https://github.com/wooorm/unist
• Add notice for Processor plugin creator

Breaking Change

These changes won't affect user.

• Remove TextLintEngine#setRulesBaseDirectory

Please use

new TextLintEngine({
 rulesBaseDirectory: directory
});

• Remove --experimental flag from --fix

TextLintEngine#fixFiles(files) and TextLintEngine# fixText(text, ext = ".txt") have been removed at 6.0.
It was introduced at 5.5.3: --fix & --experimental support.

After hard refactoring, TextLintEngine was split to TextFixEngine and TextLintEngine.

Please use TextFixEngine instead of above method.

• TextFixEngine#executeOnFiles(files): TextLintFixResult[]
• TextFixEngine#executeOnText(text, evt): TextLintFixResult[]

Features

• Add TextFixEngine(ae6aacc) #146
• Add TextLintCore#setupProcessors (76ad42e) #146
• Add --fix https://github.com/textlint/textlint/releases/tag/5.5.3
• Add --dry-run (9aef49f) #150

--fix

textlint 5.5~ introduces the --fix command line argument to automatically fix some rules.

$ textlint --fix README.md
# fixed by each rule

Lint: textlint README.md

Fix: textlint --fix --dry-run -f diff README.md with dry-run mode

Actually Fix: textlint --fix README.md

📝

Not all rules is fixable.
So, it is difficult that make all rules fixable.

What are rules fixable?

• azu/textlint-rule-prh: textlint rule for prh.
• azu/textlint-rule-preset-JTF-style: JTF日本語標準スタイルガイド for textlint.
• textlint-rule-spellcheck-tech-word
• io-monad/textlint-rule-common-misspellings: textlint rule to check common misspellings
• io-monad/textlint-rule-general-novel-style-ja: textlint rule to follow general style of Japanese novels
• nodaguti/textlint-rule-spellchecker: textlint rule to check spellings with native spellchecker
• nodaguti/textlint-rule-ginger: textlint rule to check your English grammar with Ginger Proofreading

You check textlint/textlint Wiki also.

How to create fixable rule?

ℹ️ Please See Creating fixable rule for detail.

How to test the rule

Please use textlint-tester.

• Release 0.5.1: fixer support · textlint/textlint-tester

Breaking Change(near internal)

• #161

This is beta release of 6.0

Please test it!

npm i -D textlint@beta

Please see textlint 6.0 · Issue #145 · textlint/textlint

Bug Fixes

• config: fix config-initializer test (9935b90)
• fixer: fix lint error (884f502)
• rule-context: the default severity should always be error (02425ea), closes #144

Features

• cli: add --dry-run (9aef49f)
• core: add Core#setupProcessors (76ad42e)
• fixer: --fix to be stable (5134c22)
• fixer: add -f diff formatter (77ddf06)
• fixer: add fixable stylish formatter (bcce3d8)
• fixer: add formatter creator (52edc5f)
• fixer: add textfix-engine ! (ae6aacc)

Reverts

• use constructor name (75330c7)

Bug Fixes

• source-location: fix regression of source-location (6550bf5), closes https://github.com/textlint/textlint/pull/137/files?diff=split#r55196842

Features

• config: add --no-color support (0afdb5a)
• formatter: update textlint-formatter (3e583a7) https://github.com/textlint/textlint-formatter/pull/8

--format stylish and --format pretty-error show _fixable problem_s.

Features

• rule: context.report support index-based postion (7a0c80b), closes #134

If you want to know for detail, please see the documents: https://github.com/textlint/textlint/blob/master/docs/rule.md#ruleerror

Motivation

Previously, textlint's RuleError support line and column.

• textlint/rule.md at master · textlint/textlint

e.g.) It is wrong that column doen't consider line break.

//  surrogate pair 
function stringToArray(value) {
    return value.match(/[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\uD800-\uDFFF]/g) || [];
}

export default function (context) {
    let {Syntax, RuleError, report, getSource} = context;
    return {
        [Syntax.Str](node){
            const text = getSource(node);
            const strArray = stringToArray(text);
            for (let index = 0; index < strArray.length; index++) {
                const item = strArray[index];
                if (/❌/.test(item)) {
                    report(node, new RuleError("Use X insteadof ❌", {
                          column: index
                    }));
                }
            }
        }
    }
}

Input:

string
❌
string

Result of TextLintMessage:

{
   "message": "Use X insteadof ❌",
   "line": 1,
   "column": 7
}

Expected:

{
   "message": "Use X insteadof ❌",
   "line": 2,
   "column": 1
}

5.6.0 allow to write this like

//  surrogate pair 
function stringToArray(value) {
    return value.match(/[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\uD800-\uDFFF]/g) || [];
}

export default function (context) {
    let {Syntax, RuleError, report, getSource} = context;
    return {
        [Syntax.Str](node){
            const text = getSource(node);
            const strArray = stringToArray(text);
            for (let index = 0; index < strArray.length; index++) {
                const item = strArray[index];
                if (/❌/.test(item)) {
                    report(node, new RuleError("Use X insteadof ❌", {
                          index: index // <= index
                    }));
                }
            }
        }
    }
}

)

Performance Improvements

• example: use --cache-min 9999999 (d9035b3)

Bug Fixes

• cli: fix detection of --experimental flag (fe5b4bf)
• cli: fix detection of cli (ee69a6f)

Features(--experimental)

--fix and --experimental support ⚠️

Status: experimental 🚧

You can use automatically fixes feature with experimental flag.

$ textlint --experimental --fix README.md
# fixed by each rule

⚠️ Caution ⚠️

Currently, --fix is unstable(use with --experimental).
It mean that there is a possibility of change in the future.

Not all rules is fixable.
So, it is difficult that make all rules fixable.

🚧 If you found a bug, please file issue 🆘

What are rules fixable?

• azu/textlint-rule-prh: textlint rule for prh.
• azu/textlint-rule-preset-JTF-style: JTF日本語標準スタイルガイド for textlint.
• textlint-rule-spellcheck-tech-word
• io-monad/textlint-rule-common-misspellings: textlint rule to check common misspellings
• io-monad/textlint-rule-general-novel-style-ja: textlint rule to follow general style of Japanese novels

How to create fixable rule?

ℹ️ Please See Creating fixable rule for detail.

How to testing

• Release 0.5.1: fixer support · textlint/textlint-tester

Related Issues

• feature: --fix(fixer) · Issue #124 · textlint/textlint

If you want to improve fixable feature, please comment above the issue.

We don't think that this feature is complete 💭

Error ⚠️

If you see following error

.../node_modules/textlint/lib/textlint-core.js:80
                    throw new Error('Definition for rule \'' + key + '\' was not found.');
                    ^

Error: Definition for rule 'prh' was not found.

You should update textlint to ^5.5.
Some rules like textlint-rule-prh dependent on textlint >= 5.5.

npm install -D textlint@^5.5

• cli: --fix options support (ebc058e)
• cli: add --experimental flag (13b0593)
• example: add fix example (277c253)
• typescript: update textlint.d.ts (065751f)

Bug Fixes

• fixer: fix lint error (7b9fd51)
• test: fix path to file (6cb498d)

Bug Fixes

• fixer: fix to pass options fixer function of rule (79c7565)

Features

• rule-error: RuleError support fix options (8fce575)

Bug Fixes

• task: remove memory leak detected message (52d35b2)
• test: rename text to output (97d277a)

Features

• fixer: add SourceCodeFixer#revertFixes (7006219)
• fixer: initial implementation of fixer (9f5f3a9)

Bug Fixes

• cli: remove memory leak detected warning. (97c6bdc) #33 #132

If you see this warning, please update textlint to 5.4.1.

(node) warning: possible EventEmitter memory leak detected. 11 Str listeners added. Use emitter.setMaxListeners() to increase limit.

Features

• fixer: add SourceCodeFixer#revertFixes (96d1fc1)
• fixer: initial implementation of fixer (d28dfbc)

Features

• add --init option like eslint. #127 by @takahashim

textlint --init create a .textlintrc file in your directory.

$ textlint --init

If you are instersted in improving this, please see --init options: Create .textlintrc file #129

Bug Fixes

• docs: fix linting error (40694d0)
• docs: fix typo (42e3132)