tinky-figures 0.1.0

package/README.md

@@ -0,0 +1,70 @@
+# tinky-figures
+
+Unicode symbols with ASCII fallbacks for tinky applications - matching the figures npm package character set.
+
+## Installation
+
+```bash
+npm install tinky-figures
+```
+
+## Usage
+
+```tsx
+import { useFigures } from "tinky-figures";
+
+function MyComponent() {
+  const figures = useFigures();
+
+  return (
+    <>
+      <text>{figures.tick} Success!</text>
+      <text>{figures.arrowRight} Next step</text>
+    </>
+  );
+}
+```
+
+## Features
+
+- ✨ **Full figures compatibility** - Uses the same character set as sindresorhus/figures
+- 🔧 **Automatic Unicode detection** - Detects terminal Unicode support via tinky env
+- 🎨 **ASCII fallbacks** - Gracefully degrades to ASCII when Unicode isn't supported
+- ⚛️ **React Hook API** - Clean `useFigures` hook designed for tinky applications
+
+## Unicode Detection
+
+The hook automatically detects Unicode support based on the `env` object from tinky:
+
+1. **Explicit `TINKY_UNICODE` flag** - If `env.TINKY_UNICODE` is set to `'true'` or `'false'`, uses that value
+2. **CI environment** - Disables Unicode in CI environments (checks `env.CI`)
+3. **Terminal type** - Checks `env.TERM` for unsupported terminals (e.g., `'dumb'`)
+4. **Platform** - Windows CMD and older PowerShell don't support Unicode well unless a modern terminal emulator is detected via `TERM`.
+
+## API
+
+### `useFigures()`
+
+React hook that returns appropriate figures based on the environment from Tinky's `useApp` context.
+
+**Returns:** `FiguresMap` - Object containing all figure characters
+
+### `isUnicodeSupported(platform?, env?)`
+
+Detects if the current environment supports Unicode.
+
+- **platform** (optional): Platform string (default: `process.platform`)
+- **env** (optional): Environment variables object (default: `process.env`)
+- **Returns:** `boolean` - `true` if Unicode is supported, `false` otherwise
+
+### `unicodeFigures`
+
+Direct access to the full Unicode symbol map (`FiguresMap`).
+
+### `asciiFigures`
+
+Direct access to the ASCII fallback symbol map (`FiguresMap`).
+
+## License
+
+MIT

package/lib/data/ascii.d.ts

@@ -0,0 +1,9 @@
+import { FiguresMap } from "../types/figures";
+/**
+ * Fallback character set for environments that do not support full Unicode.
+ *
+ * These symbols are chosen to be compatible with most terminals effortlessly,
+ * including legacy Windows consoles, or use common extended ASCII/CP437 characters
+ * where safe.
+ */
+export declare const asciiFigures: FiguresMap;

package/lib/data/ascii.js

