sudachi-synonyms-dictionary

Sudachi's synonyms dictionary

It is a npm package for Sudachi's synonyms dictionary

Source: https://raw.githubusercontent.com/WorksApplications/SudachiDict/develop/src/main/text/synonyms.txt

Feature

Work on Browser(ESM) and Node.js(CommonJS)
Includes sudachi-synonyms-dictionary.json file

Install

Install with npm:

npm install sudachi-synonyms-dictionary

Usage

import { fetchDictionary } from "sudachi-synonyms-dictionary";
(async function () {
    const dict = await fetchDictionary();
    console.log(dict)
/*
[{
    "id": "000001",
    "items": [{
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 1,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "未定義",
        "bunya": [],
        "midashi": "曖昧"
    }, {
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 1,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "アルファベット表記",
        "bunya": [],
        "midashi": "あいまい"
    }, {
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 2,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "未定義",
        "bunya": [],
        "midashi": "不明確"
    }, {
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 3,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "未定義",
        "bunya": [],
        "midashi": "あやふや"
    }, {
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 4,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "未定義",
        "bunya": [],
        "midashi": "不明瞭"
    }, {
        "taigenYogen": "体言",
        "expandControl": 0,
        "vocabularyNumber": 5,
        "gokeiSyubetsu": "代表語",
        "ryakusyou": "代表語形",
        "hyoukiYure": "未定義",
        "bunya": [],
        "midashi": "不確か"
    }]
}, ...]
*/
})();

For more details, see sudachi-synonyms-parser.

Changelog

See Releases page.

Release Flow

This repository has semi-automatic release flow:

cron-update-dictionary.yml: If sudachi's dictionary is updated, submit Pull Request
release.yml: If sudachi-synonyms-dictionary.json is updated, publish new version to npm

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.

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

Author

License

This package includes following:

http://www.apache.org/licenses/LICENSE-2.0 https://github.com/WorksApplications/SudachiDict

sorami/sudachi-synonyms-dictionary