@kensio/pinyinjs 1.9.9 → 1.10.0

package/NOTICE

@@ -41,6 +41,13 @@ Source:   https://raw.githubusercontent.com/BYVoid/OpenCC/master/data/dictionary
 Licence:  Apache-2.0
 Provides: the 简体 ↔ 繁體 character tables, and the Taiwan and Hong Kong glyph form tables that separate 裡 from 裏 and 群 from 羣
 
+## 中華民國教育部（Ministry of Education, R.O.C.）。《國語辭典簡編本》（版本編號：2014_20260929）網址：https://dict.concised.moe.edu.tw/ and 《重編國語辭典修訂本》（版本編號：2015_20260929）網址：https://dict.revised.moe.edu.tw/
+
+Source:   https://language.moe.gov.tw/001/Upload/Files/site_content/M0001/respub/download/dict_concised_2014_20260929.zip
+          https://language.moe.gov.tw/001/Upload/Files/site_content/M0001/respub/download/dict_revised_2015_20260929.zip
+Licence:  CC BY-ND 3.0 TW; only the 漢語拼音 reading of each headword is read, and no definition, example or other text of either dictionary is taken
+Provides: the 國語 readings that make up the zh-TW locale, at word level and as a check on the character-level notes
+
 ## Comparison of Standard Chinese transcription systems (Wikipedia)
 
 Source:   https://en.wikipedia.org/wiki/Comparison_of_Standard_Chinese_transcription_systems

package/README.md

@@ -47,6 +47,7 @@ $ pinyinjs explain 银行
 
 $ pinyinjs lookup 头发
 头发  tóu fa  n
+  zh-TW  tóu fǎ
 
 $ pinyinjs match --query bjdx 北京大学 我在北京大学学中文 上海大学
 [北京大学]  7.00
@@ -812,6 +813,21 @@ Both scripts are dictionary keys, so only the locale is an option to pass. Hong
 Kong's 繁體 forms are recognised on the way in, so 羣眾 and 麪包 read exactly as
 群眾 and 麵包 do.
 
