Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heppokofrontend/dictionary-file-maker
Build to class platform-compatible dictionary data text file.
https://github.com/heppokofrontend/dictionary-file-maker
cli dictionaries dictionary
Last synced: 8 days ago
JSON representation
Build to class platform-compatible dictionary data text file.
- Host: GitHub
- URL: https://github.com/heppokofrontend/dictionary-file-maker
- Owner: heppokofrontend
- Created: 2021-12-10T02:14:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-11T13:58:49.000Z (about 2 years ago)
- Last Synced: 2024-09-15T19:38:25.179Z (2 months ago)
- Topics: cli, dictionaries, dictionary
- Language: TypeScript
- Homepage:
- Size: 642 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @heppokofrontend/dictionary-file-maker
[](LICENSE) [](https://www.npmjs.com/package/@heppokofrontend/dictionary-file-maker)  [](https://codeclimate.com/github/heppokofrontend/dictionary-file-maker/maintainability) [](https://codeclimate.com/github/heppokofrontend/dictionary-file-maker/test_coverage) [](https://snyk.io/test/npm/@heppokofrontend/dictionary-file-maker)
[](https://snyk.io/advisor/npm-package/@heppokofrontend/dictionary-file-maker)
The `dictMaker()` method convert object to IME user dictionary tool config file.
See these instructions on how to use the text files exported by this tool.
- [Windows 10](./WINDOWS.md)
- [macOS](./MACOS.md)
## Usage
Installation:
```shell
npm install --save-dev @heppokofrontend/dictionary-file-maker
```
Example:
```javascript
import { dictMaker } from '@heppokofrontend/dictionary-file-maker';
const obj = [
{
input: 'かな１',
output: '単語A',
},
{
input: 'かな２',
output: '単語B',
},
{
input: 'かな３',
output: '単語C',
},
];
dictMaker(obj, 'win', './result.txt'); // The text file is writen.
```
:warning: The "~" varies depending on the OS.
```ts
const windows = json.replace(/〜/g, '～');
const macOS = json.replace(/～/g, '〜');
```
## Syntax
```ts
dictMaker(src, type, dist);
```
### Parameters
#### `src` - `{input, output [, type]}[]`
The dictionary data array object, or parsed JSON.
```json
[
{
"input": "かな",
"output": "単語",
"type": "品詞"
}
]
```
|property|type|default|required|description|
|---|:-:|:-:|:-:|---|
|`input`|`string`|`""`|`true`|The "yomi" of word in Japanese.|
|`output`|`string`|`""`|`true`|The word of conversion result.|
|`type`|`string`|Will be described later|\-|It's the parts of speech. Default value varies depending on the export target platform.|
The `type` prop is able to use those values.
- for Windows
- `名詞` (default)
- `短縮よみ`
- `人名`
- `地名`
- `顔文字`
- for macOS
- `普通名詞` (default)
- `サ変名詞`
- `人名`
- `地名`
- `形容詞`
- `副詞`
- `接尾語`
- `動詞`
**FYI:**
https://blogs.windows.com/japan/2017/02/17/imejptips4/
https://support.apple.com/ja-jp/guide/japanese-input-method/jpim10211/6.3/mac/11.0
#### `type` - `string`
The target platform name.
- `win` - For Windows IME
- `win-google` - For "Google 日本語入力" on Windows
- `mac` - For macOS IME
#### `dist` - `string`
Dictionary text file export destination.
## CLI
```shell
dict-maker [source] [options]
# sample
dict-maker yourfile.json --mac --win --winGoogle --out ./dictionary
```
```
-o, --out Specify an output folder for dictionary files. [string]
--win Enable the export of dictionary data for Windows 10 standard IME. [boolean]
--winGoogle Enable the export of dictionary data for Google IME on Windows 10. [boolean]
--mac Enable the export of dictionary data for macOS IME [boolean]
```
## 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