grimoire-wizard 0.3.0 → 0.4.0

package/examples/yaml/brief-builder.yaml

@@ -0,0 +1,429 @@
+meta:
+  name: "Concept Brief Builder"
+  description: "Create a design concept brief for AI-powered screenshot generation"
+  version: "1.0.0"
+  review: true
+
+theme:
+  preset: dracula
+
+steps:
+  # ── Platform ──────────────────────────────────────────────
+  - id: platform
+    type: select
+    group: "Platform"
+    message: "Platform type"
+    options:
+      - { value: mobile-ios, label: "iOS App", hint: "iPhone and iPad" }
+      - { value: mobile-android, label: "Android App", hint: "Android phone and tablet" }
+      - { value: mobile-game, label: "Mobile Game", hint: "iOS or Android game" }
+      - { value: web-saas, label: "Web SaaS", hint: "Web application / SaaS" }
+      - { value: landing-page, label: "Landing Page", hint: "Marketing landing page" }
+      - { value: desktop-app, label: "Desktop App", hint: "macOS or Windows app" }
+
+  # ── Product Info ──────────────────────────────────────────
+  - id: product-name
+    type: text
+    group: "Product Info"
+    message: "Product name"
+    validate:
+      - rule: required
+
+  - id: product-description
+    type: text
+    group: "Product Info"
+    message: "Product description"
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 10
+
+  # ── Target Dimensions ────────────────────────────────────
+  - id: targets-ios
+    type: multiselect
+    group: "Target Dimensions"
+    message: "Target dimensions"
+    when:
+      field: platform
+      equals: mobile-ios
+    options:
+      - { value: iphone-6.7, label: 'iPhone 6.7"' }
+      - { value: ipad-pro, label: "iPad Pro" }
+    min: 1
+
+  - id: targets-android
+    type: multiselect
+    group: "Target Dimensions"
+    message: "Target dimensions"
+    when:
+      field: platform
+      equals: mobile-android
+    options:
+      - { value: android-phone, label: "Android Phone" }
+      - { value: android-7-tablet, label: 'Android 7" Tablet' }
+      - { value: android-10-tablet, label: 'Android 10" Tablet' }
+    min: 1
+
+  - id: targets-game
+    type: multiselect
+    group: "Target Dimensions"
+    message: "Target dimensions"
+    when:
+      field: platform
+      equals: mobile-game
+    options:
+      - { value: iphone-6.7, label: 'iPhone 6.7"' }
+      - { value: ipad-pro, label: "iPad Pro" }
+      - { value: android-phone, label: "Android Phone" }
+      - { value: android-7-tablet, label: 'Android 7" Tablet' }
+    min: 1
+
+  - id: targets-web
+    type: multiselect
+    group: "Target Dimensions"
+    message: "Target dimensions"
+    when:
+      any:
+        - { field: platform, equals: web-saas }
+        - { field: platform, equals: landing-page }
+    options:
+      - { value: desktop-1920, label: "Desktop 1920px" }
+      - { value: tablet-1024, label: "Tablet 1024px" }
+      - { value: mobile-390, label: "Mobile 390px" }
+    min: 1
+
+  - id: targets-desktop
+    type: multiselect
+    group: "Target Dimensions"
+    message: "Target dimensions"
+    when:
+      field: platform
+      equals: desktop-app
+    options:
+      - { value: macos-2880x1800, label: "macOS 2880x1800" }
+      - { value: windows-2560x1440, label: "Windows 2560x1440" }
+    min: 1
+
+  # ── Design System ────────────────────────────────────────
+  - id: font-family
+    type: text
+    group: "Design System"
+    message: "Font family"
+    default: "Inter, system-ui"
+    placeholder: "e.g., SF Pro, Roboto, Inter"
+
+  - id: color-primary
+    type: text
+    group: "Design System"
+    message: "Primary color"
+    default: "#6366F1"
+
+  - id: color-secondary
+    type: text
+    group: "Design System"
+    message: "Secondary color"
+    default: "#EC4899"
+
+  - id: color-accent
+    type: text
+    group: "Design System"
+    message: "Accent color"
+    default: "#10B981"
+
+  - id: color-background
+    type: text
+    group: "Design System"
+    message: "Background color"
+    default: "#FAFAFA"
+
+  - id: color-surface
+    type: text
+    group: "Design System"
+    message: "Surface color"
+    default: "#FFFFFF"
+
+  - id: color-text
+    type: text
+    group: "Design System"
+    message: "Text color"
+    default: "#111827"
+
+  - id: color-text-secondary
+    type: text
+    group: "Design System"
+    message: "Secondary text color"
+    default: "#6B7280"
+
+  - id: corner-radius
+    type: select
+    group: "Design System"
+    message: "Corner radius"
+    default: rounded
+    options:
+      - { value: sharp, label: "Sharp (0-2px)", hint: "Minimal rounding" }
+      - { value: rounded, label: "Rounded (8-12px)", hint: "Standard corners" }
+      - { value: pill, label: "Pill (999px)", hint: "Fully rounded" }
+
+  - id: button-style
+    type: text
+    group: "Design System"
+    message: "Button style"
+    default: "filled with label"
+
+  - id: card-style
+    type: text
+    group: "Design System"
+    message: "Card style"
+    default: "elevated with shadow"
+
+  - id: spacing
+    type: select
+    group: "Design System"
+    message: "Spacing"
+    default: comfortable
+    options:
+      - { value: compact, label: "Compact", hint: "Dense layout" }
+      - { value: comfortable, label: "Comfortable", hint: "Balanced whitespace" }
+      - { value: spacious, label: "Spacious", hint: "Generous whitespace" }
+
+  # ── Design Direction ─────────────────────────────────────
+  - id: mood
+    type: text
+    group: "Design Direction"
+    message: "Design mood"
+    placeholder: "e.g., vibrant-competitive, calm-professional"
+    validate:
+      - rule: required
+
+  - id: references
+    type: text
+    group: "Design Direction"
+    message: "Style references"
+    placeholder: "Comma-separated app names for style inspiration"
+    default: ""
+    required: false
+
+  # ── Screens ──────────────────────────────────────────────
+  - id: screen-1-name
+    type: text
+    group: "Screens"
+    message: "Screen 1 name"
+    validate:
+      - rule: required
+
+  - id: screen-1-description
+    type: text
+    group: "Screens"
+    message: "Screen 1 description"
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 5
+
+  - id: screen-1-elements
+    type: text
+    group: "Screens"
+    message: "Screen 1 UI elements"
+    placeholder: "Comma-separated UI elements"
+    validate:
+      - rule: required
+
+  - id: screen-2-name
+    type: text
+    group: "Screens"
+    message: "Screen 2 name"
+    validate:
+      - rule: required
+
+  - id: screen-2-description
+    type: text
+    group: "Screens"
+    message: "Screen 2 description"
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 5
+
+  - id: screen-2-elements
+    type: text
+    group: "Screens"
+    message: "Screen 2 UI elements"
+    placeholder: "Comma-separated UI elements"
+    validate:
+      - rule: required
+
+  - id: add-more-screens
+    type: confirm
+    group: "Screens"
+    message: "Add more screen definitions in the output file?"
+    default: false
+
+  # ── Game-Specific ────────────────────────────────────────
+  - id: character-1-archetype
+    type: text
+    group: "Game-Specific"
+    message: "Character 1 archetype"
+    when:
+      field: platform
+      equals: mobile-game
+    validate:
+      - rule: required
+
+  - id: character-1-traits
+    type: text
+    group: "Game-Specific"
+    message: "Character 1 traits"
+    when:
+      field: platform
+      equals: mobile-game
+    validate:
+      - rule: required
+
+  - id: character-1-ability
+    type: text
+    group: "Game-Specific"
+    message: "Character 1 special ability"
+    when:
+      field: platform
+      equals: mobile-game
+    validate:
+      - rule: required
+
+  - id: character-1-visual
+    type: text
+    group: "Game-Specific"
+    message: "Character 1 visual description"
+    when:
+      field: platform
+      equals: mobile-game
+    validate:
+      - rule: required
+
+  - id: game-stats
+    type: text
+    group: "Game-Specific"
+    message: "Game stats"
+    when:
+      field: platform
+      equals: mobile-game
+    placeholder: "Comma-separated stats (e.g., HP, Attack, Defense)"
+    validate:
+      - rule: required
+
+  - id: game-obstacles
+    type: text
+    group: "Game-Specific"
+    message: "Obstacles"
+    when:
+      field: platform
+      equals: mobile-game
+    placeholder: "Comma-separated obstacles"
+    validate:
+      - rule: required
+
+  - id: game-resources
+    type: text
+    group: "Game-Specific"
+    message: "Resources"
+    when:
+      field: platform
+      equals: mobile-game
+    placeholder: "Comma-separated resources"
+    validate:
+      - rule: required
+
+  - id: game-win-condition
+    type: text
+    group: "Game-Specific"
+    message: "Win condition"
+    when:
+      field: platform
+      equals: mobile-game
+    validate:
+      - rule: required
+
+  - id: has-multiplayer
+    type: confirm
+    group: "Game-Specific"
+    message: "Has multiplayer?"
+    when:
+      field: platform
+      equals: mobile-game
+    default: false
+
+  - id: max-players
+    type: number
+    group: "Game-Specific"
+    message: "Max players"
+    when:
+      all:
+        - { field: platform, equals: mobile-game }
+        - { field: has-multiplayer, equals: true }
+    default: 4
+    min: 2
+    max: 100
+
+  - id: multiplayer-mode
+    type: text
+    group: "Game-Specific"
+    message: "Multiplayer mode"
+    when:
+      all:
+        - { field: platform, equals: mobile-game }
+        - { field: has-multiplayer, equals: true }
+    default: "co-op"
+    placeholder: "e.g., co-op, PvP"
+
+  - id: online-multiplayer
+    type: confirm
+    group: "Game-Specific"
+    message: "Online multiplayer?"
+    when:
+      all:
+        - { field: platform, equals: mobile-game }
+        - { field: has-multiplayer, equals: true }
+    default: true
+
+  # ── Web-Specific ─────────────────────────────────────────
+  - id: web-layout
+    type: text
+    group: "Web-Specific"
+    message: "Layout"
+    when:
+      any:
+        - { field: platform, equals: web-saas }
+        - { field: platform, equals: landing-page }
+    placeholder: "e.g., sidebar, top-nav"
+    validate:
+      - rule: required
+
+  - id: web-features
+    type: text
+    group: "Web-Specific"
+    message: "Key features"
+    when:
+      any:
+        - { field: platform, equals: web-saas }
+        - { field: platform, equals: landing-page }
+    placeholder: "Comma-separated features"
+    validate:
+      - rule: required
+
+  # ── Save Brief ───────────────────────────────────────────
+  - id: brief-name
+    type: text
+    group: "Save Brief"
+    message: "Save brief as"
+    placeholder: "my-app-brief"
+    validate:
+      - rule: required
+
+  - id: confirm-brief
+    type: confirm
+    group: "Save Brief"
+    message: "Confirm brief?"
+    default: true
+
+output:
+  format: yaml
+  path: concept-brief.yaml

