grimoire-wizard 0.3.0 → 0.4.0

package/examples/json/conditional.json

@@ -0,0 +1,155 @@
+{
+  "meta": {
+    "name": "Full-Stack Project Wizard",
+    "description": "Set up a full-stack project with conditional framework selection"
+  },
+  "steps": [
+    {
+      "id": "project-name",
+      "type": "text",
+      "message": "Project name?",
+      "validate": [
+        { "rule": "required" }
+      ]
+    },
+    {
+      "id": "project-type",
+      "type": "select",
+      "message": "What type of project?",
+      "options": [
+        { "value": "web", "label": "Web Application" },
+        { "value": "api", "label": "REST API" },
+        { "value": "cli", "label": "CLI Tool" },
+        { "value": "lib", "label": "Library" }
+      ],
+      "routes": {
+        "web": "web-framework",
+        "api": "api-framework",
+        "cli": "cli-features",
+        "lib": "lib-target"
+      }
+    },
+    {
+      "id": "web-framework",
+      "type": "select",
+      "message": "Choose a web framework",
+      "options": [
+        { "value": "nextjs", "label": "Next.js", "hint": "React SSR/SSG" },
+        { "value": "astro", "label": "Astro", "hint": "Content-focused, multi-framework" },
+        { "value": "sveltekit", "label": "SvelteKit", "hint": "Svelte with SSR" },
+        { "value": "nuxt", "label": "Nuxt", "hint": "Vue SSR/SSG" }
+      ],
+      "next": "styling"
+    },
+    {
+      "id": "styling",
+      "type": "select",
+      "message": "CSS approach?",
+      "when": {
+        "any": [
+          { "field": "web-framework", "equals": "nextjs" },
+          { "field": "web-framework", "equals": "sveltekit" },
+          { "field": "web-framework", "equals": "nuxt" },
+          { "field": "web-framework", "equals": "astro" }
+        ]
+      },
+      "options": [
+        { "value": "tailwind", "label": "Tailwind CSS" },
+        { "value": "css-modules", "label": "CSS Modules" },
+        { "value": "styled", "label": "Styled Components" },
+        { "value": "vanilla", "label": "Vanilla CSS" }
+      ],
+      "next": "database"
+    },
+    {
+      "id": "api-framework",
+      "type": "select",
+      "message": "Choose an API framework",
+      "options": [
+        { "value": "express", "label": "Express.js" },
+        { "value": "fastify", "label": "Fastify" },
+        { "value": "hono", "label": "Hono" },
+        { "value": "elysia", "label": "Elysia (Bun)" }
+      ],
+      "next": "database"
+    },
+    {
+      "id": "database",
+      "type": "select",
+      "message": "Database?",
+      "options": [
+        { "value": "postgres", "label": "PostgreSQL" },
+        { "value": "mysql", "label": "MySQL" },
+        { "value": "sqlite", "label": "SQLite" },
+        { "value": "mongodb", "label": "MongoDB" },
+        { "value": "none", "label": "No database" }
+      ],
+      "next": "auth"
+    },
+    {
+      "id": "auth",
+      "type": "select",
+      "message": "Authentication?",
+      "when": {
+        "field": "database",
+        "notEquals": "none"
+      },
+      "options": [
+        { "value": "jwt", "label": "JWT tokens" },
+        { "value": "session", "label": "Session-based" },
+        { "value": "oauth", "label": "OAuth 2.0" },
+        { "value": "none", "label": "No auth" }
+      ],
+      "next": "deploy"
+    },
+    {
+      "id": "cli-features",
+      "type": "multiselect",
+      "message": "CLI features to include",
+      "options": [
+        { "value": "args", "label": "Argument parsing (Commander)" },
+        { "value": "prompts", "label": "Interactive prompts" },
+        { "value": "colors", "label": "Colored output (Chalk)" },
+        { "value": "spinner", "label": "Spinners & progress bars" },
+        { "value": "config", "label": "Config file support" }
+      ],
+      "min": 1,
+      "next": "deploy"
+    },
+    {
+      "id": "lib-target",
+      "type": "multiselect",
+      "message": "Build targets",
+      "options": [
+        { "value": "esm", "label": "ESM" },
+        { "value": "cjs", "label": "CommonJS" },
+        { "value": "types", "label": "TypeScript declarations" },
+        { "value": "umd", "label": "UMD (browser)" }
+      ],
+      "default": ["esm", "types"],
+      "min": 1,
+      "next": "deploy"
+    },
+    {
+      "id": "deploy",
+      "type": "select",
+      "message": "Deployment target?",
+      "options": [
+        { "value": "vercel", "label": "Vercel" },
+        { "value": "aws", "label": "AWS" },
+        { "value": "docker", "label": "Docker" },
+        { "value": "npm", "label": "npm (publish)" },
+        { "value": "none", "label": "None" }
+      ]
+    },
+    {
+      "id": "confirm",
+      "type": "confirm",
+      "message": "Generate project?",
+      "next": "__done__"
+    }
+  ],
+  "output": {
+    "format": "json"
+  }
+}

