textlint

Bug Fixes

• bin: not use Arrow Function (f69ae96)

Performance Improvements

• test: use yarn for testing example (#242) (4d23836)

Bug Fixes

• use is-file insteadof exists-sync (d15ff60)

Bug Fixes

• d.ts: export as a class (f757b4b)
• fixer: fix to work commands that accept Node (ed1d52b), closes #229
• jsdoc: fix invalid JSDoc (aca3148)

Features

• cli: --init fill with installed rules (3948147), closes #129

Bug Fixes

• engine: implement toJSON to own Map (7e95966) related: https://github.com/textlint/textlint/issues/231
• rue-creator-set: fix unexpected filter rules (a2988b5)

Bug Fixes

• core: remove --experimental flag of shouldIgnore() (b1e2a17)

Features

Filter rule 🆕

• "filter rule" support #216 #207

Filter rule provide filtering error that is reported by linting rule.

For example, textlint-filter-rule-comments provide filtering function by using comments.

<!-- textlint-disable -->

Disables all rules between comments

<!-- textlint-enable -->`

Allow to short textlint-filter-rule-comments to comments.

Add filter rule name to filters field.

{
  "filters": {
    "comments": true
  }
}

One more example, very-nice-rule is useful, but you want to ignore some reported error in your text.
very-nice-rule also check the BlockQuote text, but you want to ignore the BlockQuote text.
textlint-filter-rule-node-types rule resolve the issue.

{
  "filters": {
    "node-types": {
      "nodeTypes": ["BlockQuote"]
    }
  },
  "rules": {
    "very-nice-rule": true
  }
}

Sharable Config 🆕

• 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

Breaking Change ⚠️

textlint 7.0 has some breaking change.
It will not affect textlint user, but affect to textlint rule developer.

Ignore duplicated messages by default #209

Duplicated messages is ignored by default.

Duplicated messages is that have same range and same message.
(Not depended on ruleId. ruleId is flexible property)

Sort messages by line and column #218

textlint 7.0 sort message by line and column.
The rule that depended on the order of messages may fail test.

Drop Node.js 0.12 support #215

textlint 7.0 not support Node.js 0.12. (But still it work)
Requirement: Node.js 4.0.0 >=

This is beta release

Please try it :)

npm install textlint@beta

Features

Filter rule

• "filter rule" support #216 #207

Filter rule provide filtering error that is reported by linting rule.

For example, textlint-filter-rule-comments provide filtering function by using comments.

<!-- textlint-disable -->

Disables all rules between comments

<!-- textlint-enable -->`

Allow to short textlint-filter-rule-comments to comments.

Add filter rule name to filters field.

{
  "filters": {
    "comments": true
  }
}

One more example, very-nice-rule is useful, but you want to ignore some reported error in your text.
very-nice-rule also check the BlockQuote text, but you want to ignore the BlockQuote text.
textlint-filter-rule-node-types rule resolve the issue.

{
  "filters": {
    "node-types": {
      "nodeTypes": ["BlockQuote"]
    }
  },
  "rules": {
    "very-nice-rule": true
  }
}

Sharable Config

• 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

Breaking Change

textlint 7.0 has some breaking change.
It will not affect textlint user, but affect to textlint rule developer.

Ignore duplicated messages by default #209

Duplicated messages is ignored by default.

Duplicated messages is that have same range and same message.
(Not depended on ruleId. ruleId is flexible property)

Sort messages by line and column #218

textlint 7.0 sort message by line and column.
The rule that depended on the order of messages may fail test.

Drop Node.js 0.12 support #215

textlint 7.0 not support Node.js 0.12. (But still it work)
Requirement: Node.js 4.0.0 >=

Documents

• Create AST explorer for textlint (#223)

AST explorer for textlint is useful for understanding AST.

• Add filter rules document #221

Features

• debug: add debug log to task (c05a7b3)

Try to run DEBUG=textlint* textlint README

Features

• Don't load duplicated rule with ruleConfig Issue #219

See https://github.com/textlint/textlint/blob/master/docs/rule.md#implementation-node-memo for details.

• RuleCreatorSet: add #withoutDuplicated()(812b13e)
• task: use ruleCreatorSet#withoutDuplicated() for filtering duplicated rule(261d90f)

--experimental Features

These features are experimental

You can use it with --experimental flag

$ textlint --experimental

• filter: add filter-duplicated-process (#217)(bb87855)

Duplicated messages is ignored by default.
Duplicated messages is that have same position information(index) and same message.

• filter: re-enable sort messages by line and column (#218)(385a82c)

semi-Breaking change

Proposal #212 and implement #214

Support "filters" field and Drop support "ignoring-rule"
These are experimental feature. 🚧

See filter rule document for details.

{
   "filters": {
      "node-types": {
        "nodeTypes": ["BlockQuote"]
      }
   },
   "rules": {}
}

• Replace "ignoring rule" with "filter rule"
• Add "filters" filed support to textlint core
  • Same convention with "rules" field
• Rename textlint-rule-ignore-node-types to textlint-filter-rule-node-types.
• Filter rule use shouldIgnore(range, { ruleId }) API
  • https://github.com/textlint/textlint/blob/master/docs/rule.md
• textlint not allow (normal) rule to use shouldIgnore.

Features

internal

• Added MessageProcessManager.
• This manager process TextLintMessages.
• Main usecase filter messages.

Features

• ignore: add { ruleId } option object to shouldIgnore (#208) (de0ff6f)

When the ruleId of option object is matched ruleId of error message, filter only the message,
Default is filter all message in the ignoring range.

UseCase

https://github.com/textlint/textlint-rule-ignore-comment

<!-- textlint-disable ruleA -->

this is wrong

<!-- textlint-enable -->

Disable specific rule on the fly.

Breaking Change(experimental)

shouldIgnore(range) only ignore messages of the ruleId.

It means that shouldIgnore(range) === shouldIgnore(range, { ruleId : this.id }).
It attempt to make safe by default.

"*" is danger because "*" affect to other rules.

Features

• node: add "Comment" type (#205) (640f84d), closes #204

Performance Improvements

• test: run example tests by foreman (#206) (cc9e489)

Features

• change shouldIgnore(range) API #203

Previously, ignoring api is shouldIgnore(<node>). #194

But, I think that shouldIgnore([start, end]) is better.
Because, ignoring rule is not always depended on .
It always depended on <range> which is like [number, number].

This change is breaking change, but ignoring feature is experimental support.
As as result, we have published as minor version.

Fix: #202
Refs: #193

Bug Fixes

• npm: fix "files" fileld (264c867)

Features

• index: export TextLintNodeType as TextLintNodeType (f6c1e61)

You can use this TextLintNodeType value by the following way:

import {TextLintNodeType} from "textlint";
console.log(TextLintNodeType.Str); // "Str"

Please see https://github.com/textlint/textlint/blob/master/docs/txtnode.md

Features

• Ignore rule support (#194)(da8c259)
• index: expose Constants Types (#198)(0941cb5)

Ignore rule is experimental. It used with --experimental.

Please see https://github.com/textlint/textlint/blob/master/docs/rule.md

• context.shouldIgnore(node) 🆕

Features

• core: add fileName to trailing of error message (bd1f454), closes #165

Show where the error is occurring.

When throw error in the rule.

module.exports = function (context) {
    var exports = {};
    exports[context.Syntax.Str + ":exit"] = function () {
        throw new Error("Error in rule");
    };
    return exports;
};

Before:

Error in rule

After:

Error in rule at ~/textlint/textlint/test/rule-context/fixtures/test.md

• core: always start asynchronous (3ef2a62), closes #178