From 7e2879f66ea4bf15f324f79a713542bfaeaf0012 Mon Sep 17 00:00:00 2001 From: io-monad Date: Sat, 27 Feb 2016 00:28:06 +0900 Subject: [PATCH] Add examples to README --- README.md | 118 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) diff --git a/README.md b/README.md index 70a75bc..9d1d7a6 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,124 @@ $ npm install textlint textlint-rule-max-ten $ textlint --rule general-novel-style-ja README.md +## 適用される作法 + +いずれも、設定によって無効化する事ができます。 + +### 各段落の先頭に全角スペースまたは開き括弧のみを許可 + +``` +　これは日本語の文章です。 +この行は行頭に全角スペースがありません。 +　だからエラーになってしまいます。 +「会話文は問題ありません」 +``` + +``` +2:1 error 段落の先頭に許可されていない文字が存在しています +``` + +行頭に許可される開き括弧は `「『【〈《（(“"‘'［[〔｛{＜<` のいずれかです。 + +許可される文字は `chars_leading_paragraph` 設定で変える事ができます。 + +### 閉じ括弧の手前に句読点(。、)を置かない + +``` +「こんにちは、世界。」 +「世界に、こんにちは、」 +``` + +``` +1:1 error 句読点(。、)が閉じ括弧の直前に存在しています +2:1 error 句読点(。、)が閉じ括弧の直前に存在しています +``` + +### 疑問符(？)と感嘆符(！)の直後にスペースを置く + +``` +「こんにちは！世界」 +「こんにちは？世界」 +「スペースを一文字入れれば！　大丈夫」 +「閉じ括弧の前でも大丈夫！」 +「ビックリハテナ！？」 +``` + +``` +1:1 error 感嘆符(！)・疑問符(？)の直後にスペースか閉じ括弧が必要です +2:1 error 感嘆符(！)・疑問符(？)の直後にスペースか閉じ括弧が必要です +``` + +### 連続した三点リーダー(…)の数は偶数にする + +``` +「………なん…だと…」 +「……偶数個なら……大丈夫…………」 +``` + +``` +1:1 error 連続した三点リーダー(…)の数が偶数ではありません +``` + +### 連続したダッシュ(―)の数は偶数にする + +``` +「一体いつから―――奇数個でも大丈夫だと錯覚していた――？」 +「偶数個なら――――大丈夫」 +``` + +``` +1:1 error 連続したダッシュ(―)の数が偶数ではありません +``` + +### 連続した中黒(・)を許可しない + +``` +「ちゃんと・・・三点リーダーを・・・使おう」 +「単語の・区切りなら・大丈夫」 +``` + +``` +1:1 error 連続した中黒(・)が使われています +``` + +### 連続した長音符(ー)を許可しない + +``` +「長音符はーーーーダッシュじゃない」 +「伸ばすだけならー大丈夫ー」 +``` + +``` +1:1 error 連続した長音符(ー)が使われています +``` + +### マイナス記号(−)は数字の前にしか許可しない + +``` +「マイナス記号も−−−−ダッシュじゃない」 +「数字の前なら３−２＝１大丈夫」 +``` + +``` +1:1 error マイナス記号(−)の直後が数字ではありません +``` + +### アラビア数字は最大桁数までしか許可しない + +``` +「２０１６年、長いアラビア数字は禁止された」 +「半角の2016年でもダメ」 +「２桁までなら大丈夫。５０、８０、よろこんで」 +``` + +``` +1:1 error 2桁を超えるアラビア数字が使われています +2:1 error 2桁を超えるアラビア数字が使われています +``` + +最大桁数は `max_arabic_numeral_digits` 設定で変更できます。 + ## 設定 `.textlintrc` に設定を記述します。詳しくは textlint のドキュメントを参照してください。