package/examples/json/cost-analyzer.json

@@ -0,0 +1,83 @@
+{
+  "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/json/demo.json

@@ -0,0 +1,130 @@
+{
+  "meta": {
+    "name": "Grimoire Component Demo",
+    "description": "Showcasing all 10 step types, groups, and theming"
+  },
+  "theme": {
+    "tokens": {
+      "primary": "#89b4fa",
+      "success": "#a6e3a1",
+      "error": "#f38ba8",
+      "warning": "#fab387",
+      "info": "#74c7ec",
+      "muted": "#6c7086",
+      "accent": "#cba6f7"
+    },
+    "icons": {
+      "step": "\u25cf",
+      "stepDone": "\u2714",
+      "stepPending": "\u25cb",
+      "pointer": "\u276f"
+    }
+  },
+  "steps": [
+    {
+      "id": "name",
+      "type": "text",
+      "group": "Text Inputs",
+      "message": "What is your name?",
+      "placeholder": "John Doe",
+      "validate": [
+        { "rule": "required" },
+        { "rule": "minLength", "value": 2 }
+      ]
+    },
+    {
+      "id": "bio",
+      "type": "editor",
+      "group": "Text Inputs",
+      "message": "Write a short bio (opens editor)",
+      "required": false
+    },
+    {
+      "id": "project-dir",
+      "type": "path",
+      "group": "Text Inputs",
+      "message": "Project directory",
+      "placeholder": "./my-project",
+      "default": "."
+    },
+    {
+      "id": "secret",
+      "type": "password",
+      "group": "Text Inputs",
+      "message": "Enter a secret key",
+      "validate": [
+        { "rule": "minLength", "value": 4, "message": "At least 4 characters" }
+      ]
+    },
+    {
+      "id": "framework",
+      "type": "select",
+      "group": "Selections",
+      "message": "Pick a framework",
+      "options": [
+        { "value": "react", "label": "React" },
+        { "value": "vue", "label": "Vue" },
+        { "value": "svelte", "label": "Svelte" },
+        { "value": "angular", "label": "Angular", "hint": "Enterprise-ready" }
+      ]
+    },
+    {
+      "id": "tools",
+      "type": "multiselect",
+      "group": "Selections",
+      "message": "Choose your tools",
+      "options": [
+        { "value": "eslint", "label": "ESLint", "hint": "Linting" },
+        { "value": "prettier", "label": "Prettier", "hint": "Formatting" },
+        { "value": "vitest", "label": "Vitest", "hint": "Testing" },
+        { "value": "husky", "label": "Husky", "hint": "Git hooks" }
+      ],
+      "min": 1,
+      "max": 3
+    },
+    {
+      "id": "language",
+      "type": "search",
+      "group": "Selections",
+      "message": "Search for a language",
+      "options": [
+        { "value": "typescript", "label": "TypeScript" },
+        { "value": "javascript", "label": "JavaScript" },
+        { "value": "python", "label": "Python" },
+        { "value": "go", "label": "Go" },
+        { "value": "rust", "label": "Rust" },
+        { "value": "java", "label": "Java" },
+        { "value": "csharp", "label": "C#" },
+        { "value": "ruby", "label": "Ruby" }
+      ]
+    },
+    {
+      "id": "dark-mode",
+      "type": "toggle",
+      "group": "Toggles & Numbers",
+      "message": "Enable dark mode?",
+      "active": "Dark",
+      "inactive": "Light",
+      "default": true
+    },
+    {
+      "id": "port",
+      "type": "number",
+      "group": "Toggles & Numbers",
+      "message": "Dev server port",
+      "default": 3000,
+      "min": 1024,
+      "max": 65535
+    },
+    {
+      "id": "proceed",
+      "type": "confirm",
+      "group": "Confirmation",
+      "message": "Proceed with these settings?",
+      "next": "__done__"
+    }
+  ],
+  "output": {
+    "format": "json"
+  }
+}

package/examples/json/scraper-selector.json

@@ -0,0 +1,63 @@
+{
+  "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/json/themed-catppuccin.json

@@ -0,0 +1,39 @@
+{
+  "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/examples/json/themed.json

@@ -0,0 +1,103 @@
+{
+  "meta": {
+    "name": "Catppuccin Setup",
+    "description": "A beautifully themed wizard"
+  },
+  "theme": {
+    "tokens": {
+      "primary": "#89b4fa",
+      "success": "#a6e3a1",
+      "error": "#f38ba8",
+      "warning": "#fab387",
+      "info": "#74c7ec",
+      "muted": "#6c7086",
+      "accent": "#cba6f7"
+    },
+    "icons": {
+      "step": "\u2B24",
+      "stepDone": "\u2714",
+      "stepPending": "\u25EF",
+      "pointer": "\u276F"
+    }
+  },
+  "steps": [
+    {
+      "id": "username",
+      "type": "text",
+      "message": "Choose a username",
+      "validate": [
+        { "rule": "required" },
+        { "rule": "minLength", "value": 3 },
+        { "rule": "maxLength", "value": 20 },
+        { "rule": "pattern", "value": "^[a-zA-Z][a-zA-Z0-9_]*$", "message": "Letters, numbers, underscores only. Must start with a letter." }
+      ]
+    },
+    {
+      "id": "email",
+      "type": "text",
+      "message": "Your email address",
+      "validate": [
+        { "rule": "required" },
+        { "rule": "pattern", "value": "^[^@]+@[^@]+\\.[^@]+$", "message": "Enter a valid email address" }
+      ]
+    },
+    {
+      "id": "role",
+      "type": "select",
+      "message": "Select your role",
+      "options": [
+        { "value": "developer", "label": "Developer" },
+        { "value": "designer", "label": "Designer" },
+        { "value": "manager", "label": "Project Manager" },
+        { "value": "devops", "label": "DevOps Engineer" }
+      ]
+    },
+    {
+      "id": "experience",
+      "type": "number",
+      "message": "Years of experience",
+      "min": 0,
+      "max": 50,
+      "default": 3
+    },
+    {
+      "id": "interests",
+      "type": "multiselect",
+      "message": "Areas of interest",
+      "options": [
+        { "value": "frontend", "label": "Frontend Development" },
+        { "value": "backend", "label": "Backend Development" },
+        { "value": "mobile", "label": "Mobile Development" },
+        { "value": "ai", "label": "AI / Machine Learning" },
+        { "value": "devops", "label": "DevOps / Infrastructure" },
+        { "value": "security", "label": "Security" }
+      ],
+      "min": 1,
+      "max": 3
+    },
+    {
+      "id": "newsletter",
+      "type": "confirm",
+      "message": "Subscribe to our newsletter?",
+      "default": true
+    },
+    {
+      "id": "password",
+      "type": "password",
+      "message": "Set a password",
+      "validate": [
+        { "rule": "minLength", "value": 8, "message": "Password must be at least 8 characters" }
+      ]
+    },
+    {
+      "id": "confirm",
+      "type": "confirm",
+      "message": "Create your account?",
+      "next": "__done__"
+    }
+  ],
+  "output": {
+    "format": "json",
+    "path": "account.json"
+  }
+}

package/examples/json/with-checks.json

@@ -0,0 +1,47 @@
+{
+  "meta": {
+    "name": "Deployment Wizard",
+    "description": "Deploy with pre-flight safety checks"
+  },
+  "checks": [
+    {
+      "name": "Node.js installed",
+      "run": "node --version",
+      "message": "Node.js is required. Install from https://nodejs.org"
+    },
+    {
+      "name": "Git available",
+      "run": "git --version",
+      "message": "Git is required. Install from https://git-scm.com"
+    }
+  ],
+  "steps": [
+    {
+      "id": "environment",
+      "type": "select",
+      "message": "Deploy to which environment?",
+      "options": [
+        { "value": "staging", "label": "Staging" },
+        { "value": "production", "label": "Production" }
+      ]
+    },
+    {
+      "id": "version",
+      "type": "text",
+      "message": "Version tag?",
+      "default": "latest",
+      "validate": [
+        { "rule": "required" }
+      ]
+    },
+    {
+      "id": "confirm",
+      "type": "confirm",
+      "message": "Deploy now?",
+      "next": "__done__"
+    }
+  ],
+  "output": {
+    "format": "json"
+  }
+}