textlint-rule-no-synonyms

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #machine-learning #deep-learning #java #awesome #cli #vue #awesome-list #pytorch #ios #openai

textlint-rule-no-synonyms

(★ 34)

同義語を表記ゆれをチェックするtextlintルール

textlint-rule-no-synonyms Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @textlint-ja/textlint-rule-no-synonyms [![Actions Status](https://github.com/textlint-ja/textlint-rule-no-synonyms/workflows/ci/badge.svg)](https://github.com/textlint-ja/textlint-rule-no-synonyms/actions?query=workflow%3Aci)

文章中の同義語を表記ゆれをチェックするtextlintルールです。

同義語の辞書として[Sudachi 同義語辞書](https://github.com/WorksApplications/SudachiDict/blob/develop/docs/synonyms.md)を利用しています。

**NG**:

1つの文章中に同一語彙の別表記を利用している場合を表記ゆれとしてエラーにします。

```
サーバとサーバーの表記揺れがある。
この雇入と雇入れの違いを見つける。
```

## Install

Install with [npm](https://www.npmjs.com/):

npm install @textlint-ja/textlint-rule-no-synonyms sudachi-synonyms-dictionary

辞書となる[sudachi-synonyms-dictionary](https://github.com/azu/sudachi-synonyms-dictionary)は[peerDependencies](https://npm.github.io/using-pkgs-docs/package-json/types/peerdependencies.html)なので、ルールとは別に辞書ファイルをインストールする必要があります。
ルール間で1つの辞書ファイルを共有するためです。

> Cannot find module 'sudachi-synonyms-dictionary'

上記のエラーが出ている場合は辞書ファイルである`sudachi-synonyms-dictionary`をインストールしてください

npm install sudachi-synonyms-dictionary

## Usage

Via `.textlintrc`(Recommended)

```json
{
    "rules": {
        "@textlint-ja/no-synonyms": true
    }
}
```

Via CLI

```
textlint --rule @textlint-ja/no-synonyms README.md
```

## Options

```ts
{
    /**
     * 許可するワードの配列
     * ワードは完全一致で比較し、一致した場合は無視されます
     * 例) ["ウェブアプリ", "ウェブアプリケーション"]
     */
    allows?: string[];
    /**
     * 使用を許可する見出し語の配列
     * 定義された見出し語以外の同義語をエラーにします
     * 例) ["ユーザー"] // => 「ユーザー」だけ許可し「ユーザ」などはエラーにする
     */
    preferWords?: string[];
    /**
     * 同じ語形の語の中でのアルファベットの表記揺れを許可するかどうか
     * trueの場合はカタカナとアルファベットの表記ゆれを許可します
     * 例) 「ブログ」と「blog」
     * Default: true
     */
    allowAlphabet?: boolean;
    /**
     * 同じ語形の語の中での漢数字と数字の表記ゆれを許可するかどうか
     * trueの場合は漢数字と数字の表記ゆれを許可します
     * 例) 「1」と「一」
     * Default: true
     */
    allowNumber?: boolean;
    /**
     * 語彙素の異なる同義語を許可するかどうか
     * trueの場合は語彙素の異なる同義語を許可します
     * 例) 「ルーム」と「部屋」
     * Default: true
     */
    allowLexeme?: boolean;
}
```

**Example**:

```json
{
    "rules": {
        "@textlint-ja/no-synonyms": {
            "allows": ["ウェブアプリ", "ウェブアプリケーション"],
            "preferWords": ["ユーザー"],
            "allowAlphabet": false,
            "allowNumber": false,
            "allowLexeme": false
        }
    }
}
```

## References

- [Sudachi 同義語辞書](https://github.com/WorksApplications/SudachiDict/blob/develop/docs/synonyms.md)
- [azu/sudachi-synonyms-dictionary: Sudachi's synonyms dictionary](https://github.com/azu/sudachi-synonyms-dictionary)
- [azu/sudachi-synonyms-parser: Sudachi's synonyms dictionary parser](https://github.com/azu/sudachi-synonyms-parser)

## Changelog

See [Releases page](https://github.com/textlint-ja/textlint-rule-no-synonyms/releases).

## Running tests

Install devDependencies and Run `npm test`:

npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/textlint-ja/textlint-rule-no-synonyms/issues).

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

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

textlint-rule-no-synonyms

textlint-rule-no-synonyms Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

textlint-rule-no-synonyms

textlint-rule-no-synonyms Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README