package/examples/yaml/cost-analyzer.yaml

@@ -0,0 +1,69 @@
+meta:
+  name: "Cost Analysis Report"
+  description: "Configure and view AI generation cost analysis"
+  version: "1.0.0"
+
+theme:
+  preset: tokyonight
+
+steps:
+  - id: report-type
+    type: select
+    group: "Report Type"
+    message: "What kind of cost report?"
+    options:
+      - { value: full, label: "Full Report", hint: "Complete cost breakdown across all runs" }
+      - { value: today, label: "Today's Costs", hint: "Filter to today's runs only" }
+      - { value: since, label: "Since Date", hint: "Filter runs since a specific date" }
+      - { value: single-run, label: "Single Run", hint: "Inspect a specific run by ID" }
+    default: full
+
+  - id: since-date
+    type: text
+    group: "Report Type"
+    message: "Start date"
+    placeholder: "YYYY-MM-DD"
+    when:
+      field: report-type
+      equals: since
+    validate:
+      - rule: required
+      - rule: pattern
+        value: "^\\d{4}-\\d{2}-\\d{2}$"
+        message: "Must be in YYYY-MM-DD format"
+
+  - id: run-id
+    type: text
+    group: "Report Type"
+    message: "Run ID to inspect"
+    when:
+      field: report-type
+      equals: single-run
+    validate:
+      - rule: required
+
+  - id: output-format
+    type: select
+    group: "Output Options"
+    message: "Output format"
+    options:
+      - { value: interactive, label: "Interactive", hint: "Browse runs and inspect details" }
+      - { value: summary, label: "Summary", hint: "Cost analytics overview only" }
+      - { value: json, label: "JSON", hint: "Machine-readable JSON output" }
+      - { value: markdown, label: "Markdown Report", hint: "Save as docs/costs-report.md" }
+    default: interactive
+
+  - id: save-report
+    type: confirm
+    group: "Output Options"
+    message: "Save report to docs/costs-report.md?"
+    default: true
+
+  - id: confirm-analyze
+    type: confirm
+    group: "Output Options"
+    message: "Run cost analysis?"
+    default: true
+
+output:
+  format: json