@@ -0,0 +1,250 @@
+/**
+ * Fallback character set for environments that do not support full Unicode.
+ *
+ * These symbols are chosen to be compatible with most terminals effortlessly,
+ * including legacy Windows consoles, or use common extended ASCII/CP437 characters
+ * where safe.
+ */
+export const asciiFigures = {
+    almostEqual: "≈",
+    arrowDown: "↓",
+    arrowLeft: "←",
+    arrowLeftRight: "↔",
+    arrowRight: "→",
+    arrowUp: "↑",
+    arrowUpLeft: "\\",
+    arrowUpRight: "/",
+    arrowDownLeft: "/",
+    arrowDownRight: "\\",
+    arrowUpDown: "↕",
+    bullet: "●",
+    checkboxCircleOff: "( )",
+    checkboxCircleOn: "(×)",
+    checkboxOff: "[ ]",
+    checkboxOn: "[×]",
+    circle: "( )",
+    circleCircle: "(○)",
+    circleCross: "(×)",
+    circleDotted: "( )",
+    circleDouble: "( )",
+    circleFilled: "(*)",
+    circlePipe: "(│)",
+    circleQuestion: "(?)",
+    circleQuestionMark: "(?)",
+    cross: "×",
+    dot: "․",
+    ellipsis: "…",
+    fiveEighths: "⅝",
+    fiveSixths: "⅚",
+    fourFifths: "⅘",
+    greaterOrEqual: "≥",
+    hamburger: "≡",
+    heart: "♥",
+    home: "⌂",
+    identical: "≡",
+    infinity: "∞",
+    info: "i",
+    lessOrEqual: "≤",
+    line: "─",
+    lineBackslash: "╲",
+    lineBold: "━",
+    lineCross: "╳",
+    lineDashed0: "┄",
+    lineDashed1: "┅",
+    lineDashed10: "╼",
+    lineDashed11: "╾",
+    lineDashed12: "−",
+    lineDashed13: "–",
+    lineDashed14: "‐",
+    lineDashed15: "⁃",
+    lineDashed2: "┈",
+    lineDashed3: "┉",
+    lineDashed4: "╌",
+    lineDashed5: "╍",
+    lineDashed6: "╴",
+    lineDashed7: "╶",
+    lineDashed8: "╸",
+    lineDashed9: "╺",
+    lineDouble: "═",
+    lineDownBoldLeft: "┒",
+    lineDownBoldLeftBold: "┓",
+    lineDownBoldLeftBoldRight: "┱",
+    lineDownBoldLeftBoldRightBold: "┳",
+    lineDownBoldLeftRight: "┰",
+    lineDownBoldLeftRightBold: "┲",
+    lineDownBoldRight: "┎",
+    lineDownBoldRightBold: "┏",
+    lineDownDoubleLeft: "╖",
+    lineDownDoubleLeftDouble: "╗",
+    lineDownDoubleLeftDoubleRightDouble: "╦",
+    lineDownDoubleLeftRight: "╥",
+    lineDownDoubleRight: "╓",
+    lineDownDoubleRightDouble: "╔",
+    lineDownLeft: "┐",
+    lineDownLeftArc: "╮",
+    lineDownLeftBold: "┑",
+    lineDownLeftBoldRight: "┭",
+    lineDownLeftBoldRightBold: "┯",
+    lineDownLeftDouble: "╕",
+    lineDownLeftDoubleRightDouble: "╤",
+    lineDownLeftRight: "┬",
+    lineDownLeftRightBold: "┮",
+    lineDownRight: "┌",
+    lineDownRightArc: "╭",
+    lineDownRightBold: "┍",
+    lineDownRightDouble: "╒",
+    lineSlash: "╱",
+    lineUpBoldDownBoldLeft: "┨",
+    lineUpBoldDownBoldLeftBold: "┫",
+    lineUpBoldDownBoldLeftBoldRight: "╉",
+    lineUpBoldDownBoldLeftBoldRightBold: "╋",
+    lineUpBoldDownBoldLeftRight: "╂",
+    lineUpBoldDownBoldLeftRightBold: "╊",
+    lineUpBoldDownBoldRight: "┠",
+    lineUpBoldDownBoldRightBold: "┣",
+    lineUpBoldDownLeft: "┦",
+    lineUpBoldDownLeftBold: "┩",
+    lineUpBoldDownLeftBoldRight: "╃",
+    lineUpBoldDownLeftBoldRightBold: "╇",
+    lineUpBoldDownLeftRight: "╀",
+    lineUpBoldDownLeftRightBold: "╄",
+    lineUpBoldDownRight: "┞",
+    lineUpBoldDownRightBold: "┡",
+    lineUpBoldLeft: "┚",
+    lineUpBoldLeftBold: "┛",
+    lineUpBoldLeftBoldRight: "┹",
+    lineUpBoldLeftBoldRightBold: "┻",
+    lineUpBoldLeftRight: "┸",
+    lineUpBoldLeftRightBold: "┺",
+    lineUpBoldRight: "┖",
+    lineUpBoldRightBold: "┗",
+    lineUpDoubleDownDoubleLeft: "╢",
+    lineUpDoubleDownDoubleLeftDouble: "╣",
+    lineUpDoubleDownDoubleLeftDoubleRightDouble: "╬",
+    lineUpDoubleDownDoubleLeftRight: "╫",
+    lineUpDoubleDownDoubleRight: "╟",
+    lineUpDoubleDownDoubleRightDouble: "╠",
+    lineUpDoubleLeft: "╜",
+    lineUpDoubleLeftDouble: "╝",
+    lineUpDoubleLeftDoubleRightDouble: "╩",
+    lineUpDoubleLeftRight: "╨",
+    lineUpDoubleRight: "╙",
+    lineUpDoubleRightDouble: "╚",
+    lineUpDownBoldLeft: "┧",
+    lineUpDownBoldLeftBold: "┪",
+    lineUpDownBoldLeftBoldRight: "╅",
+    lineUpDownBoldLeftBoldRightBold: "╈",
+    lineUpDownBoldLeftRight: "╁",
+    lineUpDownBoldLeftRightBold: "╆",
+    lineUpDownBoldRight: "┟",
+    lineUpDownBoldRightBold: "┢",
+    lineUpDownLeft: "┤",
+    lineUpDownLeftBold: "┥",
+    lineUpDownLeftBoldRight: "┽",
+    lineUpDownLeftBoldRightBold: "┿",
+    lineUpDownLeftDouble: "╡",
+    lineUpDownLeftDoubleRightDouble: "╪",
+    lineUpDownLeftRight: "┼",
+    lineUpDownLeftRightBold: "┾",
+    lineUpDownRight: "├",
+    lineUpDownRightBold: "┝",
+    lineUpDownRightDouble: "╞",
+    lineUpLeft: "┘",
+    lineUpLeftArc: "╯",
+    lineUpLeftBold: "┙",
+    lineUpLeftBoldRight: "┵",
+    lineUpLeftBoldRightBold: "┷",
+    lineUpLeftDouble: "╛",
+    lineUpLeftDoubleRightDouble: "╧",
+    lineUpLeftRight: "┴",
+    lineUpLeftRightBold: "┶",
+    lineUpRight: "└",
+    lineUpRightArc: "╰",
+    lineUpRightBold: "┕",
+    lineUpRightDouble: "╘",
+    lineVertical: "│",
+    lineVerticalBold: "┃",
+    lineVerticalDashed0: "┆",
+    lineVerticalDashed1: "┇",
+    lineVerticalDashed10: "╽",
+    lineVerticalDashed11: "╿",
+    lineVerticalDashed2: "┊",
+    lineVerticalDashed3: "┋",
+    lineVerticalDashed4: "╎",
+    lineVerticalDashed5: "╏",
+    lineVerticalDashed6: "╵",
+    lineVerticalDashed7: "╷",
+    lineVerticalDashed8: "╹",
+    lineVerticalDashed9: "╻",
+    lineVerticalDouble: "║",
+    lozenge: "♦",
+    lozengeOutline: "◊",
+    musicNote: "♪",
+    musicNoteBeamed: "♫",
+    mustache: "┌─┐",
+    nodejs: "♦",
+    notEqual: "≠",
+    oneEighth: "⅛",
+    oneFifth: "⅕",
+    oneHalf: "½",
+    oneNinth: "1/9",
+    oneQuarter: "¼",
+    oneSeventh: "1/7",
+    oneSixth: "⅙",
+    oneTenth: "1/10",
+    oneThird: "⅓",
+    play: "►",
+    pointer: ">",
+    pointerSmall: "›",
+    questionMarkPrefix: "(?)",
+    radioOff: "( )",
+    radioOn: "(*)",
+    sevenEighths: "⅞",
+    smiley: "☺",
+    square: "█",
+    squareBottom: "▄",
+    squareCenter: "■",
+    squareDarkShade: "▓",
+    squareLeft: "▌",
+    squareLightShade: "░",
+    squareMediumShade: "▒",
+    squareRight: "▐",
+    squareSmall: "□",
+    squareSmallFilled: "■",
+    squareTop: "▀",
+    star: "✶",
+    subscriptEight: "₈",
+    subscriptFive: "₅",
+    subscriptFour: "₄",
+    subscriptNine: "₉",
+    subscriptOne: "₁",
+    subscriptSeven: "₇",
+    subscriptSix: "₆",
+    subscriptThree: "₃",
+    subscriptTwo: "₂",
+    subscriptZero: "₀",
+    threeEighths: "⅜",
+    threeFifths: "⅗",
+    threeQuarters: "¾",
+    tick: "√",
+    triangleDown: "▼",
+    triangleDownSmall: "▾",
+    triangleLeft: "◄",
+    triangleLeftSmall: "◂",
+    triangleRight: "►",
+    triangleRightSmall: "▸",
+    triangleUp: "▲",
+    triangleUpOutline: "∆",
+    triangleUpSmall: "▴",
+    topLeftCorner: "┌",
+    topRightCorner: "┐",
+    bottomLeftCorner: "└",
+    bottomRightCorner: "┘",
+    teeUp: "┴",
+    teeDown: "┬",
+    teeLeft: "┤",
+    teeRight: "├",
+    twoFifths: "⅖",
+    twoThirds: "⅔",
+    warning: "‼",
+};

