@kensio/pinyinjs 1.7.3 → 1.7.5

package/dist/cli/command.d.ts

@@ -0,0 +1,97 @@
+/**
+ * What every subcommand is, and the formatting each of them shares.
+ *
+ * Split out from `commands.ts` so that a command living in its own module can
+ * take the contract and the shared helpers without importing the registry that
+ * lists it, which would be a cycle.
+ */
+import type { ConvertedPiece } from "../decode/convert.js";
+import type { Dictionary } from "../dictionary/dictionary.js";
+import type { ScriptTables } from "../script/conversion.js";
+import { type Syllable } from "../syllable/syllable.js";
+import { type DictionaryChoice, type Flags, type FlagName } from "./arguments.js";
+import { type Painter } from "./colour.js";
+/**
+ * What a command is given to work with.
+ */
+export interface CommandInput {
+    /** The words, phrases or texts to act on, one per line of output. */
+    readonly texts: readonly string[];
+    readonly flags: Flags;
+    /** Loaded for the commands that declare they need one. */
+    readonly dictionary: Dictionary | undefined;
+    /** Loaded for the one command that converts between the scripts. */
+    readonly scriptTables: ScriptTables | undefined;
+    readonly choice: DictionaryChoice;
+    /**
+     * How to write a syllable, which is where tone colour is applied.
+     *
+     * Handed in rather than worked out, because whether the output is a terminal
+     * is a fact about the run and not about the command. A command that writes no
+     * syllables never calls it, and `html` deliberately does not: markup is a
+     * format for a machine, exactly as `--json` is.
+     */
+    readonly paint: Painter;
+}
+/**
+ * One answer, in both the forms the CLI can write it.
+ *
+ * Every command reports both rather than one being derived from the other: the
+ * lines are for a person reading them and the data is for `jq`, and a person's
+ * columns are a poor thing to parse. Keeping them side by side in each command
+ * is what stops them drifting apart.
+ */
+export interface Reported {
+    readonly lines: readonly string[];
+    /** Written as one JSON document per answer, for `--json`. */
+    readonly data: unknown;
+}
+/**
+ * One subcommand.
+ */
+export interface Command {
+    readonly name: string;
+    /** One line, for the command list in the help. */
+    readonly summary: string;
+    /** What follows the command name, for its own help. */
+    readonly argument: string;
+    /** The flags it takes, beyond the global ones. */
+    readonly flags: readonly FlagName[];
+    /**
+     * Whether it reads the dictionary.
+     *
+     * The syllable layer needs no data at all, and a command that only uses it
+     * should not wait for 2.4 MB to load.
+     */
+    readonly needsDictionary: boolean;
+    /**
+     * Whether it reads the script conversion tables, which are their own file.
+     *
+     * Off for everything but `script`: the tables are 96 KB nothing else looks
+     * at, and the point of keeping them out of the dictionary is not paying for
+     * them by default.
+     */
+    readonly needsScriptTables?: boolean;
+    readonly run: (input: CommandInput) => readonly Reported[];
+}
+/**
+ * The dictionary a command declared it needs.
+ */
+export declare function dictionaryOf(input: CommandInput): Dictionary;
+/**
+ * Pad a column so that what follows it lines up.
+ *
+ * Padded to what a reader sees rather than to the string's length: a coloured
+ * cell carries escape sequences that take no width on screen, and `padEnd`
+ * counts them.
+ */
+export declare function column(text: string, width: number): string;
+/**
+ * A reading written out, syllable by syllable, each in its tone's colour.
+ */
+export declare function written(reading: readonly Syllable[], paint: Painter): string;
+/**
+ * A conversion's pieces joined back up, each syllable in its tone's colour.
+ */
+export declare function paintedPieces(pieces: readonly ConvertedPiece[], input: CommandInput): string;
+//# sourceMappingURL=command.d.ts.map

package/dist/cli/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/cli/command.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,yBAAyB,CAAC;AACvE,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,KAAK,EACV,KAAK,QAAQ,EAEd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,aAAa,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5C,oEAAoE;IACpE,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IAChD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,SAAS,QAAQ,EAAE,CAAC;CAC5D;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,UAAU,CAM5D;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAI5E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,cAAc,EAAE,EACjC,KAAK,EAAE,YAAY,GAClB,MAAM,CAIR"}

