Collection of textlint rule

azu edited this page Jan 1, 2017 · 65 revisions
Clone this wiki locally

A Collection of textlint rule

How to add rule?

You can fill the format and Edit this page!

#### [<rule-name>](<URL>)

Description

Note: ✔ is fixable mark. Some rules are fixable using the --fix command line flag.

Rule List

For global

textlint-rule-no-todo

Check - [ ] TODO text.

textlint-rule-no-start-duplicated-conjunction

This rule check no start with duplicated conjunction.

textlint-rule-prh

This rule is for vvakame/prh check the spell with prh.yml.

textlint-rule-max-number-of-lines

This rule check number of lines > max.

textlint-rule-max-comma

Limit maximum comma(,) count of sentence.

textlint-rule-no-exclamation-question-mark

Disallow exclamation and question mark.

textlint-rule-ng-word

Check NG words. Set Ng words to options.

textlint-rule-sjsj

Check spelling using SJSJ(Simplified JavaScript Jargon). It is joke rule :)

textlint-rule-no-dead-link

Check if all links are available or not.

textlint-rule-editorconfig

Check if all files follow EditorConfig's configurations.

textlint-rule-report-node-types

Report error by node's type for debugging.

textlint-rule-no-empty-section

Check empty section.

textlint-rule-date-weekday-mismatch

textlint rule that found mismatch between date and weekday.

For English

textlint-rule-unexpanded-acronym

Check use of unexpanded acronym.

textlint-rule-rousseau

Check english sentence using rousseau.

textlint-rule-alex

Alex helps you find gender favouring, polarising, race related, religion inconsiderate, or other unequal phrasing.

textlint-rule-common-misspellings

Check common misspellings from Wikipedia: Lists of common misspellings.

textlint-rule-ginger

Proofreading with Ginger Proof Reader. It checks misspellings and grammatical errors.

textlint-rule-spellchecker

Check spellings with native spellchecker, i.e. NSSpellChecker, Hunspell, or the Windows 8 Spell Check API, depending on your platform.

textlint-rule-write-good

Proofreading with btford/write-good. "write good" is a "naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too."

textlint-rule-en-max-word-count

textlint rule that specify the maximum word count of a sentence.

It is a example of Advanced: Paragraph rule in textlint's documents.

For Japanese

textlint-rule-max-ten

Specify the maximum (ten) can be used in a sentence. (一文に利用できるの数をチェックするルール)

textlint-rule-max-kanji-continuous-len

漢字が連続できる最大文字数を制限するルール

textlint-rule-spellcheck-tech-word

JavaScript関連の用語を辞書を元にチェックする日本語向けのルールです。

textlint-rule-web-plus-db

inao/WEB+DB PRESS用語統一ルールを元に表記揺れをチェックするルール。

textlint-rule-no-mix-dearu-desumasu

JapaneseStyle rule that reports errors if the input file contains both “dearu” and “desu-masu” style. (「ですます」調と「である」調の混在をチェックするルール)

textlint-rule-no-doubled-joshi

文中に同じ助詞が複数出てくるのをチェックするtextlintルール

textlint-rule-no-double-negative-ja

二重否定をチェックするルール

textlint-rule-no-hankaku-kana

半角カタカナの使用を禁止するルール

textlint-rule-no-nfd

UTF8-MAC 濁点として知られるPDFからコピペなどで起きる濁点を見つけて修正するルール

textlint-rule-ja-no-weak-phrase

"〜かもしれない" のような弱い表現の利用を禁止するルール

textlint-rule-ja-no-redundant-expression

冗長な表現を禁止するルール

textlint-rule-ja-no-abusage

よくある日本語の誤用をチェックするルール

textlint-rule-sentence-length

センテンスの文字数をチェックするルール

textlint-rule-first-sentence-length

セクションの最初のセンテンスの文字数をチェックするルール

textlint-rule-no-dropping-the-ra

ら抜き言葉か使われてないかをチェックするルール

textlint-rule-no-doubled-conjunctive-particle-ga

逆接の接続助詞「が」は、特に否定の意味ではなくても安易に使われてしまいがちです。これが同一文中に複数回出現していないかどうかをチェックするためのtextlintルールです。

textlint-rule-no-doubled-conjunction

同じ接続詞が連続して出現していないかどうかをチェックするためのtextlintルールです。

textlint-rule-ja-no-mixed-period

文末の句点記号(。)の統一 と 抜けをチェックするtextlintルールです。

textlint-rule-ja-yahoo-kousei

Yahooの校正APIを叩くtextlintのルール