package/lib/data/index.d.ts

@@ -0,0 +1,2 @@
+export { unicodeFigures } from "./unicode";
+export { asciiFigures } from "./ascii";

package/lib/data/index.js

@@ -0,0 +1,2 @@
+export { unicodeFigures } from "./unicode";
+export { asciiFigures } from "./ascii";

package/lib/data/unicode.d.ts

@@ -0,0 +1,8 @@
+import { FiguresMap } from "../types/figures";
+/**
+ * Full Unicode character set.
+ *
+ * These symbols utilize a wide range of Unicode characters for rich CLI output.
+ * Only use this set when the environment is known to support Unicode.
+ */
+export declare const unicodeFigures: FiguresMap;

package/lib/data/unicode.js

@@ -0,0 +1,249 @@
+/**
+ * Full Unicode character set.
+ *
+ * These symbols utilize a wide range of Unicode characters for rich CLI output.
+ * Only use this set when the environment is known to support Unicode.
+ */
+export const unicodeFigures = {
+    almostEqual: "≈",
+    arrowDown: "↓",
+    arrowLeft: "←",
+    arrowLeftRight: "↔",
+    arrowRight: "→",
+    arrowUp: "↑",
+    arrowUpLeft: "↖",
+    arrowUpRight: "↗",
+    arrowDownLeft: "↙",
+    arrowDownRight: "↘",
+    arrowUpDown: "↕",
+    bullet: "●",
+    checkboxCircleOff: "Ⓘ",
+    checkboxCircleOn: "ⓧ",
+    checkboxOff: "☐",
+    checkboxOn: "☒",
+    circle: "◯",
+    circleCircle: "ⓞ",
+    circleCross: "ⓧ",
+    circleDotted: "◌",
+    circleDouble: "◎",
+    circleFilled: "◉",
+    circlePipe: "Ⓘ",
+    circleQuestion: "❔",
+    circleQuestionMark: "(?)",
+    cross: "✘",
+    dot: "․",
+    ellipsis: "…",
+    fiveEighths: "⅝",
+    fiveSixths: "⅚",
+    fourFifths: "⅘",
+    greaterOrEqual: "≥",
+    hamburger: "☰",
+    heart: "♥",
+    home: "⌂",
+    identical: "≡",
+    infinity: "∞",
+    info: "ℹ",
+    lessOrEqual: "≤",
+    line: "─",
+    lineBackslash: "╲",
+    lineBold: "━",
+    lineCross: "╳",
+    lineDashed0: "┄",
+    lineDashed1: "┅",
+    lineDashed10: "╼",
+    lineDashed11: "╾",
+    lineDashed12: "−",
+    lineDashed13: "–",
+    lineDashed14: "‐",
+    lineDashed15: "⁃",
+    lineDashed2: "┈",
+    lineDashed3: "┉",
+    lineDashed4: "╌",
+    lineDashed5: "╍",
+    lineDashed6: "╴",
+    lineDashed7: "╶",
+    lineDashed8: "╸",
+    lineDashed9: "╺",
+    lineDouble: "═",
+    lineDownBoldLeft: "┒",
+    lineDownBoldLeftBold: "┓",
+    lineDownBoldLeftBoldRight: "┱",
+    lineDownBoldLeftBoldRightBold: "┳",
+    lineDownBoldLeftRight: "┰",
+    lineDownBoldLeftRightBold: "┲",
+    lineDownBoldRight: "┎",
+    lineDownBoldRightBold: "┏",
+    lineDownDoubleLeft: "╖",
+    lineDownDoubleLeftDouble: "╗",
+    lineDownDoubleLeftDoubleRightDouble: "╦",
+    lineDownDoubleLeftRight: "╥",
+    lineDownDoubleRight: "╓",
+    lineDownDoubleRightDouble: "╔",
+    lineDownLeft: "┐",
+    lineDownLeftArc: "╮",
+    lineDownLeftBold: "┑",
+    lineDownLeftBoldRight: "┭",
+    lineDownLeftBoldRightBold: "┯",
+    lineDownLeftDouble: "╕",
+    lineDownLeftDoubleRightDouble: "╤",
+    lineDownLeftRight: "┬",
+    lineDownLeftRightBold: "┮",
+    lineDownRight: "┌",
+    lineDownRightArc: "╭",
+    lineDownRightBold: "┍",
+    lineDownRightDouble: "╒",
+    lineSlash: "╱",
+    lineUpBoldDownBoldLeft: "┨",
+    lineUpBoldDownBoldLeftBold: "┫",
+    lineUpBoldDownBoldLeftBoldRight: "╉",
+    lineUpBoldDownBoldLeftBoldRightBold: "╋",
+    lineUpBoldDownBoldLeftRight: "╂",
+    lineUpBoldDownBoldLeftRightBold: "╊",
+    lineUpBoldDownBoldRight: "┠",
+    lineUpBoldDownBoldRightBold: "┣",
+    lineUpBoldDownLeft: "┦",
+    lineUpBoldDownLeftBold: "┩",
+    lineUpBoldDownLeftBoldRight: "╃",
+    lineUpBoldDownLeftBoldRightBold: "╇",
+    lineUpBoldDownLeftRight: "╀",
+    lineUpBoldDownLeftRightBold: "╄",
+    lineUpBoldDownRight: "┞",
+    lineUpBoldDownRightBold: "┡",
+    lineUpBoldLeft: "┚",
+    lineUpBoldLeftBold: "┛",
+    lineUpBoldLeftBoldRight: "┹",
+    lineUpBoldLeftBoldRightBold: "┻",
+    lineUpBoldLeftRight: "┸",
+    lineUpBoldLeftRightBold: "┺",
+    lineUpBoldRight: "┖",
+    lineUpBoldRightBold: "┗",
+    lineUpDoubleDownDoubleLeft: "╢",
+    lineUpDoubleDownDoubleLeftDouble: "╣",
+    lineUpDoubleDownDoubleLeftDoubleRightDouble: "╬",
+    lineUpDoubleDownDoubleLeftRight: "╫",
+    lineUpDoubleDownDoubleRight: "╟",
+    lineUpDoubleDownDoubleRightDouble: "╠",
+    lineUpDoubleLeft: "╜",
+    lineUpDoubleLeftDouble: "╝",
+    lineUpDoubleLeftDoubleRightDouble: "╩",
+    lineUpDoubleLeftRight: "╨",
+    lineUpDoubleRight: "╙",
+    lineUpDoubleRightDouble: "╚",
+    lineUpDownBoldLeft: "┧",
+    lineUpDownBoldLeftBold: "┪",
+    lineUpDownBoldLeftBoldRight: "╅",
+    lineUpDownBoldLeftBoldRightBold: "╈",
+    lineUpDownBoldLeftRight: "╁",
+    lineUpDownBoldLeftRightBold: "╆",
+    lineUpDownBoldRight: "┟",
+    lineUpDownBoldRightBold: "┢",
+    lineUpDownLeft: "┤",
+    lineUpDownLeftBold: "┥",
+    lineUpDownLeftBoldRight: "┽",
+    lineUpDownLeftBoldRightBold: "┿",
+    lineUpDownLeftDouble: "╡",
+    lineUpDownLeftDoubleRightDouble: "╪",
+    lineUpDownLeftRight: "┼",
+    lineUpDownLeftRightBold: "┾",
+    lineUpDownRight: "├",
+    lineUpDownRightBold: "┝",
+    lineUpDownRightDouble: "╞",
+    lineUpLeft: "┘",
+    lineUpLeftArc: "╯",
+    lineUpLeftBold: "┙",
+    lineUpLeftBoldRight: "┵",
+    lineUpLeftBoldRightBold: "┷",
+    lineUpLeftDouble: "╛",
+    lineUpLeftDoubleRightDouble: "╧",
+    lineUpLeftRight: "┴",
+    lineUpLeftRightBold: "┶",
+    lineUpRight: "└",
+    lineUpRightArc: "╰",
+    lineUpRightBold: "┕",
+    lineUpRightDouble: "╘",
+    lineVertical: "│",
+    lineVerticalBold: "┃",
+    lineVerticalDashed0: "┆",
+    lineVerticalDashed1: "┇",
+    lineVerticalDashed10: "╽",
+    lineVerticalDashed11: "╿",
+    lineVerticalDashed2: "┊",
+    lineVerticalDashed3: "┋",
+    lineVerticalDashed4: "╎",
+    lineVerticalDashed5: "╏",
+    lineVerticalDashed6: "╵",
+    lineVerticalDashed7: "╷",
+    lineVerticalDashed8: "╹",
+    lineVerticalDashed9: "╻",
+    lineVerticalDouble: "║",
+    lozenge: "◆",
+    lozengeOutline: "◇",
+    musicNote: "♪",
+    musicNoteBeamed: "♫",
+    mustache: "෴",
+    nodejs: "⬢",
+    notEqual: "≠",
+    oneEighth: "⅛",
+    oneFifth: "⅕",
+    oneHalf: "½",
+    oneNinth: "⅑",
+    oneQuarter: "¼",
+    oneSeventh: "⅐",
+    oneSixth: "⅙",
+    oneTenth: "⅒",
+    oneThird: "⅓",
+    play: "▶",
+    pointer: "❯",
+    pointerSmall: "›",
+    questionMarkPrefix: "(?)",
+    radioOff: "◯",
+    radioOn: "◉",
+    sevenEighths: "⅞",
+    smiley: "㋡",
+    square: "█",
+    squareBottom: "▄",
+    squareCenter: "■",
+    squareDarkShade: "▓",
+    squareLeft: "▌",
+    squareLightShade: "░",
+    squareMediumShade: "▒",
+    squareRight: "▐",
+    squareSmall: "◻",
+    squareSmallFilled: "◼",
+    squareTop: "▀",
+    star: "★",
+    subscriptEight: "₈",
+    subscriptFive: "₅",
+    subscriptFour: "₄",
+    subscriptNine: "₉",
+    subscriptOne: "₁",
+    subscriptSeven: "₇",
+    subscriptSix: "₆",
+    subscriptThree: "₃",
+    subscriptTwo: "₂",
+    subscriptZero: "₀",
+    threeEighths: "⅜",
+    threeFifths: "⅗",
+    threeQuarters: "¾",
+    tick: "✔",
+    triangleDown: "▼",
+    triangleDownSmall: "▾",
+    triangleLeft: "◀",
+    triangleLeftSmall: "◂",
+    triangleRight: "▶",
+    triangleRightSmall: "▸",
+    triangleUp: "▲",
+    triangleUpOutline: "△",
+    triangleUpSmall: "▴",
+    topLeftCorner: "┌",
+    topRightCorner: "┐",
+    bottomLeftCorner: "└",
+    bottomRightCorner: "┘",
+    teeUp: "┴",
+    teeDown: "┬",
+    teeLeft: "┤",
+    teeRight: "├",
+    twoFifths: "⅖",
+    twoThirds: "⅔",
+    warning: "⚠",
+};

