textlint/textlint

The pluggable natural language linter for text and markdown.

textlint's Issues

Error is missing

// index.md
もっとです。
もっとする。もっとだ。

$ textlint --plugin textlint-plugin-jtf-style index.md

D:\develop\personal\falsandtru.github.io\index.md
  2:10  error  本文を敬体(ですます調)に統一して下さい。
本文の文体は、敬体(ですます調)あるいは常体(である調)のどちらかで統一します。
"だ。"が常体(である調)です。  jtf-style/1.1.1.本文

✖ 1 problem (1 error, 0 warnings)

should be error:

// index.md
もっとです。
もっとする。もっとだ。もっと。

$ textlint --plugin textlint-plugin-jtf-style index.md

$ textlint --rule textlint-rule-no-mix-dearu-desumasu index.md

Is this correct behavior?

html should show warning message

textlint html support is experimetanl.
it's used and show warning message.

• currently, experimtal
• if you found, please file issue

formatter: separate off formatter

#4 do curve out formatter too!

Reference information
https://github.com/twada/power-assert-formatter

Remove HTML Support from bundle

not default #51

You can use HTML support as a plugin after 5.0.0

npm install textlint-plugin-html

.textlintrc

{
    "plugins": [
        "html"
    ]
}

Definition for rule \'' + key + '\' was not found. on Babel 6 generated rule

Babel 6 kill module.exports = x behavior.

• Kill CommonJS default export behaviour · Issue #2212 · babel/babel

It means that doesn't resolve dynamic require(name).

textlint use dynamic loading for rule and plugin.

We should use interop-require instead of require function.

document: use textlint as node modules.

need document!

A use case is spellcheck-tech-word-textlint-rule

rc-loader alternative?

We want to get an alternative of MoOx/rc-loader.
rc module is fragile, I think.

• for...in
  • https://github.com/dominictarr/rc/blob/d6ac3a3ac1555b25964e963fb949cd1d30b32c0f/lib/utils.js#L24
• rc use shabang
  • it break bundler like webpack.

RangeError: Maximum call stack size exceeded ?

Alternative

• spalger/rcloader

Remove singleton rule-manager

textlint-core.js is not single, but rule-manager.js is a singleton.

var textlint1 = new TextLintCore();
textlint1.setupRule()
// do lint...
var textlint2 = new TextLintCore();
// textlint2 has rules that are defined by textlint1.

That is too bad.

Modulable textlint

texlint is a Node module.
It mean that use of textlint for purpose other than linting.

textlint structure:

I'm creating https://github.com/azu/textstat.
It is not linting tool, but is statistics tool top on the textlint.

Currently, bottleneck object is Config that is not expose public.

Is Config should public?

Add exmples/

We want to add example/ that is actually executable.
These examples are used for testing(so-called example testing).

logo

We need logo and icon for oraganization.#55

Rule: async support

Currently, textlint's rule not support async.

Use case: Allow to create the rule that use REST API like 校正支援Web API.

Add New API on the rule and change lintFile API for support async.

Performance tests

We want to add performance test.

npm run perf

Feature: Rule Options

textlint require options for each rules.

• Documentation - ESLint - Pluggable JavaScript linter

{
    "parser": "esprima",
    "rules": {
        "max-comma": {
            "max-len": 3
        }
    }
}

and

support .textlintrc?

textlint-tester

It is a like eslint/eslint-tester.

Processor Plugin: Custome Parser

We want to support custom parser.

e.g.) textlint can lint .rst file by custom parser.

• custom pre/post process(parse/modified) #36
• custom AST traverse and Syntax => lator
• customize support file extensions #36

These are needed to realize.

show available formatter in help

$ textlint -h
textlint [options] file.md [file.txt] [dir]

Options:
  -h, --help                 Show help.
  -c, --config path::String  Use configuration from this file or sharable config.
  --plugin [String]          Specify plugins
  --rule [path::String]      Set rule package name and set all default rules to off.
  --rulesdir [path::String]  Set rules from this directory and set all default rules to off.
  -f, --format String        Use a specific output format. - default: stylish
                          ===>      Available : XXX
  -v, --version              Outputs the version number.
  --ext [String]             Specify text file extensions.
  --no-color                 Enable color in piped output.
  -o, --output-file path::String  Enable report to be written to a file.
  --quiet                    Report errors only. - default: false
  --stdin                    Lint code provided on <STDIN>. - default: false

Implementation

textlint/packages/textlint/src/options.ts

Line 83 in 37bccdb

description: "Use a specific output format.",

Implementation Options

Which is better?