package/examples/yaml/pipeline.yaml

@@ -0,0 +1,35 @@
+meta:
+  name: Pipeline Demo
+  description: A multi-stage wizard demonstrating the pipeline concept
+
+steps:
+  - id: stage
+    type: note
+    message: Stage 1 - Project Setup
+    description: First we'll set up your project basics
+
+  - id: project-name
+    type: text
+    message: What is your project name?
+    validate:
+      - rule: required
+
+  - id: stage2
+    type: note
+    message: Stage 2 - Configuration
+    description: Now let's configure your project
+
+  - id: language
+    type: select
+    message: Programming language?
+    options:
+      - { value: typescript, label: TypeScript }
+      - { value: javascript, label: JavaScript }
+
+  - id: confirm
+    type: confirm
+    message: Looks good?
+    default: true
+
+output:
+  format: json

package/examples/yaml/scraper-selector.yaml

@@ -0,0 +1,52 @@
+meta:
+  name: "Web Scraper CLI"
+  description: "Choose and run a web scraper for app store data collection"
+  version: "1.0.0"
+
+theme:
+  preset: catppuccin
+
+steps:
+  - id: scraper-info
+    type: note
+    group: "Scraper Selection"
+    message: "Available Scrapers"
+    description: "Select a scraper to run. Each scraper collects app metadata from its respective platform."
+
+  - id: scraper
+    type: select
+    group: "Scraper Selection"
+    message: "Pick a scraper"
+    options:
+      - { value: reelshort, label: "ReelShort", hint: "Scrape all shows from reelshort.com" }
+      - { value: dramabox, label: "DramaBox", hint: "Scrape all shows from dramaboxdb.com" }
+      - { value: goodshort, label: "GoodShort", hint: "Scrape dramas from goodshort.com" }
+      - { value: netshort, label: "NetShort", hint: "Scrape dramas from netshort.com" }
+      - { value: shorttv, label: "ShortTV", hint: "Scrape dramas from shorttv.live/ShortMax" }
+      - { value: mydrama, label: "MyDrama", hint: "Scrape dramas from my-drama.com" }
+      - { value: dribbble, label: "Dribbble Inspirations", hint: "Scrape App Store preview shots from Dribbble" }
+
+  - id: output-dir
+    type: path
+    group: "Output Settings"
+    message: "Output directory for scraped data"
+    default: "./data/scraped"
+    placeholder: "./data/scraped"
+
+  - id: output-format
+    type: select
+    group: "Output Settings"
+    message: "Output format for scraped data"
+    options:
+      - { value: json, label: "JSON" }
+      - { value: csv, label: "CSV" }
+    default: json
+
+  - id: confirm-scrape
+    type: confirm
+    group: "Confirmation"
+    message: "Start scraping?"
+    default: true
+
+output:
+  format: json

package/examples/yaml/themed-catppuccin.yaml

@@ -0,0 +1,31 @@
+meta:
+  name: Catppuccin Themed Setup
+  description: A project setup wizard using the Catppuccin color preset
+
+theme:
+  preset: catppuccin
+
+steps:
+  - id: project-name
+    type: text
+    message: What is your project name?
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 2
+
+  - id: framework
+    type: select
+    message: Choose a framework
+    options:
+      - { value: nextjs, label: "Next.js" }
+      - { value: remix, label: Remix }
+      - { value: astro, label: Astro }
+
+  - id: confirm
+    type: confirm
+    message: Create project?
+    default: true
+
+output:
+  format: json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grimoire-wizard",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Config-driven CLI wizard framework. Define interactive terminal wizards in YAML/JSON with back-navigation, conditional branching, theming, and structured output.",
   "type": "module",
   "main": "./dist/index.js",
@@ -47,6 +47,10 @@
     "inquirer",
     "clack"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YosefHayim/grimoire.git"
+  },
   "author": "Yosef Hayim (https://github.com/YosefHayim)",
   "license": "MIT",
   "engines": {