package/lib/hooks/useFigures.d.ts

@@ -0,0 +1,43 @@
+import { FiguresMap } from "../types/figures";
+/**
+ * Detect if Unicode is supported in the current terminal environment.
+ *
+ * This function checks various environment variables and platform settings to determine
+ * if the terminal is capable of displaying Unicode characters comprehensively.
+ * It prioritizes the `TINKY_UNICODE` environment variable if set.
+ *
+ * Adapted from `sindresorhus/is-unicode-supported`.
+ *
+ * @param platform - The operating system platform (default: `process.platform`).
+ * @param env - The environment variables object (default: `process.env`).
+ * @returns `true` if Unicode is supported, `false` otherwise.
+ */
+export declare function isUnicodeSupported(platform?: string, env?: Record<string, string | undefined>): boolean;
+/**
+ * A React hook that provides a set of figure characters appropriate for the current environment.
+ *
+ * This hook leverages `useApp()` from `tinky` to access environment details and determines
+ * whether to return the full Unicode character set or a fallback ASCII-compatible set.
+ *
+ * Use this hook to ensure your CLI output renders correctly across different terminals,
+ * including those with limited character support (e.g., standard Windows CMD).
+ *
+ * @returns A `FiguresMap` object containing the character set (Unicode or ASCII fallback).
+ *
+ * @example
+ * ```tsx
+ * import { useFigures } from 'tinky-figures';
+ * import { Text } from 'tinky';
+ *
+ * function StatusMessage() {
+ *   const figures = useFigures();
+ *
+ *   return (
+ *     <Text>
+ *       {figures.tick} Operation completed successfully.
+ *     </Text>
+ *   );
+ * }
+ * ```
+ */
+export declare function useFigures(): FiguresMap;

