@kensio/pinyinjs 1.7.4 → 1.7.6

package/dist/cli/arguments.d.ts

@@ -1,207 +1,11 @@
-import type { ConvertOptions } from "../decode/convert.js";
-import type { CheckOptions } from "../grade/check.js";
-import { type ScriptTarget } from "../decode/script.js";
-import type { ColourDepth } from "./colour.js";
-import type { Tier } from "../dictionary/tiers.js";
-import type { HtmlOptions } from "../format/html.js";
-import type { SlugOptions } from "../format/slug.js";
-import { type Script } from "../script/script.js";
-/**
- * Every flag the CLI accepts.
- *
- * One table rather than one per command, because the parser needs the whole set
- * up front; a command's own list is what rejects a flag it has no use for.
- * Negated forms are spelled out, since `parseArgs` has no `--no-` convention of
- * its own.
- */
-declare const FLAGS: {
-    readonly data: {
-        readonly type: "string";
-    };
-    readonly tier: {
-        readonly type: "string";
-    };
-    readonly notation: {
-        readonly type: "string";
-        readonly short: "n";
-    };
-    readonly locale: {
-        readonly type: "string";
-        readonly short: "l";
-    };
-    readonly apostrophe: {
-        readonly type: "string";
-    };
-    readonly capitals: {
-        readonly type: "string";
-    };
-    readonly punctuation: {
-        readonly type: "string";
-    };
-    readonly "no-grouping": {
-        readonly type: "boolean";
-    };
-    readonly "keep-numbers": {
-        readonly type: "boolean";
-    };
-    readonly "read-numbers": {
-        readonly type: "boolean";
-    };
-    readonly "third-tone": {
-        readonly type: "boolean";
-    };
-    readonly "no-sandhi": {
-        readonly type: "boolean";
-    };
-    readonly tones: {
-        readonly type: "string";
-    };
-    readonly "require-tones": {
-        readonly type: "boolean";
-    };
-    readonly "require-spacing": {
-        readonly type: "boolean";
-    };
-    readonly separator: {
-        readonly type: "string";
-    };
-    readonly syllables: {
-        readonly type: "string";
-    };
-    readonly umlaut: {
-        readonly type: "string";
-    };
-    readonly query: {
-        readonly type: "string";
-    };
-    readonly hash: {
-        readonly type: "boolean";
-    };
-    readonly "hash-length": {
-        readonly type: "string";
-    };
-    readonly "max-length": {
-        readonly type: "string";
-    };
-    readonly fallback: {
-        readonly type: "string";
-    };
-    readonly greedy: {
-        readonly type: "boolean";
-    };
-    readonly digits: {
-        readonly type: "boolean";
-    };
-    readonly yao: {
-        readonly type: "boolean";
-    };
-    readonly "no-liang": {
-        readonly type: "boolean";
-    };
-    readonly percent: {
-        readonly type: "boolean";
-    };
-    readonly from: {
-        readonly type: "string";
-    };
-    readonly to: {
-        readonly type: "string";
-    };
-    readonly "from-script": {
-        readonly type: "string";
-    };
-    readonly system: {
-        readonly type: "string";
-    };
-    readonly "no-tone-classes": {
-        readonly type: "boolean";
-    };
-    readonly "no-uncertain": {
-        readonly type: "boolean";
-    };
-    readonly "no-lang": {
-        readonly type: "boolean";
-    };
-    readonly colour: {
-        readonly type: "boolean";
-    };
-    readonly color: {
-        readonly type: "boolean";
-    };
-    readonly "no-colour": {
-        readonly type: "boolean";
-    };
-    readonly "no-color": {
-        readonly type: "boolean";
-    };
-    readonly json: {
-        readonly type: "boolean";
-    };
-    readonly help: {
-        readonly type: "boolean";
-        readonly short: "h";
-    };
-    readonly version: {
-        readonly type: "boolean";
-        readonly short: "v";
-    };
-};
-/**
- * A flag's name as it is written on the command line.
- */
-export type FlagName = keyof typeof FLAGS;
-/**
- * Flags every command takes, whatever else it takes.
- */
-export declare const GLOBAL_FLAGS: readonly FlagName[];
-/**
- * The flags that map onto `ConvertOptions`, and so belong to every command that
- * converts anything.
- */
-export declare const CONVERT_FLAGS: readonly FlagName[];
-/**
- * The flags `check` takes, beyond the conversion ones.
- *
- * Positive rather than negated — `--require-tones` rather than `--no-tones` —
- * because both dimensions default to lenient, and a flag naming what it turns
- * on is the one that reads the way the library's own option does.
- */
-export declare const CHECK_FLAGS: readonly FlagName[];
-/**
- * The flags `slug` takes, beyond the global ones.
- *
- * It shares the reading flags with the conversion commands and none of the
- * writing ones: a slug settles its own notation, capitals, apostrophes and
- * spacing, and a `--capitals` that changed nothing would be worse than an
- * error. `--read-numbers` rather than `--keep-numbers` because a slug keeps
- * digits by default, which is the one place it departs from `convert`.
- */
-export declare const SLUG_FLAGS: readonly FlagName[];
-/**
- * The flags `match` takes, beyond the global ones.
- *
- * The query is a flag rather than the first argument, so that the texts stay
- * where every other command has them: `match` reads a list to filter from
- * standard input, and a command line whose first positional meant something
- * else could not be piped into.
- */
-export declare const MATCH_FLAGS: readonly FlagName[];
+import { type FlagName, type Flags } from "./flags.js";
+export { UsageError } from "./usage-error.js";
+export { checkOptions, colourDepth, convertOptions, type DictionaryChoice, dictionaryChoice, htmlOptions, scriptFrom, scriptTarget, slugOptions, type TranscriptionSource, transcriptionSource, transcriptionSystem, } from "./options.js";
+export { CHECK_FLAGS, CONVERT_FLAGS, type FlagName, type Flags, GLOBAL_FLAGS, MATCH_FLAGS, SCRIPT_FLAGS, SLUG_FLAGS, } from "./flags.js";
 /**
  * Read the `--query` flag, which `match` cannot do without.
  */
 export declare function matchQuery(flags: Flags): string;