+`zh-TW` reads words as the Taiwan Ministry of Education's dictionaries of the
+國語 standard do, for every word they list. A word with no Taiwan reading is
+read the same in both locales.
+
+```ts
+convert(dictionary, "星期", { locale: "zh-TW" }); // "xīngqí"
+convert(dictionary, "頭髮", { locale: "zh-TW" }); // "tóufǎ"
+convert(dictionary, "他和我", { locale: "zh-TW" }); // "tā hé wǒ"
+```
+
+A Taiwan reading that holds for one sense only stays out of the default. 和 is
+`hé` in both locales, and `lookup` lists the `hàn` of the conjunction as
+`taiwanAlternates`. Hong Kong teaches Putonghua to the mainland's readings, so
+Hong Kong text takes `zh-CN`. See [scripts and locales](docs/scripts-and-locales/#the-locale-delta).
+
 ## Simplified and traditional
 
 `toScript` converts between the scripts, and the reading is what makes it
@@ -905,7 +921,7 @@ Every example in this README is executed by `src/readme.test.ts` against the
 committed dictionary, so the two cannot drift apart. Change them together.
 
 The compiled dictionaries in `data/` are committed, so what ships is exactly
-what was tested. `pnpm build:data` fetches the four sources into `.cache/` (~32
+what was tested. `pnpm build:data` fetches the sources into `.cache/` (~41
 MB), merges them, runs the build assertions, and rewrites `data/` and `NOTICE`.
 It fails where it could warn. No artifact is written unless 儿化 is repaired
 both ways, 一 and 不 sandhi is normalised out, every syllable is one the
@@ -913,12 +929,13 @@ inventory knows, and every tier reads back exactly as it was built.
 
 ## Data sources
 
-| Source                                                                | Provides                                              | Licence      |
-| --------------------------------------------------------------------- | ----------------------------------------------------- | ------------ |
-| [Unihan](https://www.unicode.org/charts/unihan.html)                  | character readings, polyphone priors, script variants | Unicode      |
-| [CC-CEDICT](https://www.mdbg.net/chinese/dictionary?page=cc-cedict)   | 简体/繁體 pairs, 儿化, neutral tones, Taiwan readings | CC BY-SA 4.0 |
-| [phrase-pinyin-data](https://github.com/mozillazg/phrase-pinyin-data) | the bulk of the word readings                         | MIT          |
-| [jieba](https://github.com/fxsjy/jieba)                               | word frequencies and part-of-speech tags              | MIT          |
+| Source                                                                                               | Provides                                              | Licence         |
+| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | --------------- |
+| [Unihan](https://www.unicode.org/charts/unihan.html)                                                 | character readings, polyphone priors, script variants | Unicode         |
+| [CC-CEDICT](https://www.mdbg.net/chinese/dictionary?page=cc-cedict)                                  | 简体/繁體 pairs, 儿化, neutral tones, Taiwan readings | CC BY-SA 4.0    |
+| [phrase-pinyin-data](https://github.com/mozillazg/phrase-pinyin-data)                                | the bulk of the word readings                         | MIT             |
+| [jieba](https://github.com/fxsjy/jieba)                                                              | word frequencies and part-of-speech tags              | MIT             |
+| [教育部 國語辭典](https://language.moe.gov.tw/001/Upload/Files/site_content/M0001/respub/index.html) | Taiwan (國語) readings, as reading facts only         | CC BY-ND 3.0 TW |
 
 `NOTICE` is generated from the same table the pipeline fetches from.
 
@@ -926,5 +943,7 @@ inventory knows, and every tier reads back exactly as it was built.
 
 `Apache-2.0 AND CC-BY-SA-4.0`, because the package is two things. The code is
 Apache-2.0, and the compiled dictionaries in `data/` are share-alike, CC-CEDICT
-being CC BY-SA 4.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE), which is
+being CC BY-SA 4.0. The Taiwan readings are taken from the Ministry of
+Education's dictionaries as facts about how each word is read. No definition or
+other text of those dictionaries is in `data/`. See [LICENSE](LICENSE) and [NOTICE](NOTICE), which is
 generated from the sources the pipeline actually fetched.

package/data/core.entries

@@ -262,7 +262,7 @@ jin1		zg
 jie4		nr
 bing1		zg
 reng2		zg
-cong2		p		cong1
+cong2	,zong4	p		cong1
 san3		zg
 lun2		g
 cang1		nr
@@ -328,7 +328,7 @@ tang3		zg
 zhong4		ng
 you1		n
 huo3		n		huo5
-hui4		v		kuai4
+hui4	,hui3	v		kuai4
 yu3		v
 yun2		zg
 san3		n
@@ -473,7 +473,7 @@ bian4		d		pian2
 yu3		x
 xi4		zg
 cu4		v
-e2	e4	j
+e2		j
 qiu2		x
 xu2
 guang4		zg
@@ -1110,7 +1110,7 @@ shao4		g
 zhu1		zg
 li4		nr
 jin4		n		jing4
-lao2		vn
+lao2	,lao4	vn
 juan4		zg
 kou3
 wa1		zg
@@ -1212,7 +1212,7 @@ suan3		zg
 du2
 jiu4
 jue2
-pi3		q
+pi3	,pi1	q
 qu1		n		ou1
 yi1		n
 ke1		zg
@@ -1435,7 +1435,7 @@ dun1	dun4	m
 fen1		v
 e2
 han2		v
-ting1		v		ting5
+ting1	,ting4	v		ting5
 keng1		zg		hang2
 shun3		v
 qi3		v
@@ -1519,7 +1519,7 @@ fu2
 yang1
 he2
 ze2		r		zha1,za3
-he2	han4	c		huo5,he4,hu2,huo2,huo4,he5
+he2	,han4	c		huo5,he4,hu2,huo2,huo4,he5
 hai1		zg
 jiu4		ng
 yong3		n
@@ -2069,7 +2069,7 @@ gui1		ns
 pi3		zg
 yi2		g
 de5		uv		di4
-zhen4	zun4	nt
+zhen4	,zun4	nt
 xia4		zg
 kuang4		ng
 chang3		q		chang2
@@ -2464,7 +2464,7 @@ wai4		f
 yuan4
 mao3
 su4		n
-duo1		m
+duo1	,duo2	m
 duo1		zg
 ye4		t
 gou4		zg
@@ -4537,7 +4537,7 @@ yang1
 bao4		v
 ni3
 ye4		zg
-di3		zg
+di3	,zhi3	zg
 chi4
 mo3		v		ma1,mo4
 mei4		zg
@@ -5558,7 +5558,7 @@ xi1		vg
 hu4
 ya1		zg
 dou3		zg
-zhen3		n
+zhen3	,zhen4	n
 yao1		zg
 lin2		ng
 rui4		zg
@@ -6428,7 +6428,7 @@ ai3		zg
 jie3
 du2		zg
 yu4		nz
-bi3		p
+bi3	,bi4	p
 bi4		v
 bi4		g
 pi2		zg
@@ -6641,7 +6641,7 @@ you1		zg
 gu1		zg
 hong2		q
 gan1		n
-fa3	fa4	j		fa5
+fa3		j		fa5
 mao3		g
 si4		ns
 ping2
@@ -7619,7 +7619,7 @@ jing5		zg
 ying2		n
 yu4		ag
 tai4
-zao4		ag
+zao4	,sao4	ag
 can4		a
 sui4		n
 zong3		zg
@@ -7980,7 +7980,7 @@ fen1		x		bin1
 yue4		zg
 jue2		zg
 jue2		g
-wan2		v
+wan2	,wan4	v
 jian1		zg
 mei2		n
 pin2
@@ -10233,7 +10233,7 @@ sha1		zg
 gang1		n
 na4		nr
 ren4
-zong4	zong1	n
+zong4	,zong1	n
 lun2		x		guan1
 fen1		d
 zhi3		n
@@ -10410,7 +10410,7 @@ zhi4		v		zhi5
 an3
 fa2
 lan3		v
-shu3		ng
+shu3	,shu4	ng
 si1
 pi2		g
 ma4		v
@@ -10689,7 +10689,7 @@ zhen1		g
 zuo4		g
 pei1		n
 jia3		zg
-sheng4		v		sheng1
+sheng4	,sheng1	v		sheng1
 zhi1		x
 bao1		n
 qu1		zg
@@ -12162,7 +12162,7 @@ er4
 ka1
 mie4
 xi4
-xing2		zg		hang2,heng2,hang4
+xing2	,xing4	zg		hang2,heng2,hang4
 yan3		v
 kan4		zg
 yuan4		zg
@@ -13655,7 +13655,7 @@ yuan2		n
 xia2		v
 zhan3		v		nian3
 lu4		n
-zhe2	che4	n
+zhe2	,che4	n
 lin2		x
 xin1		nr	p
 gu1		nr	p
@@ -14640,7 +14640,7 @@ yu4		g
 qian2		n		qian5
 zheng1		g
 qian2		n
-gu3	gu1	ng
+gu3	,gu1	ng
 bo1		ng
 ke1		zg
 po3		g