Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/textlint-ja/textlint-rule-no-doubled-joshi

文中に同じ助詞が複数出てくるのをチェックするtextlintルール
https://github.com/textlint-ja/textlint-rule-no-doubled-joshi

rule textlint textlintrule

Last synced: 12 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/textlint-ja/textlint-rule-no-doubled-joshi
Owner: textlint-ja
License: mit
Created: 2015-11-12T12:50:27.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-06-21T15:26:30.000Z (5 months ago)
Last Synced: 2024-10-02T06:28:43.168Z (about 2 months ago)
Topics: rule, textlint, textlintrule
Language: TypeScript
Homepage:
Size: 728 KB
Stars: 22
Watchers: 3
Forks: 4
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# textlint-rule-no-doubled-joshi [![Actions Status: test](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi/workflows/test/badge.svg)](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi/actions?query=workflow%3A"test")

1つの文中に同じ助詞が連続して出てくるのをチェックする[textlint](https://github.com/textlint/textlint)ルールです。

文中で同じ助詞が連続すると文章が読みにくくなります。

例) **で**という助詞が連続している

> 材料不足で代替素材で製品を作った。

**で** という助詞が1つの文中に連続して書かれていため、次のようなエラーが報告されます。

```
一文に二回以上利用されている助詞 "で" がみつかりました。

次の助詞が連続しているため、文を読みにくくしています。

- 不足"で"
- 素材"で"

同じ助詞を連続して利用しない、文の中で順番を入れ替える、文を分割するなどを検討してください。
```

**OK**:

```
私は彼が好きだ
オブジェクトを返す関数を公開した
これがiPhone，これがAndroidです。
言うのは簡単の法則。
```

**NG**:

```
私は彼は好きだ
材料不足で代替素材で製品を作った。
列車事故でバスで振り替え輸送を行った。
法律案は十三日の衆議院本会議で賛成多数で可決され、参議院に送付されます
これは`obj.method`は何をしているかを示します。
これとあれとそれを持ってきて。
```

## Installation

npm install textlint-rule-no-doubled-joshi

## Usage

Via `.textlintrc`(推奨)

```json5
{
"rules": {
"no-doubled-joshi": true
}
}
```

Via CLI

```
textlint --rule no-doubled-joshi README.md
```

### Options

`.textlintrc` options.

```json5
{
"rules": {
"no-doubled-joshi": {
// 助詞のtoken同士の間隔値が1以下ならエラーにする
// 間隔値は1から開始されます
"min_interval" : 1,
// 例外を許可するかどうか
"strict": false,
// 助詞のうち「も」「や」は複数回の出現を許す
"allow": ["も","や"],
// 文の区切り文字となる配列
"separatorCharacters": [
".", // period
"．", // (ja) 全角period
"。", // (ja) 句点
"?", // question mark
"!", // exclamation mark
"？", // (ja) 全角 question mark
"！" // (ja) 全角 exclamation mark
],
"commaCharacters": [
"、",
"，" // 全角カンマ
]
}
}
}
```

- `min_interval`: 助詞の最低間隔値
- Default: `1`
- 指定した`min_interval`以内にある同じ助詞は連続しているとみなされます
- 指定した間隔値以下で同じ助詞が出現した場合エラーが出力されます
- ⚠️ あまり変更を想定してないので、変更した場合は意図通りに動かない場合があります
- `strict`: 厳しくチェックするかどうか
- Default: `false`
- 下記参照。例外として許容しているものもエラーとするかどうか
- `true`にすると誤検知が発生しやすくなります
- `allow`: 複数回の出現を許す助詞
- Default: `[]`
- 並立の助詞など、複数回出現しても無視する助詞を指定します
- 例) `"も"`を許可したい場合は `{ "allow": ["も"] }`
- `separatorCharacters`: 文の区切り文字の配列
- Default: `[".", "．", "。", "?", "!", "？", "！"]`
- `separatorCharacters`を設定するとデフォルト値は上書きされます
- `。`のみを文の区切り文字にしたい場合は。`{ "separatorCharacters" : ["。"] }`のように指定します
- `commaCharacters`: 句点となる文字の配列
- Default: `["、", "，"]`
- 読点として認識する文字の配列を指定します
- 読点は間隔値を+1する効果があります

