brycetsao / tongwen-dict

TongWen Dict

這是一個開放的簡體正體轉換辭庫，主要基於 tongwen-core 的演算法所設計的辭庫。

貢獻請求

• 新增更多的轉換詞彙
• 維護轉換表，糾正錯誤、新增過度轉換修正等

貢獻說明

• 單字轉換表位於 src/charater/*.json 。
• 詞彙轉換表位於 src/word/*.{s2t,t2s}.ts 。
• 新增詞彙時：
  • 注意分類說明。
  • 進行全域搜尋，確保新增的詞彙沒有衝突或重複。
  • 注意是否有過度轉換的可能，若是危險的詞彙，請註明 🦠 並新增相關修正 💊 。
  • 若無法確認，請先於討論區進行討論。
• 雙向轉換詞彙
  • 雙向轉換詞彙表示可適用簡體轉正體及正體轉簡體，譬如：芯片 <=> 晶片。
  • 雙向詞彙一律放在 *.s2t.ts （簡體轉正體）轉換表的 shareable 物件中。
• 新增轉換分類表
  • 請確保該分類具備較高獨立性、互斥性，若無法確認，請先到討論區發起討論。
  • 分類表檔案規範：
    • 檔名必須滿足 type.{s2t,t2s}.ts 。
    • 檔案必須有預設輸出（ export default {...} ）物件。
    • 雙向轉換表必須由 s2t.ts 檔案中匯出，並在對應分類的 t2s.ts 當中匯入且用 createRevertDict 產生反向物件。

圖示說明

• ☢️ ：激進、高機率過度轉換，預設關閉，未來會思考如何輸出這類詞彙。
• 🦠 ：危險、可能過度轉換，預設開啟但需要透過 💊 進行修正過度轉換
• 💊 ：作為修正 🦠 的過度轉換

分類說明

為了便於管理，劃分了若干個分類表，但也會因此衍生一些問題。

• 💊 修正過度轉換縱然與 🦠 轉換詞彙分屬不同分類，仍應放在相同的轉換表中。

使用說明

目前只能夠透過下載本專案自行下指令輸出 JSON 檔，未來會考慮上架到其他平台（ npm 等）。

指令輸出：

> git clone [email protected]:tongwentang/tongwen-dict.git # 下載專案
> yarn install # 安裝
> yarn build # 程式輸出轉換表

順利的話，就可以在 dist/ 資料夾看到數個 JSON 檔， *.min.json 為經壓縮的單列檔案。