@kensio/pinyinjs 1.5.2 → 1.5.3

package/CHANGELOG.md

@@ -9,6 +9,20 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
 
 ## Unreleased
 
+## 1.5.3
+
+### Fixed
+
+- **The changelog inside the package described five releases as unreleased.**
+  Every tarball from 1.1.0 to 1.5.2 shipped a `## Unreleased` section holding
+  everything since 1.0.0, so a reader who opened the copy they installed —
+  which [the API page](docs/api/#stability) points them at — had no way to tell
+  which version any of it arrived in. The entries are filed under the versions
+  that shipped them now. No code changes; this release exists to put the
+  corrected file on the registry.
+
+## 1.5.2
+
 ### Fixed
 
 - **Third-tone sandhi ran over the syllables rather than over the feet.** The
@@ -52,28 +66,11 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   written, so 相親 keeps the `xiàngqīn` its dominant sense carries. CC-CEDICT
   now supplies 335 deltas rather than 349.
 
-- **240 dictionary entries could not be looked up at all.** Recognising Hong
-  Kong glyph forms on the lookup path means a key written in a form the path
-  normalises _away from_ can never be found, and the merge derived 繁體 forms
-  per word from Unihan's variant lists with no single standard behind them — so
-  it wrote 裏 where the corpus overwhelmingly writes 裡, and 上樑, 中峯 and 义藴
-  became keys nothing could reach. The merge now derives canonical glyph forms,
-  and keys a headword's canonical spelling alongside it where the phrase corpus
-  wrote one with a 繁體 variant. **No key is now unreachable**, and Hong Kong
-  spellings resolve slightly better than before: 5,499 of the 9,978 keys with a
-  distinct Hong Kong form, against 5,439.
+## 1.5.1
 
-  Two things had to be got right alongside it. The evidence for "简体 writes
-  this character" comes from CC-CEDICT entries whose two columns differ, not
-  from the phrase corpus, which is nominally 简体 but carries 峯, 藴 and 枱 of
-  its own — counting it cut the table from 50 mappings to 32 and stopped Hong
-  Kong text converting at all. And a 繁體 form differing from its 简体 one only
-  by glyph normalisation is not evidence about script, or the alias key would
-  put that entry's 简体 characters into the 繁體-only set, which is how 发
-  briefly stopped being 简体-only.
+Tooling and test-suite work only; nothing a consumer installs changed.
 
-  `toScript` drops the pass that was papering over this. Key counts move:
-  723,149 for `full`, 97,997 for `standard`, 16,975 for `core`.
+## 1.5.0
 
 ### Added
 
@@ -91,6 +88,10 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   command line — leaves it off, for a caller who would rather declare the
   language once on a wrapper of their own than repeat it on every syllable.
 
+## 1.4.0
+
+### Added
+
 - **`pinyinjs script`,** script conversion at the command line, with `--to` for
   the target and `--from-script` where the text is too short for detection to
   tell. The lines carry the converted text and nothing else so it pipes;
@@ -168,6 +169,35 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   before any dictionary has loaded; `pnpm build:data` re-derives them from
   OpenCC and fails the build if the two have drifted.
 
+### Fixed
+
+- **240 dictionary entries could not be looked up at all.** Recognising Hong
+  Kong glyph forms on the lookup path means a key written in a form the path
+  normalises _away from_ can never be found, and the merge derived 繁體 forms
+  per word from Unihan's variant lists with no single standard behind them — so
+  it wrote 裏 where the corpus overwhelmingly writes 裡, and 上樑, 中峯 and 义藴
+  became keys nothing could reach. The merge now derives canonical glyph forms,
+  and keys a headword's canonical spelling alongside it where the phrase corpus
+  wrote one with a 繁體 variant. **No key is now unreachable**, and Hong Kong
+  spellings resolve slightly better than before: 5,499 of the 9,978 keys with a
+  distinct Hong Kong form, against 5,439.
+
+  Two things had to be got right alongside it. The evidence for "简体 writes
+  this character" comes from CC-CEDICT entries whose two columns differ, not
+  from the phrase corpus, which is nominally 简体 but carries 峯, 藴 and 枱 of
+  its own — counting it cut the table from 50 mappings to 32 and stopped Hong
+  Kong text converting at all. And a 繁體 form differing from its 简体 one only
+  by glyph normalisation is not evidence about script, or the alias key would
+  put that entry's 简体 characters into the 繁體-only set, which is how 发
+  briefly stopped being 简体-only.
+
+  `toScript` drops the pass that was papering over this. Key counts move:
+  723,149 for `full`, 97,997 for `standard`, 16,975 for `core`.
+
+## 1.3.0
+
+### Added
+
 - **`slug`,** hanzi to a URL-safe slug: 我想学中文。 is
   `wo3-xiang3-xue2-zhong1wen2`. Built on the decode rather than on a finished
   string, which is the whole point of it — 银行 is `yin2hang2` and not
@@ -179,30 +209,20 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   The options generalise it past URLs to search keys and identifiers, which the
   [slug page](docs/slug/) tabulates. `pinyinjs slug` at the command line.
 
+## 1.2.2
+
+### Added
+
 - **`TEACHING_JIAO` and `COUNTED_MEASURE`,** two more lattice rules, and
   `QUANTITY_CHARACTERS`, the 汉字 a quantity is written with that the second of
   them asks about. See the fixes below for what they do and what they measure.
+
 - **`counts` on the numeral options.** Whether the number stands immediately in
   front of something it counts, which is what makes a lone 2 两:
   `numeralHanzi(2, { counts: true })` is `两` and `numeralHanzi(2)` is `二`.
   Unlike `liang` it is not a variable choice — 二个 is simply wrong — but
   nothing about the number says whether it is counting, so the caller says.
   `convert` sets it from the character after the digits.
-- **`SYLLABLE_TONES` and `isAttestedTone`.** Which tones each of the 424
-  syllables is actually written in, extracted from the merged dictionary and
-  held to it by a build assertion. 424 syllables in five tones would be 2,120
-  combinations and only 1,708 of them occur, so a fifth of that grid is empty.
-- **`Syllable.originalTone`,** the tone a neutral syllable had before it was
-  reduced. Gwoyeu Romatzyh writes the neutral tone as a dot in front of the
-  syllable _in its original tonal spelling_, so 没有 méiyou is `mei.yeou`, and
-  nothing else in a pinyin syllable records what that tone was. Optional, never
-  inferred, and used by GR alone.
-- **Two more outside sources for the transcription tables.** 148 words from
-  en.wiktionary's Mandarin pronunciation blocks, in bopomofo, Wade-Giles, Yale
-  and GR with their tones, and all 50 rows of Wikipedia's _Help:IPA/Mandarin_
-  key. The 417-row syllabary already checked was toneless, so it could say
-  nothing about tone marks, the neutral tone, 儿化 or how a word is joined,
-  which is where the four fixes below were found.
 
 ### Fixed
 
@@ -222,6 +242,7 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   `jiāo`, three of them wrongly — 统一教创始人, 方法教深思 and 做到了教政分离,
   where a nominal compound takes an object's shape. CPP's polyphone score is
   89.05%, up from 89.04%.
+
 - **A 量词 was swallowed by the word behind it.** 三个人 was `sān gèrén`, three
   _personals_, because 个人 is a common noun and nothing weighed it against the
   个 belonging to the 三 in front of it. It is now `sān gè rén`, and so are
@@ -237,6 +258,7 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   and moves 53 decodes, three of them wrongly — 一批评, 这一名词 and 六七股灾,
   where the 一 and the 六七 count nothing. Exactly one reading changes in the
   whole corpus and it is a fix: 已经下了两天雨了 read 天雨 as `tiān yù`.
+
 - **The Han after a number was decoded without it.** 2个人 was `liǎng gèrén`
   while 两个人 written out was already `liǎng gè rén`, because a Han run was
   decoded on its own and had no idea a number preceded it. A run is now decoded
@@ -245,6 +267,7 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   take that context as a fourth argument; where a reading would straddle the
   join — 1点儿事, whose 一点儿 is one `yìdiǎnr` over both sides of it — the run
   is decoded alone, as before.
+
 - **A lone 2 in front of a 量词 was read 二.** 我们买了2个西瓜 came out as
   `wǒmen mǎile èr gè xīguā`, and a 2 standing immediately in front of what it
   counts is 两: it is now `liǎng gè`, and 2岁 is `liǎng suì`, 2点 `liǎng diǎn`
@@ -255,43 +278,22 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   the 第 in front of it marks (第2次 is `dì èr cì`), and 十 and 百, which follow
   二 as 20 and 200 already do. A 2 inside a larger number is untouched: 12个 is
   still `shí'èr gè`.
+
+## 1.2.1
+
+### Fixed
+
 - **A decimal lost the grouping of its counted part.** 一共75.5元 was
   `yígòng qī shí wǔ diǎn wǔ yuán`, with the 75 in loose syllables, and is now
   `yígòng qīshíwǔ diǎn wǔ yuán`, the same word 一共75元 already got. Only what
   follows the 点 is read a digit at a time, and that part is unchanged: 3.14 is
   still `sān diǎn yī sì`, and sandhi still stops at the point.
+
 - **A decimal point was read as a full stop.** 一共75.5元 came back as
   `Yígòng …`, capitalised as though the text were a sentence, and a conversion
   keeping its digits capitalised again after the point: 我有75.5个。was
   `Wǒ yǒu75.5Gè.` A stop between two digits now ends no sentence.
-- **Bopomofo wrote the tone mark after the 儿化 ㄦ.** 哪儿 nǎr was `ㄋㄚㄦˇ` and
-  is now `ㄋㄚˇㄦ`: the mark belongs to the nucleus and the suffix is not part of
-  what it marks. A mark written after the ㄦ is still read.
-- **Wade-Giles put the tone digit on the 儿化 suffix,** so 花儿 huār was
-  `hua-êrh¹`, a first-tone 兒. It is now `hua¹-'rh`, with the digit on the
-  syllable the tone belongs to and the suffix written as the reduced `'rh` that
-  keeps it apart from 女儿 nǚ'ér's `nü³-êrh²`.
-- **Gwoyeu Romatzyh wrote 儿化 as a plain `-l` suffix.** GR fuses it into the
-  rime instead, and the rules are now implemented as _Spelling in Gwoyeu
-  Romatzyh_ gives them: 玩儿 wánr is `wal` rather than `wanl`, 事儿 shìr is
-  `shell`, 今儿 jīnr is `jiel`. The fusion is many-to-one, so `jiel` is 今儿 and
-  鸡儿 both and 128 forms no longer round-trip, every one of them a form the
-  language does not write.
-- **Gwoyeu Romatzyh wrote `.mhe` for a neutral 么.** The `-h-` is the first tone
-  of a sonorant initial, and a neutral syllable is in no tone at all; the basic
-  form goes behind the dot, so 什么 shénme is `shern.me`.
-- **The IPA module said it followed _Help:IPA/Mandarin_ and did not.** It
-  follows the broader IPA column of _Comparison of Standard Chinese
-  transcription systems_, which is where its ground truth comes from; the two
-  pages differ at the medials, -ang, the empty rhyme and the diphthongs. No
-  output changed, only the claim.
-- **`--system ipa` capitalised the IPA.** 我去银行。他姓王。 came out as
-  `Uo˨˩˦ ... Tʰa˥ ɕiŋ˥˩ Uaŋ˧˥`, with the sentence capital and the proper noun
-  carried over from the pinyin as though a transcription spelled words. IPA
-  letters are symbols rather than an alphabet, since `[T]` is not `[t]` in a
-  larger size but a symbol the IPA does not have, so the capitals are now dropped for
-  IPA and bopomofo and kept for the three romanisations. `toTranscription`
-  takes `{ capitals: false }` for callers writing their own.
+
 - **A compound lost the zh-TW reading its own parts carry.** 垃圾分類 read
   `lājīfēnlèi` under `zh-TW`, because CC-CEDICT marks `Taiwan pr.` on 垃圾 and
   垃圾桶 and on no other compound, and the decoder prefers the longer word, so
@@ -303,6 +305,7 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   it, and it has to be a whole word rather than a bare character, since 會's `huǐ`
   would rewrite 三合會 as `sānhéhuǐ` and 3,743 entries would compose that way
   against the 101 that whole words compose.
+
 - **A character's zh-TW delta was often a choice between its 普通话 senses.**
   从容地 read `cōngróng dì` and 他都知道 read `tā dū zhīdào` under `zh-TW`,
   because 地 was stored with a Taiwan reading of `dì` and 都 with `dū`. Neither
@@ -315,12 +318,75 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   only read off a sense matching the reading the entry settled on, which drops
   16 more: the note on 著's chess-move sense, which reads `zhāo`, had been
   giving the aspect particle 着 a 國語 reading of `zhuó`.
+
 - **A locale delta overwrote a reading it was not measured against.** The delta
   describes the entry's own 普通话 reading, so a polyphone the decode read some
   other way, such as 得 forced to the modal `děi` rather than the particle `de`
   its entry stores, now keeps what the decode worked out instead of being
   rewritten from the entry.
 
+## 1.2.0
+
+### Fixed
+
+- **`--system ipa` capitalised the IPA.** 我去银行。他姓王。 came out as
+  `Uo˨˩˦ ... Tʰa˥ ɕiŋ˥˩ Uaŋ˧˥`, with the sentence capital and the proper noun
+  carried over from the pinyin as though a transcription spelled words. IPA
+  letters are symbols rather than an alphabet, since `[T]` is not `[t]` in a
+  larger size but a symbol the IPA does not have, so the capitals are now dropped for
+  IPA and bopomofo and kept for the three romanisations. `toTranscription`
+  takes `{ capitals: false }` for callers writing their own.
+
+## 1.1.0
+
+### Added
+
+- **`SYLLABLE_TONES` and `isAttestedTone`.** Which tones each of the 424
+  syllables is actually written in, extracted from the merged dictionary and
+  held to it by a build assertion. 424 syllables in five tones would be 2,120
+  combinations and only 1,708 of them occur, so a fifth of that grid is empty.
+
+- **`Syllable.originalTone`,** the tone a neutral syllable had before it was
+  reduced. Gwoyeu Romatzyh writes the neutral tone as a dot in front of the
+  syllable _in its original tonal spelling_, so 没有 méiyou is `mei.yeou`, and
+  nothing else in a pinyin syllable records what that tone was. Optional, never
+  inferred, and used by GR alone.
+
+- **Two more outside sources for the transcription tables.** 148 words from
+  en.wiktionary's Mandarin pronunciation blocks, in bopomofo, Wade-Giles, Yale
+  and GR with their tones, and all 50 rows of Wikipedia's _Help:IPA/Mandarin_
+  key. The 417-row syllabary already checked was toneless, so it could say
+  nothing about tone marks, the neutral tone, 儿化 or how a word is joined,
+  which is where the four fixes below were found.
+
+### Fixed
+
+- **Bopomofo wrote the tone mark after the 儿化 ㄦ.** 哪儿 nǎr was `ㄋㄚㄦˇ` and
+  is now `ㄋㄚˇㄦ`: the mark belongs to the nucleus and the suffix is not part of
+  what it marks. A mark written after the ㄦ is still read.
+
+- **Wade-Giles put the tone digit on the 儿化 suffix,** so 花儿 huār was
+  `hua-êrh¹`, a first-tone 兒. It is now `hua¹-'rh`, with the digit on the
+  syllable the tone belongs to and the suffix written as the reduced `'rh` that
+  keeps it apart from 女儿 nǚ'ér's `nü³-êrh²`.
+
+- **Gwoyeu Romatzyh wrote 儿化 as a plain `-l` suffix.** GR fuses it into the
+  rime instead, and the rules are now implemented as _Spelling in Gwoyeu
+  Romatzyh_ gives them: 玩儿 wánr is `wal` rather than `wanl`, 事儿 shìr is
+  `shell`, 今儿 jīnr is `jiel`. The fusion is many-to-one, so `jiel` is 今儿 and
+  鸡儿 both and 128 forms no longer round-trip, every one of them a form the
+  language does not write.
+
+- **Gwoyeu Romatzyh wrote `.mhe` for a neutral 么.** The `-h-` is the first tone
+  of a sonorant initial, and a neutral syllable is in no tone at all; the basic
+  form goes behind the dot, so 什么 shénme is `shern.me`.
+
+- **The IPA module said it followed _Help:IPA/Mandarin_ and did not.** It
+  follows the broader IPA column of _Comparison of Standard Chinese
+  transcription systems_, which is where its ground truth comes from; the two
+  pages differ at the medials, -ang, the empty rhyme and the diphthongs. No
+  output changed, only the claim.
+
 ### Changed
 
 - **Reading a romanisation narrows on the tone that was written.**
@@ -333,6 +399,7 @@ which a dictionary rebuild can change, and the artifact format under `data/`.
   candidates alone, since that says the tone is wrong rather than the spelling.
   Over the phrase corpus, taking the first candidate recovers 82.66% of
   syllables when the tone digit is written, against 79.05% without it.
+
 - Eight Wade-Giles forms no longer round-trip, and one to three in each of the
   other systems, because they are forms the language does not write: `lo` in the
   four contour tones, a first-tone 兒, and a neutral 誒. Every attested

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@kensio/pinyinjs",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "Chinese hanzi to pinyin conversion",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/KensioSoftware/pinyinjs"
-  },
+  "repository": "https://github.com/KensioSoftware/pinyinjs",
   "homepage": "https://pinyinjs.dev",
   "bugs": "https://github.com/KensioSoftware/pinyinjs/issues",
   "main": "./dist/index.js",