package/lib/hooks/useFigures.js

@@ -0,0 +1,74 @@
+import { useMemo } from "react";
+import { useApp } from "tinky";
+import { unicodeFigures } from "../data/unicode";
+import { asciiFigures } from "../data/ascii";
+/**
+ * Detect if Unicode is supported in the current terminal environment.
+ *
+ * This function checks various environment variables and platform settings to determine
+ * if the terminal is capable of displaying Unicode characters comprehensively.
+ * It prioritizes the `TINKY_UNICODE` environment variable if set.
+ *
+ * Adapted from `sindresorhus/is-unicode-supported`.
+ *
+ * @param platform - The operating system platform (default: `process.platform`).
+ * @param env - The environment variables object (default: `process.env`).
+ * @returns `true` if Unicode is supported, `false` otherwise.
+ */
+export function isUnicodeSupported(platform = process.platform, env = process.env) {
+    // If explicitly set via environment variable, use that
+    if (env.TINKY_UNICODE === "true") {
+        return true;
+    }
+    if (env.TINKY_UNICODE === "false") {
+        return false;
+    }
+    const { TERM, TERM_PROGRAM } = env;
+    if (platform !== "win32") {
+        return TERM !== "linux"; // Linux console (kernel)
+    }
+    return (Boolean(env.WT_SESSION) || // Windows Terminal
+        Boolean(env.TERMINUS_SUBLIME) || // Terminus (<0.2.27)
+        env.ConEmuTask === "{cmd::Cmder}" || // ConEmu and cmder
+        TERM_PROGRAM === "Terminus-Sublime" ||
+        TERM_PROGRAM === "vscode" ||
+        TERM === "xterm-256color" ||
+        TERM === "alacritty" ||
+        TERM === "rxvt-unicode" ||
+        TERM === "rxvt-unicode-256color" ||
+        env.TERMINAL_EMULATOR === "JetBrains-JediTerm");
+}
+/**
+ * A React hook that provides a set of figure characters appropriate for the current environment.
+ *
+ * This hook leverages `useApp()` from `tinky` to access environment details and determines
+ * whether to return the full Unicode character set or a fallback ASCII-compatible set.
+ *
+ * Use this hook to ensure your CLI output renders correctly across different terminals,
+ * including those with limited character support (e.g., standard Windows CMD).
+ *
+ * @returns A `FiguresMap` object containing the character set (Unicode or ASCII fallback).
+ *
+ * @example
+ * ```tsx
+ * import { useFigures } from 'tinky-figures';
+ * import { Text } from 'tinky';
+ *
+ * function StatusMessage() {
+ *   const figures = useFigures();
+ *
+ *   return (
+ *     <Text>
+ *       {figures.tick} Operation completed successfully.
+ *     </Text>
+ *   );
+ * }
+ * ```
+ */
+export function useFigures() {
+    const { platform, env } = useApp();
+    const figures = useMemo(() => {
+        return isUnicodeSupported(platform, env) ? unicodeFigures : asciiFigures;
+    }, [platform, env]);
+    return figures;
+}

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * tinky-figures
+ *
+ * A library providing Unicode symbols with automatic ASCII fallbacks for Tinky applications.
+ * It matches the character set of the popular `figures` npm package.
+ *
+ * @packageDocumentation
+ */
+export { useFigures, isUnicodeSupported } from "./hooks/useFigures";
+export type { FiguresMap } from "./types/figures";
+export { unicodeFigures, asciiFigures } from "./data";

