Skip to content

Latest commit

 

History

History
88 lines (74 loc) · 2.36 KB

README_EN.md

File metadata and controls

88 lines (74 loc) · 2.36 KB

Tsuduri

deno doc codecov

build IME dictionary.
Created by Deno.

The goal is to create all IME user dictionaries from a single file.

Language Support

  • Japanese

Dictionary Support

  • Google Japanese IME
  • macOS Japanese Input Method
  • Gboard
  • Microsoft IME

Dictionary Table

Name Split Type Can Set Genre Can Set Word class
Google IME TSV ✔ ✔
macOS Japanese Input Method CSV ✗ ✔
Gboard TSV ✗ ✗
Microsoft IME TSV ✗ ✔

Feature

  • API
  • CLI
  • Web App

Install

deno install -RWE --allow-run -n tsuduri https://jsr.io/@whyk/tsuduri/cli

Input File Extensions Support

  • CSV
  • JSON

Example files in .xlsx and .ods are included for use with spreadsheet software such as Microsoft Excel.
Please check example/input for details.

Usage

All dictionaries

tsuduri --dir=example/input/raw --all

Specific dictionaries

tsuduri --dir=example/input/raw --google --macos --microsoft --gboard

Compress dictionaries

tsuduri --dir=example/input/raw --all --compress

Build dictionary workflow example

name: Build IME dictionary
on:
  pull_request:
    types: [closed]

jobs:
  upload:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Setup Deno
        uses: denoland/setup-deno@v1
        with:
          deno-version: v1.x
      - name: Output dictionary data
        run: |
          deno install --allow-read --allow-write -n tsuduri https://jsr.io/@whyk/tsuduri/cli
          tsuduri --dir=example/input/raw --all
      - name: Archive production artifacts
        uses: actions/upload-artifact@v4
        with:
          name: dictionary
          path: tsuduri_output
          retention-days: 30