textlint-rule-max-appearence-count-of-words

段落内の単語の出現回数をチェックします。内部的にはkuromoji.jsを使用しています。

textlint-rule-max-length-of-title

タイトルの文字数をチェック

textlint-rule-incremental-headers

次の3つの規則を検査します。

  • ページの始まりの見出しは#(h1)から始まる。
  • ページの始まり以外の見出しで#(h1)が使われていない。(##, ###,...を利用する。)
  • 見出しの深さ(h1, h2, h3など)は必ず1つずつ増加する。(h1, h3のように急に深くならない)

textlint-rule-general-novel-style-ja

日本の小説における一般的な作法に従うための textlint ルールです。以下のような作法をサポートしています。

  • 各段落の先頭に全角スペースまたは開き括弧のみを許可
  • 閉じ括弧の手前に句読点(。、)を置かない
  • 疑問符(?)と感嘆符(!)の直後にスペースを置く
  • 連続した三点リーダー(…)の数は偶数にする
  • 連続したダッシュ(―)の数は偶数にする
  • 連続した句読点(。、)を許可しない
  • 連続した中黒(・)を許可しない
  • 連続した長音符(ー)を許可しない
  • マイナス記号(−)は数字の前にしか許可しない
  • アラビア数字は最大桁数までしか許可しない

Preset List

English

Welcome to write!

Japanese

textlint-rule-preset-ja-technical-writing

技術文書向けのtextlintルールプリセット

textlint-rule-preset-JTF-style

JTF日本語標準スタイルガイド(翻訳用)に従ったルールでチェックできるプリセット。

textlint-rule-spacing

半角/全角スペースについてのルールプリセット。 次のようなルールがまとめられたもので、それぞれのルールを個別にインストールすることもできます。

  • 半角文字と全角文字の間のスペースの有無
  • インラインコードの周りにスペースの有無
  • 全角文字同士の間のスペースの有無
  • カタカナ語間の区切り文字
  • かっこの外側、内側のスペースの有無
  • 感嘆符後のスペースの有無
  • 疑問符後のスペースの有無

textlint-rule-preset-japanese

入門向け日本語のプリセット

Filter rule

textlint-filter-rule-whitelist

Filter any word by white list.

textlint-filter-rule-comments

Filter error using comments directive.

<!-- textlint-disable -->

This is ignored text by rule.
Disables all rules between comments

<!-- textlint-enable -->

textlint-filter-rule-node-types

Filter error by node type.

Processor Plugin List

textlint-plugin-html

Add HTML support

textlint-plugin-review

Add Re:VIEW support

textlint-plugin-rst

Add reStructuredText(*.rst) support

textlint-plugin-asciidoc-loose

Add AsciiDoc/Asciidoctor loose support.

textlint-plugin-satsuki

Add Satsuki notation support

Rule Helper

Help to create rule.

Enviroments

textlint/create-textlint-rule

Scaffolding command line tool. It create textlint rule project with no configuration. It is similar with create-react-app.

textlint/textlint-scripts

textlint npm-run-scripts CLI help to create textlint rule. It contains build and test scripts.

Global

textlint-rule-helper

This util provide RuleHelper and IgnoreNodeManger. These help you to avoid unexpected result reported by rule.

textlint-util-to-string

The util convert Paragraph Node to text with SourceMap.

sentence-splitter

split {japanese, english} text into sentences.

select-section

create section from document node.

Constellation/structured-source

Provides StructuredSource and functionality for converting range and loc vice versa.

Unist node utilties

Unist is Universal Syntax Tree. TxtAST interface of textlint have a minimum of compatibility for unist.

Maybe, Unist node utilties can used in textlint's rule.

unist-util-map

Create a new Unist tree with all nodes that mapped by the provided function.

For Japanese

kuromoji.js

JavaScript implementation of Japanese morphological analyzer.(形態素解析器)

kuromojin

Provide a high level wrapper for kuromoji.js.

  • Promise API
  • Cache System

morpheme-match

kuromojinのtoken同士を比較して、 形態素解析結果を元にしたtoken辞書による比較を行うライブラリです。 Websiteで形態素解析結果をリアルタイムに見ることができます。

morpheme-match-all

A wrapper of morpheme-match API. Match all kuromoji's tokens. kuromojinのtoken同士を比較して、 形態素解析結果を元にしたtoken辞書による比較を行うライブラリです。

azu/analyze-desumasu-dearu

文の敬体(ですます調)、常体(である調)を解析するライブラリ

sorted-joyo-kanji

常用漢字一覧