package/lib/index.js

@@ -0,0 +1,10 @@
+/**
+ * tinky-figures
+ *
+ * A library providing Unicode symbols with automatic ASCII fallbacks for Tinky applications.
+ * It matches the character set of the popular `figures` npm package.
+ *
+ * @packageDocumentation
+ */
+export { useFigures, isUnicodeSupported } from "./hooks/useFigures";
+export { unicodeFigures, asciiFigures } from "./data";

package/lib/types/figures.d.ts

@@ -0,0 +1,250 @@
+/**
+ * Represents a collection of figure characters used for CLI output.
+ * Keys correspond to the symbol names, and values are the characters themselves.
+ *
+ * This interface matches the structure of `sindresorhus/figures`.
+ */
+export interface FiguresMap {
+    [key: string]: string;
+    almostEqual: string;
+    arrowDown: string;
+    arrowLeft: string;
+    arrowLeftRight: string;
+    arrowRight: string;
+    arrowUp: string;
+    arrowUpLeft: string;
+    arrowUpRight: string;
+    arrowDownLeft: string;
+    arrowDownRight: string;
+    arrowUpDown: string;
+    bullet: string;
+    checkboxCircleOff: string;
+    checkboxCircleOn: string;
+    checkboxOff: string;
+    checkboxOn: string;
+    circle: string;
+    circleCircle: string;
+    circleCross: string;
+    circleDotted: string;
+    circleDouble: string;
+    circleFilled: string;
+    circlePipe: string;
+    circleQuestion: string;
+    circleQuestionMark: string;
+    cross: string;
+    dot: string;
+    ellipsis: string;
+    fiveEighths: string;
+    fiveSixths: string;
+    fourFifths: string;
+    greaterOrEqual: string;
+    hamburger: string;
+    heart: string;
+    home: string;
+    identical: string;
+    infinity: string;
+    info: string;
+    lessOrEqual: string;
+    line: string;
+    lineBackslash: string;
+    lineBold: string;
+    lineCross: string;
+    lineDashed0: string;
+    lineDashed1: string;
+    lineDashed10: string;
+    lineDashed11: string;
+    lineDashed12: string;
+    lineDashed13: string;
+    lineDashed14: string;
+    lineDashed15: string;
+    lineDashed2: string;
+    lineDashed3: string;
+    lineDashed4: string;
+    lineDashed5: string;
+    lineDashed6: string;
+    lineDashed7: string;
+    lineDashed8: string;
+    lineDashed9: string;
+    lineDouble: string;
+    lineDownBoldLeft: string;
+    lineDownBoldLeftBold: string;
+    lineDownBoldLeftBoldRight: string;
+    lineDownBoldLeftBoldRightBold: string;
+    lineDownBoldLeftRight: string;
+    lineDownBoldLeftRightBold: string;
+    lineDownBoldRight: string;
+    lineDownBoldRightBold: string;
+    lineDownDoubleLeft: string;
+    lineDownDoubleLeftDouble: string;
+    lineDownDoubleLeftDoubleRightDouble: string;
+    lineDownDoubleLeftRight: string;
+    lineDownDoubleRight: string;
+    lineDownDoubleRightDouble: string;
+    lineDownLeft: string;
+    lineDownLeftArc: string;
+    lineDownLeftBold: string;
+    lineDownLeftBoldRight: string;
+    lineDownLeftBoldRightBold: string;
+    lineDownLeftDouble: string;
+    lineDownLeftDoubleRightDouble: string;
+    lineDownLeftRight: string;
+    lineDownLeftRightBold: string;
+    lineDownRight: string;
+    lineDownRightArc: string;
+    lineDownRightBold: string;
+    lineDownRightDouble: string;
+    lineSlash: string;
+    lineUpBoldDownBoldLeft: string;
+    lineUpBoldDownBoldLeftBold: string;
+    lineUpBoldDownBoldLeftBoldRight: string;
+    lineUpBoldDownBoldLeftBoldRightBold: string;
+    lineUpBoldDownBoldLeftRight: string;
+    lineUpBoldDownBoldLeftRightBold: string;
+    lineUpBoldDownBoldRight: string;
+    lineUpBoldDownBoldRightBold: string;
+    lineUpBoldDownLeft: string;
+    lineUpBoldDownLeftBold: string;
+    lineUpBoldDownLeftBoldRight: string;
+    lineUpBoldDownLeftBoldRightBold: string;
+    lineUpBoldDownLeftRight: string;
+    lineUpBoldDownLeftRightBold: string;
+    lineUpBoldDownRight: string;
+    lineUpBoldDownRightBold: string;
+    lineUpBoldLeft: string;
+    lineUpBoldLeftBold: string;
+    lineUpBoldLeftBoldRight: string;
+    lineUpBoldLeftBoldRightBold: string;
+    lineUpBoldLeftRight: string;
+    lineUpBoldLeftRightBold: string;
+    lineUpBoldRight: string;
+    lineUpBoldRightBold: string;
+    lineUpDoubleDownDoubleLeft: string;
+    lineUpDoubleDownDoubleLeftDouble: string;
+    lineUpDoubleDownDoubleLeftDoubleRightDouble: string;
+    lineUpDoubleDownDoubleLeftRight: string;
+    lineUpDoubleDownDoubleRight: string;
+    lineUpDoubleDownDoubleRightDouble: string;
+    lineUpDoubleLeft: string;
+    lineUpDoubleLeftDouble: string;
+    lineUpDoubleLeftDoubleRightDouble: string;
+    lineUpDoubleLeftRight: string;
+    lineUpDoubleRight: string;
+    lineUpDoubleRightDouble: string;
+    lineUpDownBoldLeft: string;
+    lineUpDownBoldLeftBold: string;
+    lineUpDownBoldLeftBoldRight: string;
+    lineUpDownBoldLeftBoldRightBold: string;
+    lineUpDownBoldLeftRight: string;
+    lineUpDownBoldLeftRightBold: string;
+    lineUpDownBoldRight: string;
+    lineUpDownBoldRightBold: string;
+    lineUpDownLeft: string;
+    lineUpDownLeftBold: string;
+    lineUpDownLeftBoldRight: string;
+    lineUpDownLeftBoldRightBold: string;
+    lineUpDownLeftDouble: string;
+    lineUpDownLeftDoubleRightDouble: string;
+    lineUpDownLeftRight: string;
+    lineUpDownLeftRightBold: string;
+    lineUpDownRight: string;
+    lineUpDownRightBold: string;
+    lineUpDownRightDouble: string;
+    lineUpLeft: string;
+    lineUpLeftArc: string;
+    lineUpLeftBold: string;
+    lineUpLeftBoldRight: string;
+    lineUpLeftBoldRightBold: string;
+    lineUpLeftDouble: string;
+    lineUpLeftDoubleRightDouble: string;
+    lineUpLeftRight: string;
+    lineUpLeftRightBold: string;
+    lineUpRight: string;
+    lineUpRightArc: string;
+    lineUpRightBold: string;
+    lineUpRightDouble: string;
+    lineVertical: string;
+    lineVerticalBold: string;
+    lineVerticalDashed0: string;
+    lineVerticalDashed1: string;
+    lineVerticalDashed10: string;
+    lineVerticalDashed11: string;
+    lineVerticalDashed2: string;
+    lineVerticalDashed3: string;
+    lineVerticalDashed4: string;
+    lineVerticalDashed5: string;
+    lineVerticalDashed6: string;
+    lineVerticalDashed7: string;
+    lineVerticalDashed8: string;
+    lineVerticalDashed9: string;
+    lineVerticalDouble: string;
+    lozenge: string;
+    lozengeOutline: string;
+    musicNote: string;
+    musicNoteBeamed: string;
+    mustache: string;
+    nodejs: string;
+    notEqual: string;
+    oneEighth: string;
+    oneFifth: string;
+    oneHalf: string;
+    oneNinth: string;
+    oneQuarter: string;
+    oneSeventh: string;
+    oneSixth: string;
+    oneTenth: string;
+    oneThird: string;
+    play: string;
+    pointer: string;
+    pointerSmall: string;
+    questionMarkPrefix: string;
+    radioOff: string;
+    radioOn: string;
+    sevenEighths: string;
+    smiley: string;
+    square: string;
+    squareBottom: string;
+    squareCenter: string;
+    squareDarkShade: string;
+    squareLeft: string;
+    squareLightShade: string;
+    squareMediumShade: string;
+    squareRight: string;
+    squareSmall: string;
+    squareSmallFilled: string;
+    squareTop: string;
+    star: string;
+    subscriptEight: string;
+    subscriptFive: string;
+    subscriptFour: string;
+    subscriptNine: string;
+    subscriptOne: string;
+    subscriptSeven: string;
+    subscriptSix: string;
+    subscriptThree: string;
+    subscriptTwo: string;
+    subscriptZero: string;
+    threeEighths: string;
+    threeFifths: string;
+    threeQuarters: string;
+    tick: string;
+    triangleDown: string;
+    triangleDownSmall: string;
+    triangleLeft: string;
+    triangleLeftSmall: string;
+    triangleRight: string;
+    triangleRightSmall: string;
+    triangleUp: string;
+    triangleUpOutline: string;
+    triangleUpSmall: string;
+    topLeftCorner: string;
+    topRightCorner: string;
+    bottomLeftCorner: string;
+    bottomRightCorner: string;
+    teeUp: string;
+    teeDown: string;
+    teeLeft: string;
+    teeRight: string;
+    twoFifths: string;
+    twoThirds: string;
+    warning: string;
+}