@@ -39,20 +36,44 @@
   "imports": {
     "#test/*": "./test/*"
   },
+  "packageManager": "pnpm@11.17.0+sha512.cca3cea332ad254bb84145f966d19f4879615210346fc92c79a047f23a0d7b3cca3c3792f0076ba1f1831d277efbcf0a9119b31a9a60eca7fb3d6231f331ef72",
   "engines": {
     "node": ">=22.0.0"
   },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepack": "pnpm build",
+    "cli": "node --import jiti/register src/cli/main.ts",
+    "build:check": "tsc -p tsconfig.json --noEmit",
+    "fmt": "oxlint --fix . && oxfmt .",
+    "lint": "oxlint . && oxfmt --check .",
+    "lint:ci": "oxlint --format=github . && oxfmt --check .",
+    "fta": "./scripts/sh/fta.sh",
+    "pack:check": "./scripts/sh/pack-check.sh",
+    "build:data": "node --import jiti/register scripts/build-data/build.ts",
+    "fetch:data": "node --import jiti/register scripts/build-data/fetch.ts",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "check": "pnpm fmt && pnpm fta && pnpm build && pnpm build:check && pnpm test:coverage",
+    "accuracy": "node --import jiti/register scripts/build-data/accuracy.ts",
+    "polyphones": "node --import jiti/register scripts/build-data/polyphones.ts",
+    "numerals": "node --import jiti/register scripts/build-data/numerals.ts",
+    "transcription": "node --import jiti/register scripts/build-data/transcription.ts"
+  },
   "devDependencies": {
     "@kensio/smartass": "^1.33.0",
+    "@semantic-release/exec": "7.1.0",
     "@types/lodash": "^4.17.24",
     "@types/node": "^26.0.0",
     "@typescript/native": "npm:typescript@^7.0.2",
     "@vitest/coverage-v8": "^4.1.10",
+    "conventional-changelog-conventionalcommits": "10.2.1",
     "fta-cli": "^3.0.0",
     "jiti": "^2.7.0",
     "oxfmt": "^0.62.0",
     "oxlint": "^1.77.0",
     "oxlint-tsgolint": "^7.0.2001",
+    "semantic-release": "25.0.9",
     "typescript": "npm:@typescript/typescript6@^6.0.2",
     "vitest": "^4.1.10"
   },