-/**
- * The flags `script` takes, beyond the global ones.
- *
- * `--from-script` rather than `--from` because `--from` already means the
- * transcription a text is written in, and one flag name cannot carry two
- * meanings in one help table.
- */
-export declare const SCRIPT_FLAGS: readonly FlagName[];
-/**
- * The flags a parse produced, before any command has looked at them.
- */
-export type Flags = Partial<Record<FlagName, string | boolean>>;
 /**
  * A command line that parsed.
  */
@@ -212,14 +16,6 @@ export interface ParsedArguments {
     readonly texts: readonly string[];
     readonly flags: Flags;
 }
-/**
- * Something the command line asked for that cannot be done.
- *
- * Thrown rather than exited on, so that the caller decides what a mistake at
- * the command line is worth.
- */
-export declare class UsageError extends Error {
-}
 /**
  * Split a command line into its command, its arguments and its flags.
  */
@@ -231,86 +27,4 @@ export declare function parseArguments(argv: readonly string[]): ParsedArguments
  * --no-uncertain` would look like it had been honoured.
  */
 export declare function checkFlags(flags: Flags, allowed: readonly FlagName[], command: string): void;
-/**
- * Which system the text handed to `transcribe` is written in.
- *
- * `auto` reads bopomofo as bopomofo and everything else as pinyin, which is as
- * far as detection can honestly go: bopomofo has a script of its own, while
- * `chi` is a well-formed spelling in both pinyin and Wade-Giles and means
- * different syllables in each.
- */
-export type TranscriptionSource = "auto" | "pinyin" | "wade-giles" | "bopomofo" | "yale" | "gwoyeu" | "ipa";
-/**
- * Read the `--from` flag.
- */
-export declare function transcriptionSource(flags: Flags): TranscriptionSource;
-/**
- * Read the `--system` flag.
- */
-export declare function transcriptionSystem(flags: Flags): TranscriptionSource | undefined;
-/**
- * How much colour a run should write, given what the terminal offered.
- *
- * `--colour` and `--no-colour` force it either way, and `--color` is accepted
- * as a spelling because every other tool spells it that way and nobody should
- * have to discover which this one chose.
- *
- * **`--json` is never coloured**, whatever the flags say: the option is about
- * the plain output, and the JSON already carries the tone as a number for a
- * caller that will do its own rendering.
- *
- * Forcing colour where the environment offered none — into a pipe, or past
- * `NO_COLOR` — gets the sixteen every terminal has, because nothing is known
- * about where that output is going.
- */
-export declare function colourDepth(flags: Flags, offered: ColourDepth): ColourDepth;
-/**
- * Which dictionary a run should read.
- */
-export interface DictionaryChoice {
-    readonly tier: Tier;
-    /** Where the artifacts are, or undefined for the ones that shipped. */
-    readonly directory: string | undefined;
-}
-/**
- * Read the dictionary flags.
- */
-export declare function dictionaryChoice(flags: Flags): DictionaryChoice;
-/**
- * Turn the conversion flags into the options the library takes.
- *
- * Only the flags actually given are passed on, so that the library's defaults
- * stay the CLI's defaults and there is one place they are written down.
- */
-export declare function convertOptions(flags: Flags): ConvertOptions;
-/**
- * Turn the checking flags into the options the library takes.
- *
- * Every conversion flag goes through too, since a check grades against a
- * conversion and `--locale` or `--third-tone` changes what the answer is.
- */
-export declare function checkOptions(flags: Flags): CheckOptions;
-/**
- * Turn the slug flags into the options the library takes.
- *
- * `--hash-length` implies `--hash`, because asking how long the hash should be
- * and not getting one is not a reading anybody intends.
- */
-export declare function slugOptions(flags: Flags): SlugOptions;
-/**
- * The same, plus the three flags that only mean anything in HTML.
- */
-export declare function htmlOptions(flags: Flags): HtmlOptions;
-/**
- * Which orthography `script` was asked to write. `zh-Hans` by default.
- */
-export declare function scriptTarget(flags: Flags): ScriptTarget;
-/**
- * The script the text was declared to be in, where the caller named one.
- *
- * Detection settles it otherwise, and gets it right for anything longer than a
- * word or two. Naming it matters for text short enough to be script-neutral.
- */
-export declare function scriptFrom(flags: Flags): Script | undefined;
-export {};
 //# sourceMappingURL=arguments.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"arguments.d.ts","sourceRoot":"","sources":["../../src/cli/arguments.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,KAAK,YAAY,EAAkB,MAAM,qBAAqB,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EAIZ,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAAE,KAAK,MAAM,EAAW,MAAM,qBAAqB,CAAC;AAI3D;;;;;;;GAOG;AACH,QAAA,MAAM,KAAK;;iBACD,IAAI,EAAE,QAAQ;;;iBACd,IAAI,EAAE,QAAQ;;;iBACV,IAAI,EAAE,QAAQ;iBAAE,KAAK,EAAE,GAAG;;;iBAC5B,IAAI,EAAE,QAAQ;iBAAE,KAAK,EAAE,GAAG;;;iBACtB,IAAI,EAAE,QAAQ;;;iBAChB,IAAI,EAAE,QAAQ;;;iBACX,IAAI,EAAE,QAAQ;;;iBACZ,IAAI,EAAE,SAAS;;;iBACd,IAAI,EAAE,SAAS;;;iBACf,IAAI,EAAE,SAAS;;;iBACjB,IAAI,EAAE,SAAS;;;iBAChB,IAAI,EAAE,SAAS;;;iBACrB,IAAI,EAAE,QAAQ;;;iBACJ,IAAI,EAAE,SAAS;;;iBACb,IAAI,EAAE,SAAS;;;iBACvB,IAAI,EAAE,QAAQ;;;iBACd,IAAI,EAAE,QAAQ;;;iBACjB,IAAI,EAAE,QAAQ;;;iBACf,IAAI,EAAE,QAAQ;;;iBACf,IAAI,EAAE,SAAS;;;iBACN,IAAI,EAAE,QAAQ;;;iBACf,IAAI,EAAE,QAAQ;;;iBAClB,IAAI,EAAE,QAAQ;;;iBAChB,IAAI,EAAE,SAAS;;;iBACf,IAAI,EAAE,SAAS;;;iBAClB,IAAI,EAAE,SAAS;;;iBACR,IAAI,EAAE,SAAS;;;iBAClB,IAAI,EAAE,SAAS;;;iBAClB,IAAI,EAAE,QAAQ;;;iBAChB,IAAI,EAAE,QAAQ;;;iBACH,IAAI,EAAE,QAAQ;;;iBACrB,IAAI,EAAE,QAAQ;;;iBACH,IAAI,EAAE,SAAS;;;iBAClB,IAAI,EAAE,SAAS;;;iBACpB,IAAI,EAAE,SAAS;;;iBAClB,IAAI,EAAE,SAAS;;;iBAChB,IAAI,EAAE,SAAS;;;iBACT,IAAI,EAAE,SAAS;;;iBAChB,IAAI,EAAE,SAAS;;;iBACrB,IAAI,EAAE,SAAS;;;iBACf,IAAI,EAAE,SAAS;iBAAE,KAAK,EAAE,GAAG;;;iBACxB,IAAI,EAAE,SAAS;iBAAE,KAAK,EAAE,GAAG;;CACoB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,KAAK,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,QAAQ,EAU3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,QAAQ,EAU5C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS,QAAQ,EAG1C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,SAAS,QAAQ,EAazC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS,QAAQ,EAAc,CAAC;AAE1D;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAM/C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,QAAQ,EAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;CACvB;AAED;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,eAAe,CAiBvE;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,SAAS,QAAQ,EAAE,EAC5B,OAAO,EAAE,MAAM,GACd,IAAI,CAMN;AAgED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,MAAM,GACN,QAAQ,GACR,KAAK,CAAC;AAYV;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,mBAAmB,CAErE;AAiBD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,KAAK,GACX,mBAAmB,GAAG,SAAS,CAEjC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,GAAG,WAAW,CAW3E;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,uEAAuE;IACvE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,gBAAgB,CAM/D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAqB3D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,YAAY,CAMvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CA4BrD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAOrD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,YAAY,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAE3D"}
+{"version":3,"file":"arguments.d.ts","sourceRoot":"","sources":["../../src/cli/arguments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,KAAK,QAAQ,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAG9D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,WAAW,EACX,cAAc,EACd,KAAK,gBAAgB,EACrB,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,WAAW,EACX,KAAK,mBAAmB,EACxB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,WAAW,EACX,aAAa,EACb,KAAK,QAAQ,EACb,KAAK,KAAK,EACV,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,UAAU,GACX,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAM/C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;CACvB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,eAAe,CAiBvE;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,SAAS,QAAQ,EAAE,EAC5B,OAAO,EAAE,MAAM,GACd,IAAI,CAMN"}