package/dist/cli/command.js

@@ -0,0 +1,40 @@
+import { writeSyllable } from "../syllable/syllable.js";
+import { UsageError, } from "./arguments.js";
+import { visibleLength } from "./colour.js";
+/**
+ * The dictionary a command declared it needs.
+ */
+export function dictionaryOf(input) {
+    /* c8 ignore next 3 -- loaded for every command that declares it needs one */
+    if (input.dictionary === undefined) {
+        throw new UsageError("no dictionary was loaded");
+    }
+    return input.dictionary;
+}
+/**
+ * Pad a column so that what follows it lines up.
+ *
+ * Padded to what a reader sees rather than to the string's length: a coloured
+ * cell carries escape sequences that take no width on screen, and `padEnd`
+ * counts them.
+ */
+export function column(text, width) {
+    return text + " ".repeat(Math.max(0, width - visibleLength(text)));
+}
+/**
+ * A reading written out, syllable by syllable, each in its tone's colour.
+ */
+export function written(reading, paint) {
+    return reading
+        .map((syllable) => paint(writeSyllable(syllable), syllable.tone))
+        .join(" ");
+}
+/**
+ * A conversion's pieces joined back up, each syllable in its tone's colour.
+ */
+export function paintedPieces(pieces, input) {
+    return pieces
+        .map((piece) => input.paint(piece.text, piece.syllable?.tone))
+        .join("");
+}
+//# sourceMappingURL=command.js.map

package/dist/cli/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/cli/command.ts"],"names":[],"mappings":"AAUA,OAAO,EAAiB,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAIL,UAAU,GACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAgB,aAAa,EAAE,MAAM,aAAa,CAAC;AAoE1D;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,KAAmB;IAC9C,6EAA6E;IAC7E,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC,UAAU,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,IAAY,EAAE,KAAa;IAChD,OAAO,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,OAA4B,EAAE,KAAc;IAClE,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;SAChE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAiC,EACjC,KAAmB;IAEnB,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC7D,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC"}

package/dist/cli/commands.d.ts

