Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azu/sudachi-synonyms-dictionary
Sudachi's synonyms dictionary
https://github.com/azu/sudachi-synonyms-dictionary
dictionary npm sudachi
Last synced: 5 days ago
JSON representation
Sudachi's synonyms dictionary
- Host: GitHub
- URL: https://github.com/azu/sudachi-synonyms-dictionary
- Owner: azu
- License: apache-2.0
- Created: 2019-11-20T13:52:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-21T01:46:04.000Z (7 months ago)
- Last Synced: 2024-10-29T00:45:09.299Z (9 days ago)
- Topics: dictionary, npm, sudachi
- Language: JavaScript
- Homepage:
- Size: 2.21 MB
- Stars: 12
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sudachi-synonyms-dictionary
Sudachi's synonyms dictionary
It is a npm package for Sudachi's [synonyms dictionary](https://github.com/WorksApplications/SudachiDict/blob/develop/docs/synonyms.md)
- Source:
## Feature
- Work on Browser(ESM) and Node.js(CommonJS)
- Includes `sudachi-synonyms-dictionary.json` file
## Install
Install with [npm](https://www.npmjs.com/):
npm install sudachi-synonyms-dictionary
## Usage
```js
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](https://github.com/azu/sudachi-synonyms-parser).
## Changelog
See [Releases page](https://github.com/azu/sudachi-synonyms-dictionary/releases).
## Release Flow
This repository has semi-automatic release flow:
- [cron-update-dictionary.yml](.github/workflows/cron-update-dictionary.yml): If sudachi's dictionary is updated, submit Pull Request
- [release.yml](.github/workflows/release.yml): If [sudachi-synonyms-dictionary.json](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](https://github.com/azu/sudachi-synonyms-dictionary/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
Apache License, Version 2.0 © azu
This package includes following:
Copyright (c) 2017 Works Applications Co., Ltd.
http://www.apache.org/licenses/LICENSE-2.0
https://github.com/WorksApplications/SudachiDict