@johnmorrisdotca/taisen-brackets 0.1.0 → 0.2.0

package/dist/types.d.ts

@@ -21,6 +21,10 @@ export interface Team {
     group?: string;
     /** A colour for the team's initials when it has no mark, any CSS colour. */
     color?: string;
+    /** The name in other languages, by locale code: `{ fr: "Allemagne", ja: "ドイツ" }`. The language of a drawing picks its own, else `name`. */
+    names?: Readonly<Record<string, string>>;
+    /** An ISO 3166 region code (`DE`), for `countryName` and a `teamName` that uses it. */
+    region?: string;
 }
 /** One game of a tie: a match of a knockout, a game of a series, a leg of an aggregate, a replay. */
 export interface Game {
@@ -86,6 +90,8 @@ export interface Matchup {
     pens?: readonly [number, number];
     /** The game with no `games` list went to extra time. */
     extraTime?: boolean;
+    /** The tie was settled without a game (a side withdrew): the note says so. */
+    walkover?: boolean;
     /** This is the third-place match: it leads nowhere and is drawn apart. */
     third?: boolean;
     note?: string;
@@ -121,6 +127,7 @@ export interface Tie {
     date: string;
     no: number | null;
     third: boolean;
+    walkover: boolean;
     note: string | null;
 }
 /** Where the layout put a tie. */
@@ -193,38 +200,73 @@ export interface LayoutOptions {
     /** The order of the halves' groups, first on the left: `["West", "East"]`. Left out, a name with "west" goes left and one with "east" right. */
     groupOrder?: readonly string[];
 }
-/** The words a drawing and a table use. Every one can be replaced (`words`). */
+/** The words a drawing and a table use, in one language. Every one can be replaced (`words`), and a language can be added (`defineLocale`). Phrases take `{name}`-style holes. */
 export interface Words {
+    /** A side not known yet. */
     tbd: string;
+    /** The word beside the score of a side that had a bye. */
     bye: string;
+    /** A tie decided without a game (`Matchup.walkover`). */
+    walkover: string;
+    /** The label under the champion. */
     champion: string;
     thirdPlace: string;
     /** The heading over ties that lead nowhere near the final. */
     other: string;
-    final: string;
+    /** Short notes in a box: after extra time, penalties, aggregate, replay. */
     aet: string;
     pens: string;
     aggregate: string;
     replay: string;
-    /** `{n}` is the number of games: "in 7". */
+    /** The same in a sentence (tooltip, table, description). */
+    aetLong: string;
+    /** `{a}`, `{b}`: the shoot-out's score. */
+    pensScore: string;
+    aggregateLong: string;
+    /** `{n}`: "in 7" (games). */
     inGames: string;
-    /** `{n}`: "Best of 7". */
+    /** `{n}` games, `{w}` wins that settle it: "best of 7". */
     bestOf: string;
-    /** `{n}`: "Round 3" for a round with no name. */
+    /** `{n}`: a round with no name. */
     round: string;
-    winner: string;
-    versus: string;
-    /** The table's column titles. */
-    columnRound: string;
-    columnTie: string;
-    columnResult: string;
-    columnNote: string;
+    /** `{n}`: "Round of 64", for a round the language has no word of its own for. */
+    roundOf: string;
+    /** `{a}`, `{b}`: an undecided tie. */
+    tieVs: string;
+    /** `{a}`, `{b}` the names, `{sa}`, `{sb}` the scores. */
+    tieScore: string;
+    /** `{a}`, `{b}`: a score as written ("3–1"). */
+    scoreText: string;
+    /** `{name}`. */
+    winnerIs: string;
+    championIs: string;
+    /** `{round}`, `{tie}`. */
+    finalLine: string;
     /** `{n}` teams, `{r}` rounds. */
     summary: string;
-    /** The same for a bracket of one round. */
     summaryOne: string;
+    /** Joins the sentences of a description, and ends it. */
+    sep: string;
+    end: string;
+    /** `{notes}`: the notes after a tie in a sentence; and what joins several notes. */
+    note: string;
+    noteJoin: string;
+    columnRound: string;
+    columnTie: string;
+    columnNote: string;
+    columnDate: string;
+    /** The `<title>` of a drawing with no `title` option. */
     title: string;
 }
+/** A language: its words, the names of the rounds (by their English names), and the tag `Intl` formats numbers and dates for. */
+export interface Locale {
+    /** The code (`fr`) and the tag (`fr-CA`, `ja-JP`) used for numbers, dates and capitals. */
+    code: string;
+    tag: string;
+    words: Words;
+    /** Round names by their English name: `{ "Round of 16": "Huitièmes de finale" }`. A round with no entry keeps its name (or `roundOf`). */
+    rounds: Readonly<Record<string, string>>;
+}
 export type ThemeName = "auto" | "light" | "dark" | "poster" | "none";
 export type SizeName = "wide" | "square" | "phone";
 export interface Size {
@@ -272,8 +314,12 @@ export interface DrawOptions extends LayoutOptions {
     thirdPlace?: "below" | "hide";
     /** Highlight the side that went through. Default true. */
     winnerHighlight?: boolean;
-    /** The words, in another language or your own. */
+    /** The language: `en` (the default), `fr`, `ja`, `es`, `de`, or a `Locale` you made with `defineLocale`. Sets the words, the round names, the number and date formats and the `lang` of the drawing. */
+    locale?: string | Locale;
+    /** Replace any of the language's words. */
     words?: Partial<Words>;
+    /** The name to draw for a team in this language: `undefined` keeps `Team.names[locale]` or `Team.name`. `countryName(team.region, locale)` makes a country's name from Intl, with no list of your own. */
+    teamName?: (team: Team, locale: Locale) => string | undefined;
     /** Prefix for the drawing's ids. Default: a hash of the bracket and the options. */
     id?: string;
     /** Extra class names for the root `<svg>`. */

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.1.0";
+export const VERSION = "0.2.0";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@johnmorrisdotca/taisen-brackets",
-  "version": "0.1.0",
-  "description": "Taisen \u5bfe\u6226, knockout brackets as SVG: from a list of ties (games, best-of series, two legs, replays, byes, a third-place match) it works out the rounds and halves and draws the bracket with the halves meeting at the final, or left to right, wide, square or for a phone, in light, dark or a gold-on-navy poster look, with each team's logo or round flag, the champion in the centre, and an accessible table. NHL, NBA, MLB, NFL, CFL and World Cup formats by era. Zero dependencies.",
+  "version": "0.2.0",
+  "description": "Taisen Brackets 対戦, knockout brackets as SVG: from a list of ties (games, best-of series, two legs, replays, byes, a third-place match) it works out the rounds and halves and draws the bracket with the halves meeting at the final, or left to right, wide, square or for a phone, in light, dark or a gold-on-navy poster look, with each team's logo or round flag, the champion in the centre, and an accessible table. NHL, NBA, MLB, NFL, CFL and World Cup formats by era, in English, French, Japanese, Spanish and German. Zero dependencies.",
   "keywords": [
     "bracket",
     "tournament",
@@ -19,6 +19,8 @@
     "cfl",
     "soccer",
     "sports",
+    "multilingual",
+    "i18n",
     "visualization",
     "accessible",
     "dark-mode",
@@ -77,9 +79,10 @@
     "typecheck": "tsc -p tsconfig.check.json",
     "test": "node --test test/*.test.ts",
     "test:package": "pnpm build && node scripts/check-package.mjs",
-    "test:readme": "pnpm build && node scripts/make-formats-doc.mjs --check && node scripts/check-readme-examples.mjs",
+    "test:readme": "pnpm build && node scripts/make-formats-doc.mjs --check && node scripts/make-languages-doc.mjs --check && node scripts/check-readme-examples.mjs",
     "check": "pnpm lint && pnpm typecheck && pnpm test && pnpm build && node scripts/check-package.mjs",
     "prepublishOnly": "pnpm check",
+    "family:readme": "node scripts/family-readme.mjs",
     "dev": "pnpm build && node scripts/dev.mjs",
     "flags": "node scripts/make-flags.mjs",
     "site": "pnpm build && node scripts/site.mjs",

package/dist/words.d.ts

@@ -1,7 +0,0 @@
-import type { Words } from "./types.ts";
-/** The English words of a drawing and a table. Pass `words` to replace any of them. */
-export declare const WORDS: Readonly<Words>;
-/** The words with any replacements applied. */
-export declare function wordsWith(over?: Partial<Words>): Words;
-/** Fills `{n}`-style holes in a phrase. */
-export declare function fill(phrase: string, values: Record<string, string | number>): string;

package/dist/words.js

@@ -1,33 +0,0 @@
-/** The English words of a drawing and a table. Pass `words` to replace any of them. */
-export const WORDS = Object.freeze({
-    tbd: "TBD",
-    bye: "bye",
-    champion: "Champion",
-    thirdPlace: "Third place",
-    other: "Other ties",
-    final: "Final",
-    aet: "a.e.t.",
-    pens: "pens",
-    aggregate: "agg.",
-    replay: "replay",
-    inGames: "in {n}",
-    bestOf: "best of {n}",
-    round: "Round {n}",
-    winner: "Winner",
-    versus: "v",
-    columnRound: "Round",
-    columnTie: "Tie",
-    columnResult: "Result",
-    columnNote: "Note",
-    summary: "{n} teams, {r} rounds",
-    summaryOne: "{n} teams, 1 round",
-    title: "Knockout bracket",
-});
-/** The words with any replacements applied. */
-export function wordsWith(over) {
-    return { ...WORDS, ...over };
-}
-/** Fills `{n}`-style holes in a phrase. */
-export function fill(phrase, values) {
-    return phrase.replace(/\{(\w+)\}/g, (hole, key) => (key in values ? String(values[key]) : hole));
-}