Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
azu committed Jan 1, 2024
1 parent 8e3c5e6 commit f51a0cf
Showing 1 changed file with 10 additions and 24 deletions.
34 changes: 10 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,50 +40,36 @@ textlint --rule no-mix-dearu-desumasu README.md
- 見出し(Header)
- 箇条書き(List)

デフォルトは ""()で、多く使われている表記を自動的に優先します。
デフォルトは ""(空文字)で、多く使われている表記を自動的に優先します。
優先したい表記を "である" または "ですます" で指定します。

```js
```json5
{
"rules": {
"no-mix-dearu-desumasu": {
"preferInHeader": "", // "である" or "ですます"
"preferInBody": "ですます",// "である" or "ですます"
"preferInList": "である", // "である" or "ですます"
"preferInList": "である", // "である" or "ですます"
// 文末以外でも、敬体(ですます調)と常体(である調)を厳しくチェックするかどうか
"strict": false
}
}
}
```

例えば、以下の例だと
この設定は、次のような意味となります。

- 見出しは自動
- 本文はですます
- 箇条書きはである
- 見出しは自動的に判定(混在のみのチェック)
- 本文は"ですます"を優先
- 箇条書きは"である"を優先

かつ `strict`モードでチェックします。

```js
{
"rules": {
"no-mix-dearu-desumasu": {
"preferInHeader": "", // "である" or "ですます"
"preferInBody": "ですます",// "である" or "ですます"
"preferInList": "である", // "である" or "ですます"
// 文末以外でも、敬体(ですます調)と常体(である調)を厳しくチェックするかどうか
"strict": true
}
}
}
```
### その他のOption

- `strict`
- default: `false`
- 文末以外でも、敬体(ですます調)と常体(である調)を厳しくチェックするかどうか

例えば`strict:false`(デフォルト)では以下のような **"であったが"** という接続的な"である"は無視されます。
たとえば`strict:false`(デフォルト)では次のような **"であったが"** という接続的な"である"は無視されます。
次の例では **"であったが"** は無視されているため、"です"のみが使われているという判定になります。

> OK: 昨日はいい天気であったが、今日は雨です。
Expand Down Expand Up @@ -138,7 +124,7 @@ A. 本文、見出し、箇条書き をそれぞれ別々にカウントしま

### Q. なぜデフォルトでは文末のみの検出なのですか?

A. 自然言語に絶対の表現がないためデフォルトを緩くするためです
A. `strict: true`は誤検知の可能性があるので、デフォルトの判定を緩くするためです

textlintでは多くのルールはfalse positiveにならないように、デフォルトを緩く設定しています。
厳しく(接続的な"である"なども)検出したい場合は、{ "strict": true } オプションが利用できます。
Expand Down

0 comments on commit f51a0cf

Please sign in to comment.