• textlint -f -h show formatter names?
  • generateHelpForOption(optionName) and longDescription
• textlint -h show formatter names?
  • simple

Blocker

Following Issues need to resolve before try to implement this feature

• #399

Related

• --fix and --formatter limitation #148

4.0

Breaking Change

• Switch to 1-based columns on TextLintMessage #40

The Breaking Change related to textlint module user(use-as-modules.md).

• https://github.com/azu/textlint-tester
• https://github.com/1000ch/linter-textlint
• https://github.com/muraken720/retext-textlint ?

Feature

• TextLintEngine#executeOnText and textlint#lintText support ext arguments. #36
  • use like executeOnText(text, ".md")
• expose TextLintCore #41

Warning insteadof Error

textlint find invalid text and always throw Error.

ESLint has severity options.

    0 - turn the rule off
    1 - turn the rule on as a warning (doesn't affect exit code)
    2 - turn the rule on as an error (exit code is 1 when triggered)

• http://eslint.org/docs/user-guide/configuring#configuring-rules

Currently, textlint fixed severity to Error(2).

• https://github.com/azu/textlint/blob/7e603e6035ab5c74fcf88c2ed3df76e587a62171/src/textlint-core.js#L175

It should be configurable/

bug: didn't reset when start linting each rules

[Deny] RuleContext: `getAncestors()` support

We should support getAncestors() method OR parent property on TxtNode.

Reference:

• estools/estraverse
• https://github.com/eslint/eslint/blob/d9bf89f7717c007ca28256176db9e976d22c599d/lib/eslint.js#L813-L819

accept rule as anónymous function

Current:

var TextLintEngine = require("textlint").TextLintEngine;
var engine = new TextLintEngine({
    rules: ["textlint-rule-spellcheck-tech-word"]
});

var TextLintEngine = require("textlint").TextLintEngine;
var engine = new TextLintEngine({
    rules: [require("textlint-rule-spellcheck-tech-word")]
});

Good?

example: install with -q

Is npm install -q better?

Carve out text and markdown to Processor Plugin

• textlint-plugin-text
• textlint-plugin-markdown
• textlint-plugin-html
• refactor textlint

Enhance document(ES6)

• Write example as ES6
• Add RuleError options
• Add FAQ about "style" linting => recommend https://github.com/wooorm/mdast-lint
• Quick Start Guide
• Usage of preset #96

-o option support

https://github.com/azu/textlint/blob/8c4567f9f7e54acc086d3371a7ed41b028c1ce26/lib/options.js#L65-L68

We have to support output-file option!

Document: Processor Plugin

#32 #37

EventEmitter memory leak detected

When many rule is loaded, occur this warning

(node) warning: possible EventEmitter memory leak detected. 11 Str listeners added. Use emitter.setMaxListeners() to increase limit.
Trace
    at TextlintCore.addListener (events.js:239:17)
    at /Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-core.js:31:16
    at Array.forEach (native)
    at addListenRule (/Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-core.js:30:23)
    at /Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-core.js:80:21
    at Array.forEach (native)
    at TextlintCore.setupRules (/Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-core.js:65:32)
    at TextLintEngine.setupRules (/Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-engine.js:81:22)
    at TextLintEngine.executeOnFiles (/Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/textlint-engine.js:172:18)
    at Object.execute (/Users/azu/.ghq/github.com/azu/JavaScript-Plugin-Architecture/node_modules/textlint/lib/cli.js:75:70)

TypeError: ruleContextAgent.listenerCount is not a function

TypeError: ruleContextAgent.listenerCount is not a function

Node.js 0.x's EventEmitter#listenerCount is not found.

parser: carve out the text parser to a module

is a parts of #4

Maintain eslint config

• maintain eslint config Documentation - ESLint - Pluggable JavaScript linter
• add eslint to test?

Plugin: plguin's rulesConfig doesn't work

Expected: plguin's rulesConfig is set as <plugin>/<rule>.
Actual: plguin's rulesConfig is set as <rule>.

3.0.0

• textlint/markdown-to-ast#3
  • it has contained a little breaking change.
• CHANGELOG

Plugin doesn't work

from 4.5~

4.5.0...4.5.3

Plugin: middleware of RuleContext

Can Plugin wrap RuleContext?

textlint-rule-*をロードするIFが欲しい

Atomのプラグインを作りたいときに、Atomで開かれているディレクトリのnode_modules/textlint-rule-*をtextlintにロードしてあげると、そのプロジェクトのpackage.jsonと.textlintrcに依存関係を完結させることが出来そうなので・・・。

つまり、
https://github.com/azu/textlint/blob/master/lib/textlint-engine.js#L65-L80
あたりをTextLintEngineのインスタンスから実行したいです。

https://github.com/1000ch/linter-textlint/blob/master/index.js#L20-L26

RuleContext: should has config

RuleContext should have Config object.

context.config = config;

config should be read only, but ...

Related #18

Expose TextLintCore

Expose https://github.com/azu/textlint/blob/master/src/textlint-core.js to index.js

textlint rule naming

I good to like that textlint rule naming start with textlint-rule-*.

It is inspired by Babel.

• recommend textlint rule naming textlint-rule-*
• Add --rule <rule name> for CLI
• Set rule by function? separated issue

East Asian Width problem

Some formatter has East Asian Width problem.

textlint -f pretty-error

This issue is come from textlint/textlint-formatter#2

should be more meaningful ReferenceError

ReferenceError: rule: 4.3.8.一重引用符 is not found

to be

ReferenceError: rule: 4.3.8.一重引用符 is not found
Did you mean: jtf-style/4.3.8.一重引用符

Sharable configs

ESLint did http://eslint.org/docs/developer-guide/shareable-configs.html

1. First, --config support sharable config.
   • --config @user/textlint-config
2. Second, extend sharable config by using extend:"config" in .textlintrc ?

ReferenceError: overwrite config of Plugin

from: textlint-ja/textlint-rule-preset-JTF-style#5 (comment)

try to set the following and textlint throw ReferenceError.

{
  "plugins": [
    "jtf-style"
  ],
  "rules": {
    "jtf-style/2.1.2.漢字": {
      "severity" : "warning"
    },
    "jtf-style/4.1.1.句点(。)": false,
    "jtf-style/3.1.1.全角文字と半角文字の間": false
  }
}

Error mesasage:

[ReferenceError: rule: jtf-style/2.1.2.漢字 is not found]

But, following case is safe.(no error)

  "rules": {
    "jtf-style/2.1.2.漢字": true,
    "jtf-style/4.1.1.句点(。)": false,
    "jtf-style/3.1.1.全角文字と半角文字の間": false
  }

It seem bug in textlint. @

textlint/src/textlint-engine.js

Line 150 in 93a70dd

throw new ReferenceError(`rule: ${ ruleName } is not found`);

parser: separate off parser

We use CommonMark now, but maybe switch to wooorm/mdast.

We separate off parser(Markdown and plain text) from textlint to prepare for switching.

Related issue : syntax-tree/mdast#2

Switch to 1-based columns

We recently research column index.

• Why do line of location in JavaScript AST(ESTree) start with 1 and not 0?

ESLint switch column numbers to be 1-based.

Does textlint follow this?

This has a breaking change.

Move to ES6

We'll move ES5 to ES6.

• introduce Babel
• use mohebifar/xto6?

Step

• to ES6 #27
• add example test #26
• refactor textlint.js structure(to class?) #27

Move to Oraganization

move to https://github.com/textlint

• move repositories
  • repositories are related with textlint core.
  • not include rules
• rewrite README and links
• need icon

Duplicated error messages caused by file order

// index.md
もっとです。
もっとする。もっとだ。

// README.md (empty)

$ textlint --plugin textlint-plugin-jtf-style README.md index.md

~\index.md
  10:10  error  本文を敬体(ですます調)に統一して下さい。
本文の文体は、敬体(ですます調)あるいは常体(である調)のどちらかで統一します。
"だ。"が常体(である調)です。  jtf-style/1.1.1.本文

✖ 1 problem (1 error, 0 warnings)


$ textlint --plugin textlint-plugin-jtf-style index.md README.md

~\index.md
  10:10  error  本文を敬体(ですます調)に統一して下さい。
本文の文体は、敬体(ですます調)あるいは常体(である調)のどちらかで統一します。
"だ。"が常体(である調)です。  jtf-style/1.1.1.本文

~\README.md
  10:10  error  本文を敬体(ですます調)に統一して下さい。
本文の文体は、敬体(ですます調)あるいは常体(である調)のどちらかで統一します。
"だ。"が常体(である調)です。  jtf-style/1.1.1.本文

✖ 2 problems (2 errors, 0 warnings)

User Config

We already support Rule Config at #15 .
Next, support User Config.

What is User Config?

There are many types of punctuation in the world.

• Punctuation of English - Wikipedia, the free encyclopedia
• 句読点 - Wikipedia

They define it is like punctuation in User Config.
It is just idea.

Allow to comment in .textlintrc

Related #39

{
    "rules": {
       // a is foo
        "a": true
    }
}