## 対応方法

修正方法としては、次のようなものがあります。

- 助詞の書き間違いなので、別の助詞に置き換える
- 例) `私は彼は好きだ` → `私は彼が好きだ`
- 複数のことを1つの文で書いている可能性があるため、助詞が連続している文を分割する
- 1文でまとめようとして、無理やり助詞で文を繋いでいる可能性があります
- 文自体を分けることで、同じ助詞が連続していることがなくなります
- 例) https://github.com/asciidwango/js-primer/pull/1598#discussion_r1110939474
- 助詞で無理やり文を繋げている可能性があるので、文の中で順番を入れ替える
- 助詞で文の中身を無理やり繋げようとしていて、使える助詞の選択肢が狭くなっている可能性があります
- 文の流れを箇条書きなどにして整理してみてください
- 例) https://github.com/asciidwango/js-primer/pull/1594#discussion_r1110973573
- 助詞が不要なら削除して、文を簡潔にする
- "実際に" などのように強調的な言葉を削除することで、助詞が不要になる可能性があります
- 技術文書では簡潔な文章を心がけることが多いため、強調的な単語自体を削除することもあります
- 日本語としても意味が通り、一般的な用法なのにエラーとなった
- ルールの実装に問題がある可能性があります
- 例文とともに[Issue](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi/issues/new)を作成してください

また、`allow`オプションで、特定の助詞が連続して出てくることを許可できます。

文自体を直す余地がない場合は、コメントなどを使ってエラーを無視してください。

