@stats-forge/github-stats-forge-cli 0.0.2 → 0.2.0

package/README.md

@@ -21,7 +21,7 @@ Requires Node 24 or newer. The cards themselves come from
 so every option below is the one that package's api accepts — the prompts read the
 accepted values off it rather than keeping their own copy.
 
-It asks which card you want, then the params that card cannot render without, then
+It asks which card you want, then the options that card cannot render without, then
 puts you in a menu of every other option it accepts — pick one, answer it, and the
 menu comes back with the answer beside it. `Generate the card` writes the SVG.
 
@@ -43,7 +43,7 @@ again. `Quit` (or Ctrl-C) ends the session.
 
 ## Saving a card
 
-`Save these options` in the menu writes the card and its params to a JSON file, and
+`Save these options` in the menu writes the card and its options to a JSON file, and
 `--config` loads one back:
 
 ```sh
@@ -53,7 +53,7 @@ github-stats-forge --config my-stats.json      # picks up where the file left of
 ```json
 {
   "card": "stats",
-  "params": {
+  "options": {
     "username": "anuraghazra",
     "theme": "tokyonight",
     "show_icons": "true"
@@ -63,7 +63,7 @@ github-stats-forge --config my-stats.json      # picks up where the file left of
 
 The file holds what a query string holds, so it reads like the URL it stands for and
 can be edited by hand. Loading one skips both the card prompt and the required
-params, landing you straight on the menu — and `--config` doubles as the save target,
+options, landing you straight on the menu — and `--config` doubles as the save target,
 so the next `Save these options` writes back to it without asking.
 
 `--generate` skips the menu too, rendering exactly what the file holds:

package/build/cards.d.ts

@@ -1,4 +1,4 @@
-import type { ApiResult, CardConfig } from '@stats-forge/github-stats-forge-core';
+import type { ApiResult, CardConfig } from '@stats-forge/github-stats-forge-core/api';
 /**
  * @file What each card accepts, in the order the prompts walk it.
  *
@@ -14,7 +14,7 @@ export interface CardOption {
     /** What the prompt asks. */
     label: string;
     kind: OptionKind;
-    /** The accepted values, for `choice`. */
+    /** The accepted values, for `choice` and for a `list` whose values are a closed set. */
     choices?: ReadonlyArray<string>;
     /** Shown under the prompt, for anything the label cannot say. */
     hint?: string;
@@ -29,17 +29,12 @@ export interface CardKind {
     required: ReadonlyArray<CardOption>;
     /** Everything else, navigable in any order. */
     options: ReadonlyArray<CardOption>;
-    /**
-     * @param query The answers, as a query string would carry them.
-     * @param config Tokens the fetchers use.
-     * @returns The rendered card, or the rendered error.
-     */
+    /** @returns The rendered card, or the rendered error. */
     render: (query: Record<string, string>, config: CardConfig) => Promise<ApiResult>;
 }
 /** Every card, with the options every card shares appended to its own. */
 export declare const cards: ReadonlyArray<CardKind>;
 /**
- * @param id The card's id, as `--card` takes it.
  * @returns The card, or `undefined` when nothing renders under that name.
  */
 export declare const findCard: (id: string) => CardKind | undefined;

package/build/cards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../src/cards.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;;;GAKG;AAEH,iFAAiF;AACjF,KAAK,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEpE,6BAA6B;AAC7B,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;IACjB,yCAAyC;IACzC,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAChC,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,gEAAgE;AAChE,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,UAAU,EAAE,OAAO,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,+CAA+C;IAC/C,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC;;;;OAIG;IACH,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;CACnF;AAkSD,0EAA0E;AAC1E,eAAO,MAAM,KAAK,EAAE,aAAa,CAAC,QAAQ,CAGvC,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,IAAI,MAAM,KAAG,QAAQ,GAAG,SAAiD,CAAC"}
+{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../src/cards.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEtF;;;;;GAKG;AAEH,iFAAiF;AACjF,KAAK,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEpE,6BAA6B;AAC7B,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;IACjB,wFAAwF;IACxF,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAChC,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,gEAAgE;AAChE,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,UAAU,EAAE,OAAO,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,+CAA+C;IAC/C,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,yDAAyD;IACzD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;CACnF;AAqVD,0EAA0E;AAC1E,eAAO,MAAM,KAAK,EAAE,aAAa,CAAC,QAAQ,CAGvC,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,QAAQ,OAAQ,MAAM,KAAG,QAAQ,GAAG,SAAiD,CAAC"}

package/build/cards.js

@@ -1,4 +1,4 @@
-import { gist, pin, stats, themes, topLangs, wakatime } from '@stats-forge/github-stats-forge-core';
+import { contributedTo, gist, pin, stats, themes, topLangs, wakatime, } from '@stats-forge/github-stats-forge-core/api';
 const THEME_NAMES = Object.keys(themes);
 /** Colors and the theme, which every card accepts. */
 const COMMON_OPTIONS = [
@@ -32,6 +32,18 @@ const COMMON_OPTIONS = [
     { name: 'border_radius', label: 'Border radius', kind: 'number' },
     { name: 'hide_border', label: 'Hide the border', kind: 'boolean' },
 ];
+/**
+ * The two ends of a card's date range.
+ *
+ * @returns The pair, naming what it counts.
+ */
+const rangeOptions = (counted) => {
+    const hint = 'A year, a month or a day: 2024, 2024-03, 2024-03-15';
+    return [
+        { name: 'from', label: `Count ${counted} from`, kind: 'text', hint },
+        { name: 'to', label: `Count ${counted} up to`, kind: 'text', hint },
+    ];
+};
 const LOCALE_OPTION = {
     name: 'locale',
     label: 'Locale',
@@ -49,13 +61,13 @@ const CARDS = [
                 name: 'show',
                 label: 'Extra stats to show',
                 kind: 'list',
-                hint: 'e.g. reviews,discussions_started,prs_merged,contributions',
+                choices: stats.OPTIONS.show,
             },
             {
                 name: 'hide',
                 label: 'Stats to hide',
                 kind: 'list',
-                hint: 'e.g. stars,commits,prs,issues,contribs',
+                choices: stats.OPTIONS.hide,
             },
             { name: 'show_icons', label: 'Show the stat icons', kind: 'boolean' },
             { name: 'hide_rank', label: 'Hide the rank circle', kind: 'boolean' },
@@ -63,19 +75,14 @@ const CARDS = [
                 name: 'rank_icon',
                 label: 'Rank indicator',
                 kind: 'choice',
-                choices: stats.RANK_ICONS,
+                choices: stats.OPTIONS.rank_icon,
             },
             {
                 name: 'include_all_commits',
                 label: 'Count commits of all time',
                 kind: 'boolean',
             },
-            {
-                name: 'commits_year',
-                label: 'Count commits for one year',
-                kind: 'number',
-                hint: 'Four digits, e.g. 2025',
-            },
+            ...rangeOptions('commits'),
             {
                 name: 'exclude_repo',
                 label: 'Repositories to exclude',
@@ -95,7 +102,7 @@ const CARDS = [
                 name: 'role',
                 label: 'Owner affiliations to include',
                 kind: 'list',
-                hint: 'OWNER, COLLABORATOR, ORGANIZATION_MEMBER',
+                choices: stats.OPTIONS.role,
             },
             {
                 name: 'contribs_include_own_repos',
@@ -111,7 +118,7 @@ const CARDS = [
                 name: 'number_format',
                 label: 'Number format',
                 kind: 'choice',
-                choices: ['short', 'long'],
+                choices: stats.OPTIONS.number_format,
             },
             {
                 name: 'number_precision',
@@ -126,7 +133,7 @@ const CARDS = [
             { name: 'ring_color', label: 'Rank ring color', kind: 'text' },
             LOCALE_OPTION,
         ],
-        render: (query, config) => stats(query, config),
+        render: stats,
     },
     {
         id: 'top-langs',
@@ -138,7 +145,7 @@ const CARDS = [
                 name: 'layout',
                 label: 'Layout',
                 kind: 'choice',
-                choices: topLangs.LAYOUTS,
+                choices: topLangs.OPTIONS.layout,
             },
             { name: 'langs_count', label: 'Languages to show', kind: 'number' },
             { name: 'hide', label: 'Languages to hide', kind: 'list' },
@@ -157,7 +164,7 @@ const CARDS = [
                 name: 'stats_format',
                 label: 'Show values as',
                 kind: 'choice',
-                choices: topLangs.STATS_FORMATS,
+                choices: topLangs.OPTIONS.stats_format,
             },
             {
                 name: 'hide_progress',
@@ -170,7 +177,12 @@ const CARDS = [
                 label: 'Progress bar background color',
                 kind: 'text',
             },
-            { name: 'role', label: 'Owner affiliations to include', kind: 'list' },
+            {
+                name: 'role',
+                label: 'Owner affiliations to include',
+                kind: 'list',
+                choices: topLangs.OPTIONS.role,
+            },
             { name: 'custom_title', label: 'Card title', kind: 'text' },
             { name: 'hide_title', label: 'Hide the title', kind: 'boolean' },
             { name: 'card_width', label: 'Card width', kind: 'number' },
@@ -181,7 +193,7 @@ const CARDS = [
             },
             LOCALE_OPTION,
         ],
-        render: (query, config) => topLangs(query, config),
+        render: topLangs,
     },
     {
         id: 'pin',
@@ -197,7 +209,7 @@ const CARDS = [
                 name: 'show',
                 label: 'Extra stats to show',
                 kind: 'list',
-                hint: 'e.g. prs_authored,issues_commented',
+                choices: pin.OPTIONS.show,
             },
             { name: 'show_icons', label: 'Show the stat icons', kind: 'boolean' },
             {
@@ -217,11 +229,48 @@ const CARDS = [
                 name: 'number_format',
                 label: 'Number format',
                 kind: 'choice',
-                choices: ['short', 'long'],
+                choices: pin.OPTIONS.number_format,
+            },
+            LOCALE_OPTION,
+        ],
+        render: pin,
+    },
+    {
+        id: 'contributed-to',
+        label: 'Contributed to — repositories you work on, ranked',
+        needsToken: true,
+        required: [{ name: 'username', label: 'GitHub username', kind: 'text' }],
+        options: [
+            { name: 'repos_count', label: 'Repositories to show', kind: 'number' },
+            {
+                name: 'include_own_repos',
+                label: 'Include your own repositories',
+                kind: 'boolean',
+            },
+            {
+                name: 'exclude_repo',
+                label: 'Repositories to exclude',
+                kind: 'list',
+                hint: 'Each one an owner/name, or just the name',
+            },
+            ...rangeOptions('contributions'),
+            {
+                name: 'hide_years',
+                label: 'Hide the year marks',
+                kind: 'boolean',
+                hint: 'One mark per contribution year, filled for the years that repo got one',
+            },
+            { name: 'custom_title', label: 'Card title', kind: 'text' },
+            { name: 'hide_title', label: 'Hide the title', kind: 'boolean' },
+            { name: 'card_width', label: 'Card width', kind: 'number' },
+            {
+                name: 'disable_animations',
+                label: 'Disable the animations',
+                kind: 'boolean',
             },
             LOCALE_OPTION,
         ],
-        render: (query, config) => pin(query, config),
+        render: contributedTo,
     },
     {
         id: 'gist',
@@ -235,8 +284,9 @@ const CARDS = [
                 label: 'Let the browser wrap the description',
                 kind: 'boolean',
             },
+            LOCALE_OPTION,
         ],
-        render: (query, config) => gist(query, config),
+        render: gist,
     },
     {
         id: 'wakatime',
@@ -248,13 +298,13 @@ const CARDS = [
                 name: 'layout',
                 label: 'Layout',
                 kind: 'choice',
-                choices: wakatime.LAYOUTS,
+                choices: wakatime.OPTIONS.layout,
             },
             {
                 name: 'display_format',
                 label: 'Show values as',
                 kind: 'choice',
-                choices: wakatime.DISPLAY_FORMATS,
+                choices: wakatime.OPTIONS.display_format,
             },
             { name: 'langs_count', label: 'Languages to show', kind: 'number' },
             { name: 'hide', label: 'Languages to hide', kind: 'list' },
@@ -280,7 +330,7 @@ const CARDS = [
             },
             LOCALE_OPTION,
         ],
-        render: (query, config) => wakatime(query, config),
+        render: wakatime,
     },
 ];
 /** Every card, with the options every card shares appended to its own. */
@@ -289,7 +339,6 @@ export const cards = CARDS.map((card) => ({
     options: [...card.options, ...COMMON_OPTIONS],
 }));
 /**
- * @param id The card's id, as `--card` takes it.
  * @returns The card, or `undefined` when nothing renders under that name.
  */
 export const findCard = (id) => cards.find((card) => card.id === id);

package/build/index.js

@@ -2,7 +2,7 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { relative, resolve } from 'node:path';
 import { parseArgs } from 'node:util';
-import { CardConfig } from '@stats-forge/github-stats-forge-core';
+import { CardConfig } from '@stats-forge/github-stats-forge-core/api';
 import { cards, findCard } from './cards.js';
 import { askRequired, askSavePath, askToken, navigateOptions, pickCard } from './prompts.js';
 import { defaultFileName, toQuery } from './query.js';
@@ -45,24 +45,20 @@ const readFlags = () => parseArgs({
 /**
  * Renders a card and writes it next to wherever the run was started.
  *
- * @param card The card to render.
- * @param query Its params.
- * @param config Tokens the fetchers use.
- * @param out Where to write it; named after the card when absent.
  * @returns The file written, or the code that says why nothing was.
  */
 const renderAndWrite = async (card, query, config, out) => {
     const result = await withSpinner(`Rendering the ${card.id} card`, () => card.render(query, config));
     if (result.status === 'error') {
         const { code, message, secondaryMessage, param } = result.error;
-        process.stderr.write([
+        process.stderr.write(`${[
             `Could not render the ${card.id} card.`,
             `  ${message}${secondaryMessage ? `: ${secondaryMessage}` : ''}`,
             `  code: ${code}${param ? `, param: ${param}` : ''}`,
             result.retryable ? '  This one may work on a retry.' : '',
         ]
             .filter(Boolean)
-            .join('\n') + '\n');
+            .join('\n')}\n`);
         return { failed: code };
     }
     const file = resolve(process.cwd(), out ?? defaultFileName(card, query));
@@ -73,6 +69,7 @@ const renderAndWrite = async (card, query, config, out) => {
 };
 /**
  * Renders one card and writes it next to wherever the run was started.
+ * Sets a non-zero exit code rather than throwing when it could not.
  *
  * @returns Nothing; the process exits non-zero when the card could not be rendered.
  */
@@ -130,14 +127,14 @@ const main = async () => {
     const config = new CardConfig({ pats: tokens });
     // `--generate` renders what the file holds and stops: no menu, nothing to answer.
     if (saved && flags.generate) {
-        const outcome = await renderAndWrite(card, saved.params, config, flags.out);
+        const outcome = await renderAndWrite(card, saved.options, config, flags.out);
         if ('failed' in outcome) {
             process.exitCode = 1;
         }
         return;
     }
     const menu = {
-        answers: saved ? toAnswers(card, saved.params) : await askRequired(card),
+        answers: saved ? toAnswers(card, saved.options) : await askRequired(card),
     };
     let savePath = flags.config;
     /*
@@ -180,13 +177,13 @@ const main = async () => {
 try {
     await main();
 }
-catch (err) {
+catch (error) {
     // A cancelled prompt is a normal way to leave, not a crash.
-    if (err instanceof Error && err.name === 'ExitPromptError') {
+    if (error instanceof Error && error.name === 'ExitPromptError') {
         process.exitCode = 130;
     }
     else {
-        process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+        process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
         process.exitCode = 1;
     }
 }

package/build/prompts.d.ts

@@ -1,14 +1,12 @@
-import type { CardKind, CardOption } from './cards.js';
-import type { Answer } from './query.js';
+import type { CardKind, CardOption } from './cards.ts';
+import type { Answer } from './query.ts';
 /**
  * @file The navigation itself.
  *
- * A card first, then its required params, then a menu of every other option:
+ * A card first, then its required options, then a menu of every other option:
  * pick one, answer it, and land back on the menu with the answer beside it.
  */
-/**
- * @returns The card to render.
- */
+/** @returns The card to render. */
 export declare const pickCard: () => Promise<CardKind>;
 /** How a trip through the option menu ended. */
 export type MenuChoice = 'generate' | 'save' | 'quit';
@@ -29,23 +27,18 @@ export interface Menu {
  * The menu is edited in place, so reopening it after a render keeps every answer
  * and the cursor exactly where they were.
  *
- * @param card The card being built.
- * @param menu Answers so far, and where the cursor sat.
- * @param status What happened last time round, shown in the menu's own line.
  * @returns Whether to render the card or to stop.
  */
 export declare const navigateOptions: (card: CardKind, menu: Menu, status?: string) => Promise<MenuChoice>;
 /**
- * Asks for the params the card cannot render without.
+ * Asks for the options the card cannot render without.
  *
- * @param card The card being built.
  * @returns The answers, one per required param.
  */
 export declare const askRequired: (card: CardKind) => Promise<Map<string, Answer>>;
 /**
  * Asks where to write the options, when no `--config` said.
  *
- * @param suggestion The path offered by default.
  * @returns The path, or `undefined` when the run changed its mind.
  */
 export declare const askSavePath: (suggestion: string) => Promise<string | undefined>;

package/build/prompts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../src/prompts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGzC;;;;;GAKG;AAEH;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,QAAQ,CAI9C,CAAC;AA+BL,gDAAgD;AAChD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtD,sDAAsD;AACtD,MAAM,WAAW,IAAI;IACnB,uCAAuC;IACvC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;CAC9C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAC1B,MAAM,QAAQ,EACd,MAAM,IAAI,EACV,SAAS,MAAM,KACd,OAAO,CAAC,UAAU,CAkCpB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAU,MAAM,QAAQ,KAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAY7E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAU,YAAY,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAMhF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAM3D,CAAC"}
+{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../src/prompts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGzC;;;;;GAKG;AAEH,mCAAmC;AACnC,eAAO,MAAM,QAAQ,QAAO,OAAO,CAAC,QAAQ,CAIxC,CAAC;AAuCL,gDAAgD;AAChD,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtD,sDAAsD;AACtD,MAAM,WAAW,IAAI;IACnB,uCAAuC;IACvC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;CAC9C;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,SACpB,QAAQ,QACR,IAAI,WACD,MAAM,KACd,OAAO,CAAC,UAAU,CAmCpB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,SAAgB,QAAQ,KAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAY7E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,eAAsB,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAMhF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,MAAM,GAAG,SAAS,CAM3D,CAAC"}

package/build/prompts.js

@@ -1,24 +1,20 @@
-import { confirm, input, password, select } from '@inquirer/prompts';
+import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
 import { cards } from './cards.js';
 import { describeAnswer } from './query.js';
 /**
  * @file The navigation itself.
  *
- * A card first, then its required params, then a menu of every other option:
+ * A card first, then its required options, then a menu of every other option:
  * pick one, answer it, and land back on the menu with the answer beside it.
  */
-/**
- * @returns The card to render.
- */
-export const pickCard = async () => select({
+/** @returns The card to render. */
+export const pickCard = () => select({
     message: 'Which card?',
     choices: cards.map((card) => ({ name: card.label, value: card })),
 });
 /**
  * Asks for one option, seeded with whatever it already holds.
  *
- * @param option The option to ask for.
- * @param current What it holds now.
  * @returns The answer, or `undefined` when it was cleared.
  */
 const askOption = async (option, current) => {
@@ -26,6 +22,15 @@ const askOption = async (option, current) => {
     if (option.kind === 'boolean') {
         return confirm({ message, default: current === true });
     }
+    if (option.kind === 'list' && option.choices) {
+        const chosen = new Set(Array.isArray(current) ? current : []);
+        const picked = await checkbox({
+            message,
+            pageSize: 15,
+            choices: option.choices.map((value) => ({ value, checked: chosen.has(value) })),
+        });
+        return picked.length > 0 ? picked : undefined;
+    }
     if (option.kind === 'choice') {
         const choices = [
             { name: '— leave unset —', value: undefined },
@@ -45,9 +50,6 @@ const askOption = async (option, current) => {
  * The menu is edited in place, so reopening it after a render keeps every answer
  * and the cursor exactly where they were.
  *
- * @param card The card being built.
- * @param menu Answers so far, and where the cursor sat.
- * @param status What happened last time round, shown in the menu's own line.
  * @returns Whether to render the card or to stop.
  */
 export const navigateOptions = async (card, menu, status) => {
@@ -58,7 +60,8 @@ export const navigateOptions = async (card, menu, status) => {
             message: status ? `${name} — ${status}` : `${name} — set an option, or generate`,
             pageSize: 15,
             // Matched by reference against the values below, so the option objects work.
-            default: menu.cursor,
+            // `default` does not accept an explicit undefined, so an unset cursor omits it.
+            ...(menu.cursor !== undefined && { default: menu.cursor }),
             choices: [
                 { name: 'Generate the card', value: 'generate' },
                 { name: 'Save these options', value: 'save' },
@@ -83,9 +86,8 @@ export const navigateOptions = async (card, menu, status) => {
     }
 };
 /**
- * Asks for the params the card cannot render without.
+ * Asks for the options the card cannot render without.
  *
- * @param card The card being built.
  * @returns The answers, one per required param.
  */
 export const askRequired = async (card) => {
@@ -101,7 +103,6 @@ export const askRequired = async (card) => {
 /**
  * Asks where to write the options, when no `--config` said.
  *
- * @param suggestion The path offered by default.
  * @returns The path, or `undefined` when the run changed its mind.
  */
 export const askSavePath = async (suggestion) => {

package/build/query.d.ts

@@ -1,4 +1,4 @@
-import type { CardKind, CardOption } from './cards.js';
+import type { CardKind, CardOption } from './cards.ts';
 /**
  * @file Answers in, query params out.
  *
@@ -8,29 +8,23 @@ import type { CardKind, CardOption } from './cards.js';
 /** What a prompt answered, before it becomes a query param. */
 export type Answer = string | number | boolean | Array<string> | undefined;
 /**
- * @param value What the prompt returned.
  * @returns The query string form, or `undefined` when there is nothing to send.
  */
 export declare const toParam: (value: Answer) => string | undefined;
 /**
- * @param answers What each option was answered with.
  * @returns The query the card handler is called with.
  */
 export declare const toQuery: (answers: ReadonlyMap<string, Answer>) => Record<string, string>;
 /**
  * How an answer reads back in the option menu.
  *
- * @param option The option it answers.
- * @param value What it was answered with.
  * @returns The value as the menu shows it.
  */
 export declare const describeAnswer: (option: CardOption, value: Answer) => string;
 /**
- * The file a card is written to when `--out` is not given.
+ * The `.svg` file a card is written to when `--out` is not given.
  * Named after the card and whoever it is about, so a directory of them stays readable.
  *
- * @param card The card being rendered.
- * @param query The answers it was rendered from.
  * @returns A file name, ending in `.svg`.
  */
 export declare const defaultFileName: (card: CardKind, query: Record<string, string>) => string;

package/build/query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD;;;;;GAKG;AAEH,+DAA+D;AAC/D,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAE3E;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,MAAM,KAAG,MAAM,GAAG,SAQhD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,SAAS,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CASnF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,UAAU,EAAE,OAAO,MAAM,KAAG,MAMlE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,QAAQ,EAAE,OAAO,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAK/E,CAAC"}
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEvD;;;;;GAKG;AAEH,+DAA+D;AAC/D,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,OAAO,UAAW,MAAM,KAAG,MAAM,GAAG,SAQhD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,YAAa,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CASnF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,WAAY,UAAU,SAAS,MAAM,KAAG,MAMlE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SAAU,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAK/E,CAAC"}

package/build/query.js

@@ -1,5 +1,4 @@
 /**
- * @param value What the prompt returned.
  * @returns The query string form, or `undefined` when there is nothing to send.
  */
 export const toParam = (value) => {
@@ -12,7 +11,6 @@ export const toParam = (value) => {
     return String(value);
 };
 /**
- * @param answers What each option was answered with.
  * @returns The query the card handler is called with.
  */
 export const toQuery = (answers) => {
@@ -28,8 +26,6 @@ export const toQuery = (answers) => {
 /**
  * How an answer reads back in the option menu.
  *
- * @param option The option it answers.
- * @param value What it was answered with.
  * @returns The value as the menu shows it.
  */
 export const describeAnswer = (option, value) => {
@@ -40,16 +36,14 @@ export const describeAnswer = (option, value) => {
     return option.kind === 'boolean' ? (value === true ? 'yes' : 'no') : param;
 };
 /**
- * The file a card is written to when `--out` is not given.
+ * The `.svg` file a card is written to when `--out` is not given.
  * Named after the card and whoever it is about, so a directory of them stays readable.
  *
- * @param card The card being rendered.
- * @param query The answers it was rendered from.
  * @returns A file name, ending in `.svg`.
  */
 export const defaultFileName = (card, query) => {
     const subject = query['username'] ?? query['id'] ?? 'card';
-    const repo = query['repo'];
+    const { repo } = query;
     const parts = [card.id, subject, repo].filter(Boolean).join('-');
-    return `${parts.replace(/[^\w.-]/g, '-')}.svg`;
+    return `${parts.replaceAll(/[^\w.-]/g, '-')}.svg`;
 };

package/build/saved-card.d.ts

@@ -1,39 +1,34 @@
-import type { CardKind } from './cards.js';
-import type { Answer } from './query.js';
+import type { CardKind } from './cards.ts';
+import type { Answer } from './query.ts';
 /**
- * @param path File to look for, relative to the working directory.
  * @returns Whether there is something there to load.
  */
 export declare const savedCardExists: (path: string) => boolean;
 /**
  * Reads a card back off disk.
  *
- * @param path File to read, relative to the working directory.
- * @returns The card it names, and its params.
  * @throws {Error} When the file is not a card this version can render.
+ *
+ * @returns The card it names, and its options.
  */
 export declare const readSavedCard: (path: string) => Promise<{
     card: CardKind;
-    params: Record<string, string>;
+    options: Record<string, string>;
 }>;
 /**
  * Writes a card down, so the same one can be rendered again later.
  *
- * @param path File to write, relative to the working directory.
- * @param card The card being rendered.
- * @param params Its params, as they reach the endpoint.
  * @returns The path written to.
  */
-export declare const writeSavedCard: (path: string, card: CardKind, params: Record<string, string>) => Promise<string>;
+export declare const writeSavedCard: (path: string, card: CardKind, options: Record<string, string>) => Promise<string>;
 /**
- * Turns saved params back into answers the menu can show and edit.
+ * Turns saved options back into answers the menu can show and edit.
  *
  * Everything on a query string is a string;
- * a boolean option becomes one again so its prompt opens on the right answer.
+ * a boolean becomes one again, and a list splits back into its values,
+ * so each prompt opens on the answer it was saved with.
  *
- * @param card The card the params belong to.
- * @param params The saved params.
  * @returns The answers, ready for the menu.
  */
-export declare const toAnswers: (card: CardKind, params: Record<string, string>) => Map<string, Answer>;
+export declare const toAnswers: (card: CardKind, options: Record<string, string>) => Map<string, Answer>;
 //# sourceMappingURL=saved-card.d.ts.map