zod-args-parser 1.2.8 → 2.0.0-beta.0

package/src/help-message/styles.ts

@@ -1,60 +1,93 @@
-import chalk from "chalk";
-import type { HelpMessageStyle } from "../types.js";
+import c from "chalk";
+
+import type { HelpMessageStyleImpl } from "../types/help-message-types.ts";
+
+export class HelpMessageStyle implements HelpMessageStyleImpl {
+  static noColor = (...text: unknown[]) => text.join(" ");
+
+  title = HelpMessageStyle.noColor;
+  description = HelpMessageStyle.noColor;
+  default = HelpMessageStyle.noColor;
+  optional = HelpMessageStyle.noColor;
+  exampleTitle = HelpMessageStyle.noColor;
+  example = HelpMessageStyle.noColor;
+  command = HelpMessageStyle.noColor;
+  option = HelpMessageStyle.noColor;
+  argument = HelpMessageStyle.noColor;
+  placeholder = HelpMessageStyle.noColor;
+  punctuation = HelpMessageStyle.noColor;
+
+  constructor(style: Partial<HelpMessageStyleImpl>, baseStyle?: HelpMessageStyleImpl) {
+    if (baseStyle) {
+      Object.assign(this, baseStyle);
+    }
+
+    Object.assign(this, style);
+  }
+}
 
 export const helpMessageStyles = Object.freeze({
-  default: {
-    title: chalk.bold.blue,
-    description: chalk.white,
-    default: chalk.dim.italic,
-    optional: chalk.dim.italic,
-    exampleTitle: chalk.yellow,
-    example: chalk.dim,
-    command: chalk.yellow,
-    option: chalk.cyan,
-    argument: chalk.green,
-    placeholder: chalk.hex("#FF9800"),
-    punctuation: chalk.white.dim,
-  },
-  dracula: {
-    title: chalk.bold.hex("#BD93F9"),
-    description: chalk.hex("#F8F8F2"),
-    default: chalk.italic.hex("#6272A4"),
-    optional: chalk.italic.hex("#6272A4"),
-    exampleTitle: chalk.hex("#FFB86C"),
-    example: chalk.hex("#6272A4"),
-    command: chalk.hex("#50FA7B"),
-    option: chalk.hex("#8BE9FD"),
-    argument: chalk.hex("#FF79C6"),
-    placeholder: chalk.hex("#F1FA8C"),
-    punctuation: chalk.hex("#6272A4"),
-  },
-  solarizedDark: {
-    title: chalk.bold.hex("#268BD2"),
-    description: chalk.hex("#93A1A1"),
-    default: chalk.italic.hex("#586E75"),
-    optional: chalk.italic.hex("#586E75"),
-    exampleTitle: chalk.hex("#B58900"),
-    example: chalk.hex("#586E75"),
-    command: chalk.hex("#2AA198"),
-    option: chalk.hex("#268BD2"),
-    argument: chalk.hex("#859900"),
-    placeholder: chalk.hex("#CB4B16"),
-    punctuation: chalk.hex("#657B83"),
-  },
-  nord: {
-    title: chalk.bold.hex("#81A1C1"),
-    description: chalk.hex("#D8DEE9"),
-    default: chalk.italic.hex("#4C566A"),
-    optional: chalk.italic.hex("#4C566A"),
-    exampleTitle: chalk.hex("#EBCB8B"),
-    example: chalk.hex("#4C566A"),
-    command: chalk.hex("#A3BE8C"),
-    option: chalk.hex("#88C0D0"),
-    argument: chalk.hex("#BF616A"),
-    placeholder: chalk.hex("#D08770"),
-    punctuation: chalk.hex("#4C566A"),
-  },
-  html: {
+  default: new HelpMessageStyle({
+    title: c.bold.blue,
+    description: c.white,
+    default: c.dim.italic,
+    optional: c.dim.italic,
+    exampleTitle: c.yellow,
+    example: c.dim,
+    command: c.yellow,
+    option: c.cyan,
+    argument: c.green,
+    placeholder: c.hex("#FF9800"),
+    punctuation: c.white.dim,
+  }),
+
+  dracula: new HelpMessageStyle({
+    title: c.bold.hex("#BD93F9"),
+    description: c.hex("#F8F8F2"),
+    default: c.italic.hex("#6272A4"),
+    optional: c.italic.hex("#6272A4"),
+    exampleTitle: c.hex("#FFB86C"),
+    example: c.hex("#6272A4"),
+    command: c.hex("#50FA7B"),
+    option: c.hex("#8BE9FD"),
+    argument: c.hex("#FF79C6"),
+    placeholder: c.hex("#F1FA8C"),
+    punctuation: c.hex("#6272A4"),
+  }),
+
+  solarizedDark: new HelpMessageStyle({
+    title: c.bold.hex("#268BD2"),
+    description: c.hex("#93A1A1"),
+    default: c.italic.hex("#586E75"),
+    optional: c.italic.hex("#586E75"),
+    exampleTitle: c.hex("#B58900"),
+    example: c.hex("#586E75"),
+    command: c.hex("#2AA198"),
+    option: c.hex("#268BD2"),
+    argument: c.hex("#859900"),
+    placeholder: c.hex("#CB4B16"),
+    punctuation: c.hex("#657B83"),
+  }),
+
+  nord: new HelpMessageStyle({
+    title: c.bold.hex("#81A1C1"),
+    description: c.hex("#D8DEE9"),
+    default: c.italic.hex("#4C566A"),
+    optional: c.italic.hex("#4C566A"),
+    exampleTitle: c.hex("#EBCB8B"),
+    example: c.hex("#4C566A"),
+    command: c.hex("#A3BE8C"),
+    option: c.hex("#88C0D0"),
+    argument: c.hex("#BF616A"),
+    placeholder: c.hex("#D08770"),
+    punctuation: c.hex("#4C566A"),
+  }),
+
+  /**
+   * - Wrap the output in a <pre> element to preserve whitespace.
+   * - If using `descriptionMarkdown`, set `markdownRenderer` to `html` instead of `terminal`.
+   */
+  html: new HelpMessageStyle({
     title: (...string) => `<span style="color: #89dceb; font-weight: bold;">${escapeHTML(string.join(" "))}</span>`,
     description: (...string) => `<span style="color: #cdd6e8;">${escapeHTML(string.join(" "))}</span>`,
     default: (...string) => `<span style="color: #6c7086; font-style: italic;">${escapeHTML(string.join(" "))}</span>`,
@@ -66,54 +99,66 @@ export const helpMessageStyles = Object.freeze({
     argument: (...string) => `<span style="color: #00ff00;">${escapeHTML(string.join(" "))}</span>`,
     placeholder: (...string) => `<span style="color: #db9518;">${escapeHTML(string.join(" "))}</span>`,
     punctuation: (...string) => `<span style="color: #6c7086;">${escapeHTML(string.join(" "))}</span>`,
-  },
-  gruvboxDark: {
-    title: chalk.bold.hex("#FABD2F"),
-    description: chalk.hex("#EBDBB2"),
-    default: chalk.italic.hex("#928374"),
-    optional: chalk.italic.hex("#928374"),
-    exampleTitle: chalk.hex("#FE8019"),
-    example: chalk.hex("#928374"),
-    command: chalk.hex("#B8BB26"),
-    option: chalk.hex("#83A598"),
-    argument: chalk.hex("#D3869B"),
-    placeholder: chalk.hex("#FB4934"),
-    punctuation: chalk.hex("#928374"),
-  },
-  monokai: {
-    title: chalk.bold.hex("#AE81FF"),
-    description: chalk.hex("#F8F8F2"),
-    default: chalk.italic.hex("#75715E"),
-    optional: chalk.italic.hex("#75715E"),
-    exampleTitle: chalk.hex("#FD971F"),
-    example: chalk.hex("#75715E"),
-    command: chalk.hex("#A6E22E"),
-    option: chalk.hex("#66D9EF"),
-    argument: chalk.hex("#F92672"),
-    placeholder: chalk.hex("#E6DB74"),
-    punctuation: chalk.hex("#75715E"),
-  },
-  oneDark: {
-    title: chalk.bold.hex("#61AFEF"),
-    description: chalk.hex("#ABB2BF"),
-    default: chalk.italic.hex("#5C6370"),
-    optional: chalk.italic.hex("#5C6370"),
-    exampleTitle: chalk.hex("#E5C07B"),
-    example: chalk.hex("#5C6370"),
-    command: chalk.hex("#98C379"),
-    option: chalk.hex("#56B6C2"),
-    argument: chalk.hex("#E06C75"),
-    placeholder: chalk.hex("#C678DD"),
-    punctuation: chalk.hex("#5C6370"),
-  },
-  get noColors() {
-    return new Proxy(this.default, {
-      get() {
-        return (...string: string[]) => string.join(" ");
-      },
-    }) as HelpMessageStyle;
-  },
-}) satisfies Record<string, HelpMessageStyle>;
+  }),
+
+  gruvboxDark: new HelpMessageStyle({
+    title: c.bold.hex("#FABD2F"),
+    description: c.hex("#EBDBB2"),
+    default: c.italic.hex("#928374"),
+    optional: c.italic.hex("#928374"),
+    exampleTitle: c.hex("#FE8019"),
+    example: c.hex("#928374"),
+    command: c.hex("#B8BB26"),
+    option: c.hex("#83A598"),
+    argument: c.hex("#D3869B"),
+    placeholder: c.hex("#FB4934"),
+    punctuation: c.hex("#928374"),
+  }),
+
+  monokai: new HelpMessageStyle({
+    title: c.bold.hex("#AE81FF"),
+    description: c.hex("#F8F8F2"),
+    default: c.italic.hex("#75715E"),
+    optional: c.italic.hex("#75715E"),
+    exampleTitle: c.hex("#FD971F"),
+    example: c.hex("#75715E"),
+    command: c.hex("#A6E22E"),
+    option: c.hex("#66D9EF"),
+    argument: c.hex("#F92672"),
+    placeholder: c.hex("#E6DB74"),
+    punctuation: c.hex("#75715E"),
+  }),
+
+  oneDark: new HelpMessageStyle({
+    title: c.bold.hex("#61AFEF"),
+    description: c.hex("#ABB2BF"),
+    default: c.italic.hex("#5C6370"),
+    optional: c.italic.hex("#5C6370"),
+    exampleTitle: c.hex("#E5C07B"),
+    example: c.hex("#5C6370"),
+    command: c.hex("#98C379"),
+    option: c.hex("#56B6C2"),
+    argument: c.hex("#E06C75"),
+    placeholder: c.hex("#C678DD"),
+    punctuation: c.hex("#5C6370"),
+  }),
+
+  catppuccin: new HelpMessageStyle({
+    title: c.bold.hex("#89B4FA"),
+    description: c.hex("#CDD6F4"),
+    default: c.italic.hex("#6C7086"),
+    optional: c.italic.hex("#6C7086"),
+    exampleTitle: c.hex("#F9E2AF"),
+    example: c.hex("#6C7086"),
+    command: c.hex("#A6E3A1"),
+    option: c.hex("#94E2D5"),
+    argument: c.hex("#F38BA8"),
+    placeholder: c.hex("#FAB387"),
+    punctuation: c.hex("#585B70"),
+  }),
+
+  noColors: new HelpMessageStyle({}),
+});
 
 function escapeHTML(string: string) {
   return string.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");

package/src/help-message/terminal-markdown.ts

@@ -0,0 +1,147 @@
+import c from "chalk";
+import { Marked, type RendererObject, type Tokens, marked } from "marked";
+
+import type { ColorFunctionType } from "../types/help-message-types.ts";
+
+const markdownStyle: Record<string, ColorFunctionType> = {
+  bold: c.bold,
+  italic: c.italic,
+  boldItalic: c.bold.italic,
+  code: (...string) => c.bgHex("#333333").whiteBright(` ${string.join(" ")} `),
+  strikethrough: c.strikethrough,
+  link: c.underline,
+  listBullet: c.whiteBright,
+  hr: c.dim,
+  blockquote: (...string) => c.dim.bold("┃ ") + c.dim(string.join("").replace(/\s\s\n/g, "  \n" + c.bold("┃ "))),
+};
+
+function styleCode(text: string) {
+  const lines = text.split("\n");
+  const width = Math.max(...lines.map(l => l.length));
+  const top = "┌" + "─".repeat(width + 2) + "┐";
+  const bottom = "└" + "─".repeat(width + 2) + "┘";
+
+  const body = lines.map(l => c.dim("│ ") + c.dim(l).padEnd(width) + c.dim(" │")).join("\n");
+
+  return [c.dim(top), body, c.dim(bottom)].join("\n");
+}
+
+const bullets = ["•", "◦", "▪"];
+
+const terminalRenderer: RendererObject<string, string> = {
+  list(token) {
+    // figure out depth
+    let depth = 0;
+    let current = token as Tokens.List & { parent: Tokens.List };
+    while (current.parent) {
+      depth++;
+      current = current.parent as Tokens.List & { parent: Tokens.List };
+    }
+
+    // for ordered lists
+    const start = token.ordered && token.start ? token.start : undefined;
+
+    const items = token.items.map(item => this.listitem(Object.assign(item, { depth, parent: token, start })));
+    return "\n" + items.join("\n");
+  },
+  listitem(item) {
+    let string = "";
+
+    const itemCast = item as Tokens.ListItem & { parent: Tokens.List; depth: number; start?: number };
+
+    for (const token of item.tokens) {
+      if (token.type === "list") {
+        string += this.parser.parse([Object.assign(token, { parent: itemCast.parent })]);
+      }
+
+      if ("tokens" in token && Array.isArray(token.tokens)) {
+        string += this.parser.parseInline(token.tokens);
+      }
+    }
+
+    let prefix = " ".repeat(itemCast.depth * 2);
+
+    // Task
+    if (itemCast.task) {
+      prefix += itemCast.checked ? "☑ " : "☐ ";
+      return markdownStyle.listBullet(prefix) + string;
+    }
+
+    // Ordered
+    if (itemCast.start !== undefined) {
+      const findItemIndex = itemCast.parent.items.indexOf(itemCast);
+      prefix += itemCast.start + findItemIndex + ". ";
+      return markdownStyle.listBullet(prefix) + string;
+    }
+
+    // Unordered
+    prefix += bullets[itemCast.depth % bullets.length] + " ";
+    return markdownStyle.listBullet(prefix) + string;
+  },
+  link(token) {
+    return markdownStyle.link(token.text + " " + "<" + token.href + ">");
+  },
+  checkbox({ checked }) {
+    return checked.toString();
+  },
+  code(token) {
+    return styleCode(token.text);
+  },
+  codespan({ text }) {
+    return markdownStyle.code(text);
+  },
+  def({ raw }) {
+    return raw;
+  },
+  del({ text }) {
+    return markdownStyle.strikethrough(text);
+  },
+  paragraph({ tokens }) {
+    return this.parser.parseInline(tokens);
+  },
+  blockquote({ text }) {
+    return markdownStyle.blockquote(text);
+  },
+  strong({ tokens }) {
+    return markdownStyle.bold(this.parser.parseInline(tokens));
+  },
+  em({ tokens }) {
+    return markdownStyle.italic(this.parser.parseInline(tokens));
+  },
+  heading({ text }) {
+    return markdownStyle.bold(text) + "\n";
+  },
+  text(token) {
+    return token.raw;
+  },
+  space(token) {
+    return token.raw.replace(/\n+/g, "\n");
+  },
+  hr() {
+    return markdownStyle.hr("─".repeat(80));
+  },
+  br() {
+    return "\n";
+  },
+};
+
+const terminalMarked = new Marked();
+terminalMarked.use({ renderer: terminalRenderer });
+
+export function terminalMarkdown(
+  text: string,
+  renderer: "terminal" | "html" = "terminal",
+  ansiTextColor: ColorFunctionType = (...string) => string.join(" "),
+): string {
+  if (!text) {
+    return "";
+  }
+
+  if (renderer === "terminal") {
+    return ansiTextColor(terminalMarked.parse(text) as string);
+  }
+
+  const htmlString = marked.parse(text) as string;
+
+  return `<span class="_markdown">${htmlString.trim()}</span>`;
+}

package/src/index.ts

@@ -1,97 +1,28 @@
-import type {
-  ActionsFunctions,
-  Argument,
-  CheckArgumentsOptional,
-  CheckDuplicatedArguments,
-  CheckDuplicatedOptions,
-  Cli,
-  Option,
-  Prettify,
-  Subcommand,
-} from "./types.js";
-
-/**
- * - Insures that there are no duplicated options
- * - Insures that there are no duplicated arguments
- * - Insures that only the last argument is optional
- * - Insures no optional arguments are allowed when `allowPositional` is enabled
- */
-type CheckCliSubcommandInput<T extends Cli | Subcommand> =
-  CheckDuplicatedOptions<T> extends infer Error extends string
-    ? Error
-    : CheckDuplicatedArguments<T> extends infer Error extends string
-      ? Error
-      : CheckArgumentsOptional<T> extends infer Error extends string
-        ? Error
-        : T;
-
-export function createCli<const T extends Cli>(input: CheckCliSubcommandInput<T>) {
-  const setAction = (action: (data: any) => any) => {
-    if (typeof input === "string") return;
-    input.action = action;
-  };
-
-  const setPreValidationHook = (hook: (context: any) => any) => {
-    if (typeof input === "string") return;
-    input.preValidation = hook;
-  };
-
-  return Object.assign(input, { setAction, setPreValidationHook }) as Prettify<typeof input & ActionsFunctions<T>>;
-}
-
-export function createSubcommand<const T extends Subcommand>(input: CheckCliSubcommandInput<T>) {
-  const setAction = (action: (data: any) => any) => {
-    if (typeof input === "string") return;
-    input.action = action as T["action"];
-  };
-
-  const setPreValidationHook = (hook: (context: any) => any) => {
-    if (typeof input === "string") return;
-    input.preValidation = hook;
-  };
-
-  return Object.assign(input, { setAction, setPreValidationHook }) as Prettify<typeof input & ActionsFunctions<T>>;
-}
-
-/** - Insures that there are no duplicated options */
-type CheckOptionsInput<T extends Option[]> =
-  CheckDuplicatedOptions<{ options: T }> extends infer Error extends string ? Error : T;
-
-export function createOptions<const T extends [Option, ...Option[]]>(options: CheckOptionsInput<T>) {
-  return options;
-}
-
-/** - Insures that only the last argument is optional */
-type CheckArgumentsInput<T extends Argument[]> =
-  CheckArgumentsOptional<{ arguments: T }> extends infer Error extends string ? Error : T;
-
-export function createArguments<const T extends [Argument, ...Argument[]]>(arguments_: CheckArgumentsInput<T>) {
-  return arguments_;
-}
-
-export {
-  formatCliHelpMessage as formatCliHelpMsg,
-  formatSubcommandHelpMessage as formatSubcommandHelpMsg,
-  printCliHelp,
-  printSubcommandHelp,
-} from "./help-message/format-cli.js";
-export { helpMessageStyles } from "./help-message/styles.js";
-
-export { safeParse, safeParseAsync } from "./parser/safe-parse.js";
-export { unsafeParse as parse, unsafeParseAsync as parseAsync } from "./parser/unsafe-parse.js";
-
-export { isOptionalSchema, schemaDefaultValue, stringToArray, stringToSet } from "./zod-utilities.js";
-
-export { generateBashAutocompleteScript } from "./autocomplete-scripts/bash-autocomplete-script.js";
-export { generatePowerShellAutocompleteScript } from "./autocomplete-scripts/powershell-autocomplete-script.js";
-export { generateZshAutocompleteScript } from "./autocomplete-scripts/zsh-autocomplete-script.js";
-
-export { getArgumentsMetadata } from "./metadata/get-arguments-metadata.js";
-export { getCliMetadata } from "./metadata/get-cli-metadata.js";
-export { getOptionsMetadata } from "./metadata/get-options-metadata.js";
-export { getSubcommandsMetadata } from "./metadata/get-subcommands-metadata.js";
-
-export { generateMarkdown } from "./markdown/generate-markdown.js";
-
-export type * from "./metadata/metadata-types.js";
-export type * from "./types.js";
+export { generateCliHelpMessage } from "./help-message/generate-for-cli.ts";
+export { generateSubcommandHelpMessage } from "./help-message/generate-for-subcommand.ts";
+export { printCliHelp, printSubcommandHelp } from "./help-message/print-help.ts";
+export { HelpMessageStyle, helpMessageStyles } from "./help-message/styles.ts";
+
+export { generateBashAutocompleteScript } from "./autocomplete-scripts/bash-autocomplete-script.ts";
+export { generatePowerShellAutocompleteScript } from "./autocomplete-scripts/powershell-autocomplete-script.ts";
+export { generateZshAutocompleteScript } from "./autocomplete-scripts/zsh-autocomplete-script.ts";
+export { generateMarkdown } from "./markdown/generate-markdown.ts";
+
+export { getArgumentsMetadata } from "./metadata/arguments-metadata.ts";
+export { getCliMetadata } from "./metadata/cli-metadata.ts";
+export { getOptionsMetadata } from "./metadata/options-metadata.ts";
+export { getSubcommandsMetadata } from "./metadata/subcommands-metadata.ts";
+
+export { defineArguments } from "./definitions/define-arguments.ts";
+export { defineCLI } from "./definitions/define-cli.ts";
+export { defineOptions } from "./definitions/define-options.ts";
+export { defineSubcommand } from "./definitions/define-subcommand.ts";
+
+export { coerce } from "./coerce/coerce-methods.ts";
+
+export type * from "./types/context-types.ts";
+export type * from "./types/definitions-types.ts";
+export type * from "./types/help-message-types.ts";
+export type * from "./types/io-types.ts";
+export type * from "./types/metadata-types.ts";
+export type * from "./types/types.ts";