- [Ignoring Text · textlint](https://textlint.github.io/docs/ignore.html)

## 判定処理

ある助詞(かつ品詞細分類)が、最低間隔値(距離)以内に連続して書かれている場合をエラーとして検出します

> 材料不足で代替素材で製品を作った。

この文中の助詞 `で` 同士の間隔値は `1` となります。
デフォルトの最低間隔値(`min_interval`)は`1`となるなるため、このケースはエラーとして判定されます。

> これはペンです。これは鉛筆です。

この文は句点(`。`)によって2つの文として認識されます。
そのため、それぞれの文中での助詞`は`は1度のみの出現となりエラーとはなりません。

句点となる文字列は `separatorCharacters` オプションで指定できます。

このルールが助詞として認識するものは、次のサイトで確認できます。

- [kuromoji.js demo](https://takuyaa.github.io/kuromoji.js/demo/tokenize.html "kuromoji.js demo")

### 読点での区切り

> これがiPhone、これがAndroidです。

読点文字（`、`）が助詞の間にある場合、間隔値は+1されます。
そのため、助詞`が`の間隔値は`2`となりデフォルトではエラーとなりません。

読点文字は `commaCharacters` オプションで指定できます。

### カッコでの区切り

> 次のescapeHTML関数**は**タグ関数です（詳細**は**文字列の章を参照）

括弧（`(`や`)`）が助詞の間にある場合、間隔値は+1されます。
そのため、この例の助詞`は`の間隔値は`2`となりデフォルトではエラーとなりません。

括弧記号はkuromoji.jsで定義されている記号を元に判定しています。

## 例外

以下の項目については、曖昧性があるため助詞が連続していてもデフォルトではエラーとして扱いません。

設定が `{ strict: true }` ならばエラーとして報告されますが、デフォルトでは`{ strict: false }` となっているのでエラーとして報告されません。

### 助詞:連体化 "の"

"の" の重なりは例外として許可します。

- [第８回：読みやすさへの工夫 3（てにおは助詞） - たくみの匠](http://www.asca-co.com/takumi/2010/07/3.html "第８回：読みやすさへの工夫 3（てにおは助詞） - たくみの匠")
- [作文入門](http://www.slideshare.net/takahi-i/ss-13429892 "作文入門")
- "の" の消し方について

### 助詞:格助詞 "を"

> オブジェクトを返す関数を公開する

"を" の重なりは例外として許可します。

### 接続助詞:"て"

> 試し**て**いただい**て**

接続助詞 "て" の重なりは例外として許可します。

### 並立助詞

> 登っ**たり**降り**たり**する

並立助詞(**たり**)が連続するのは、意図した助詞の使い方であるため許可します。

### 〜かどうか

> これにする**か**どう**か**検討する

助詞(**か**)が連続していますが、"〜かどうか"の表現は一般的であるため許可します。

📝 次のように書き換えることで、助詞が連続していない形にできます。

> これにするかを検討する

- Issue: [質問：～かどうか、について · Issue #62 · textlint-ja/textlint-rule-no-doubled-joshi](https://github.com/textlint-ja/textlint-rule-no-doubled-joshi/issues/62)
- [文節中の「か」の用法](https://jumonji-u.repo.nii.ac.jp/record/700/files/22-1.pdf)
- [かどうか／疑問詞･･･か](https://www.jpf.go.jp/j/urawa/j_rsorcs/textbook/setsumei_pdf/setsumei16_2.pdf)

### 連語(助詞)

- [連語（助詞） - 修飾語 - 品詞の分類 - Weblio 辞書](http://www.weblio.jp/parts-of-speech/%E9%80%A3%E8%AA%9E(%E5%8A%A9%E8%A9%9E)_1 "連語（助詞） - 修飾語 - 品詞の分類 - Weblio 辞書")

連語は一つの助詞の塊として認識します。

```
OK: 文字列の長さを正確**に**測る**には**ある程度の妥協が必要になります。
NG: 文字列**には**そこ**には***問題がある。
```

### その他の助詞

その他の助詞も例外として扱いたい場合は `allow` オプションを利用します。

デフォルトでは次の文はエラーとなる。

> 太字**も**強調**も**同じように無視されます。

オプションで`"allow": ["も"]`を指定することで、**も**を例として扱うことができます。

```json5
{
"rules": {
"no-doubled-joshi": {
// 助詞のうち「も」は複数回の出現を許す
"allow": ["も"]
}
}
}
```

## Tests

npm test

## Reference

- [Doubled Joshi Validator · Issue #460 · redpen-cc/redpen](https://github.com/redpen-cc/redpen/issues/460 "Doubled Joshi Validator · Issue #460 · redpen-cc/redpen")
- [事象の構造から見る二重デ格構文の発生 ](https://www.ninjal.ac.jp/event/specialists/project-meeting/files/JCLWorkshop_no6_papers/JCLWorkshop_No6_01.pdf "JCLWorkshop_No6_01.pdf")
- [第８回：読みやすさへの工夫 3（てにおは助詞） - たくみの匠](http://www.asca-co.com/takumi/2010/07/3.html "第８回：読みやすさへの工夫 3（てにおは助詞） - たくみの匠")
- [(Microsoft Word - JCLWorkshop2013_2\214\303\213{.doc) - JCLWorkshop_No3_02.pdf](https://www.ninjal.ac.jp/event/specialists/project-meeting/files/JCLWorkshop_no3_papers/JCLWorkshop_No3_02.pdf "(Microsoft Word - JCLWorkshop2013_2\214\303\213{.doc) - JCLWorkshop_No3_02.pdf")
- [助詞の連続使用を避け分かりやすい文章を書こう！ - 有限な時間の果てに](http://popoon.hatenablog.com/entry/2014/07/11/232057 "助詞の連続使用を避け分かりやすい文章を書こう！ - 有限な時間の果てに")
- [作文入門](http://www.slideshare.net/takahi-i/ss-13429892 "作文入門")
- [形態素解析ツールの品詞体系](http://www.unixuser.org/~euske/doc/postag/index.html#chasen "形態素解析ツールの品詞体系")
- [Redpenの実装](https://github.com/redpen-cc/redpen/issues/460 "Doubled Joshi Validator · Issue #460 · redpen-cc/redpen")

## Related Libraries

- [azu/kuromojin](https://github.com/azu/kuromojin) a wrapper of [kuromoji.js](https://github.com/takuyaa/kuromoji.js "kuromoji.js")
- [azu/sentence-splitter](https://github.com/azu/sentence-splitter)

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License

MIT