@@ -67,24 +88,5 @@
   },
   "author": "Kensio Software",
   "license": "Apache-2.0 AND CC-BY-SA-4.0",
-  "type": "module",
-  "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.build.json",
-    "cli": "node --import jiti/register src/cli/main.ts",
-    "build:check": "tsc -p tsconfig.json --noEmit",
-    "fmt": "oxlint --fix . && oxfmt .",
-    "lint": "oxlint . && oxfmt --check .",
-    "lint:ci": "oxlint --format=github . && oxfmt --check .",
-    "fta": "./scripts/sh/fta.sh",
-    "pack:check": "./scripts/sh/pack-check.sh",
-    "build:data": "node --import jiti/register scripts/build-data/build.ts",
-    "fetch:data": "node --import jiti/register scripts/build-data/fetch.ts",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "check": "pnpm fmt && pnpm fta && pnpm build && pnpm build:check && pnpm test:coverage",
-    "accuracy": "node --import jiti/register scripts/build-data/accuracy.ts",
-    "polyphones": "node --import jiti/register scripts/build-data/polyphones.ts",
-    "numerals": "node --import jiti/register scripts/build-data/numerals.ts",
-    "transcription": "node --import jiti/register scripts/build-data/transcription.ts"
-  }
-}
+  "type": "module"
+}