package/lib/types/figures.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "tinky-figures",
+  "version": "0.1.0",
+  "description": "Unicode symbols with ASCII fallbacks for tinky applications",
+  "keywords": [
+    "tinky",
+    "unicode",
+    "symbols",
+    "figures",
+    "cli",
+    "terminal",
+    "hook"
+  ],
+  "homepage": "https://github.com/ByteLandTechnology/tinky-figures#readme",
+  "bugs": {
+    "url": "https://github.com/ByteLandTechnology/tinky-figures/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ByteLandTechnology/tinky-figures.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "ByteLand Technology Limited"
+  },
+  "type": "module",
+  "main": "./lib/index.js",
+  "scripts": {
+    "test": "vitest run --coverage",
+    "build": "tsc && npm run docs",
+    "lint": "eslint src tests",
+    "prepublish": "npm run build",
+    "prepare": "husky",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --disableSources --out docs/api && prettier --write docs/api"
+  },
+  "dependencies": {
+    "tinky": ">=1.5.0"
+  },
+  "files": [
+    "./bin/*",
+    "./lib/*"
+  ],
+  "typings": "./lib/index.d.ts",
+  "devDependencies": {
+    "@commitlint/cli": "^20.3.0",
+    "@commitlint/config-conventional": "^20.3.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
+    "eslint": "^9.39.2",
+    "eslint-plugin-react": "^7.37.5",
+    "husky": "^9.1.7",
+    "jiti": "^2.6.1",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.4",
+    "semantic-release": "^25.0.2",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript-eslint": "^8.53.0",
+    "vitest": "^4.0.18"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,ts,jsx,tsx,json,md,yaml,yml}": "prettier --write"
+  }
+}