@@ -1,116 +1,13 @@
-import type { Dictionary } from "../dictionary/dictionary.js";
-import { type Syllable } from "../syllable/syllable.js";
-import { type DictionaryChoice, type Flags, type FlagName, type TranscriptionSource } from "./arguments.js";
-import { type Painter } from "./colour.js";
-import type { ScriptTables } from "../script/conversion.js";
 /**
- * What a command is given to work with.
- */
-export interface CommandInput {
-    /** The words, phrases or texts to act on, one per line of output. */
-    readonly texts: readonly string[];
-    readonly flags: Flags;
-    /** Loaded for the commands that declare they need one. */
-    readonly dictionary: Dictionary | undefined;
-    /** Loaded for the one command that converts between the scripts. */
-    readonly scriptTables: ScriptTables | undefined;
-    readonly choice: DictionaryChoice;
-    /**
-     * How to write a syllable, which is where tone colour is applied.
-     *
-     * Handed in rather than worked out, because whether the output is a terminal
-     * is a fact about the run and not about the command. A command that writes no
-     * syllables never calls it, and `html` deliberately does not: markup is a
-     * format for a machine, exactly as `--json` is.
-     */
-    readonly paint: Painter;
-}
-/**
- * One answer, in both the forms the CLI can write it.
- *
- * Every command reports both rather than one being derived from the other: the
- * lines are for a person reading them and the data is for `jq`, and a person's
- * columns are a poor thing to parse. Keeping them side by side in each command
- * is what stops them drifting apart.
- */
-export interface Reported {
-    readonly lines: readonly string[];
-    /** Written as one JSON document per answer, for `--json`. */
-    readonly data: unknown;
-}
-/**
- * One subcommand.
- */
-export interface Command {
-    readonly name: string;
-    /** One line, for the command list in the help. */
-    readonly summary: string;
-    /** What follows the command name, for its own help. */
-    readonly argument: string;
-    /** The flags it takes, beyond the global ones. */
-    readonly flags: readonly FlagName[];
-    /**
-     * Whether it reads the dictionary.
-     *
-     * The syllable layer needs no data at all, and a command that only uses it
-     * should not wait for 2.4 MB to load.
-     */
-    readonly needsDictionary: boolean;
-    /**
-     * Whether it reads the script conversion tables, which are their own file.
-     *
-     * Off for everything but `script`: the tables are 96 KB nothing else looks
-     * at, and the point of keeping them out of the dictionary is not paying for
-     * them by default.
-     */
-    readonly needsScriptTables?: boolean;
-    readonly run: (input: CommandInput) => readonly Reported[];
-}
-/**
- * How one system writes a word: a syllable at a time, and what it joins on.
+ * Every subcommand the CLI has, and how one is found by name.
  *
- * The `write*Word` helpers are each a map and a join, and this takes them apart
- * so that every syllable can be painted its own colour. That duplicates five
- * separators, so each entry carries the helper it stands in for and
- * `commands.test.ts` asserts the two agree over the whole inventory in every
- * tone state — rather than the list being trusted.
- */
-export interface System {
-    /** What `--from` and `--system` call it. */
-    readonly name: TranscriptionSource;
-    readonly write: (syllable: Syllable) => string;
-    readonly separator: string;
-    /**
-     * How the system writes a word, with its tones or without them.
-     *
-     * `--notation none` can only be honoured where the tone is written
-     * separately*: Wade-Giles, Yale and IPA all have a way to leave it off.
-     * Bopomofo marks it with a symbol of the script and Gwoyeu Romatzyh spells
-     * it into the syllable, so for those two there is nothing to leave off and
-     * the flag is ignored rather than approximated.
-     */
-    readonly word: (syllables: readonly Syllable[], hasTones: boolean) => string;
-    /**
-     * Whether the system writes the capitals the conversion settled.
-     *
-     * The three romanisations do, since a romanisation is a way of writing
-     * Chinese in the Latin alphabet and inherits what that alphabet does with a
-     * proper noun. IPA and bopomofo do not — see {@link toTranscription}.
-     */
-    readonly capitals: boolean;
-}
-/**
- * Every system `transcribe` writes a column for, for the guard above.
- */
-export declare const SYSTEMS: readonly System[];
-/**
- * The system a `--system` or `--from` name stands for.
- */
-export declare function systemNamed(name: TranscriptionSource | undefined): System | undefined;
-/**
- * Write a run of syllables in one system, each syllable in its tone's colour.
+ * Only the list: each command lives in a module beside its subject, so that
+ * adding one is a new file and a new line here rather than an edit to whatever
+ * this file happened to have grown into.
  */
-export declare function writtenWith(syllables: readonly Syllable[], system: System, paint: Painter): string;
+import type { Command } from "./command.js";
+export type { Command, CommandInput, Reported } from "./command.js";
+export { type System, SYSTEMS, systemNamed, writtenWith, } from "./transcribe-command.js";
 /**
  * Every subcommand, in the order the help lists them.
  */

package/dist/cli/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AA8B9D,OAAO,EAEL,KAAK,QAAQ,EAGd,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAKL,KAAK,gBAAgB,EACrB,KAAK,KAAK,EACV,KAAK,QAAQ,EASb,KAAK,mBAAmB,EAIzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,OAAO,EAAwB,MAAM,aAAa,CAAC;AAEjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5C,oEAAoE;IACpE,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IAChD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,SAAS,QAAQ,EAAE,CAAC;CAC5D;AA2wBD;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM;IACrB,4CAA4C;IAC5C,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IAC/C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC;IAC7E;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AA6CD;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,SAAS,MAAM,EAMpC,CAAC;AAEF;;GAEG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,mBAAmB,GAAG,SAAS,GACpC,MAAM,GAAG,SAAS,CAEpB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,SAAS,EAAE,SAAS,QAAQ,EAAE,EAC9B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,GACb,MAAM,CAIR;AAkUD;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,OAAO,EAgBtC,CAAC;AAEF;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAE9D"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAe5C,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,KAAK,MAAM,EACX,OAAO,EACP,WAAW,EACX,WAAW,GACZ,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,OAAO,EAgBtC,CAAC;AAEF;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAE9D"}