grimoire-wizard 0.5.2 → 0.6.1

package/README.md

@@ -146,33 +146,33 @@ grimoire run setup.yaml
 
 ## Step Types
 
-| type | returns | use case |
-|------|---------|----------|
-| `text` | `string` | Free-form input with validation |
-| `select` | `string` | Single choice from a list; supports `routes` |
-| `multiselect` | `string[]` | Multiple choices; `min`/`max` constraints |
-| `confirm` | `boolean` | Yes/no prompt |
-| `password` | `string` | Masked input, never cached |
-| `number` | `number` | Numeric input with `min`/`max`/`step` |
-| `search` | `string` | Fuzzy-searchable single choice |
-| `editor` | `string` | Opens terminal editor, returns full text |
-| `path` | `string` | Path input with tab-completion |
-| `toggle` | `boolean` | Binary toggle with custom labels |
-| `note` | — | Inline info box, no input collected |
+| type          | returns    | use case                                     |
+| ------------- | ---------- | -------------------------------------------- |
+| `text`        | `string`   | Free-form input with validation              |
+| `select`      | `string`   | Single choice from a list; supports `routes` |
+| `multiselect` | `string[]` | Multiple choices; `min`/`max` constraints    |
+| `confirm`     | `boolean`  | Yes/no prompt                                |
+| `password`    | `string`   | Masked input, never cached                   |
+| `number`      | `number`   | Numeric input with `min`/`max`/`step`        |
+| `search`      | `string`   | Fuzzy-searchable single choice               |
+| `editor`      | `string`   | Opens terminal editor, returns full text     |
+| `path`        | `string`   | Path input with tab-completion               |
+| `toggle`      | `boolean`  | Binary toggle with custom labels             |
+| `note`        | —          | Inline info box, no input collected          |
 
 ---
 
 ## CLI
 
-| command | description |
-|---------|-------------|
-| `grimoire run <config>` | Run a wizard. Flags: `--mock`, `--json`, `--dry-run`, `--template`, `--renderer` |
-| `grimoire validate <config>` | Parse and validate without running |
-| `grimoire create [output]` | Scaffold a new wizard config interactively |
-| `grimoire demo` | Run the built-in demo (all 11 step types) |
-| `grimoire completion <shell>` | Print bash/zsh/fish completion script |
-| `grimoire cache clear [name]` | Clear cached answers |
-| `grimoire template list/delete` | Manage named answer presets |
+| command                         | description                                                                      |
+| ------------------------------- | -------------------------------------------------------------------------------- |
+| `grimoire run <config>`         | Run a wizard. Flags: `--mock`, `--json`, `--dry-run`, `--template`, `--renderer` |
+| `grimoire validate <config>`    | Parse and validate without running                                               |
+| `grimoire create [output]`      | Scaffold a new wizard config interactively                                       |
+| `grimoire demo`                 | Run the built-in demo (all 11 step types)                                        |
+| `grimoire completion <shell>`   | Print bash/zsh/fish completion script                                            |
+| `grimoire cache clear [name]`   | Clear cached answers                                                             |
+| `grimoire template list/delete` | Manage named answer presets                                                      |
 
 ---
 
@@ -181,10 +181,10 @@ grimoire run setup.yaml
 ```yaml
 # meta (required)
 meta:
-  name: string          # wizard title
-  version: string       # optional semver
-  description: string   # shown at startup
-  review: boolean       # show review screen before submit
+  name: string # wizard title
+  version: string # optional semver
+  description: string # shown at startup
+  review: boolean # show review screen before submit
 
 # extends (optional) — inherit from a base config
 extends: ./base.yaml
@@ -192,29 +192,29 @@ extends: ./base.yaml
 # checks (optional) — pre-flight shell commands, abort on failure
 checks:
   - name: string
-    run: string         # shell command
-    message: string     # error if non-zero exit
+    run: string # shell command
+    message: string # error if non-zero exit
 
 # steps (required) — array of step definitions
 steps:
-  - id: string          # unique key in answers output
-    type: string        # see step types table
-    message: string     # prompt text
-    group: string       # section header (shown once per group)
-    when: Condition     # show only if condition passes
-    next: string        # override sequential flow; "__done__" to end
-    default: any        # initial value; "$ENV_VAR" reads from env
-    validate: Rule[]    # required, minLength, maxLength, pattern, min, max
+  - id: string # unique key in answers output
+    type: string # see step types table
+    message: string # prompt text
+    group: string # section header (shown once per group)
+    when: Condition # show only if condition passes
+    next: string # override sequential flow; "__done__" to end
+    default: any # initial value; "$ENV_VAR" reads from env
+    validate: Rule[] # required, minLength, maxLength, pattern, min, max
 
 # output (optional)
 output:
   format: json | yaml | env
-  path: string          # write answers to file
+  path: string # write answers to file
 
 # theme (optional)
 theme:
   preset: catppuccin | dracula | nord | tokyonight | monokai
-  tokens:               # override individual color tokens
+  tokens: # override individual color tokens
     primary: "#hex"
   icons:
     pointer: ">"
@@ -225,29 +225,36 @@ theme:
 ## Programmatic API
 
 ```typescript
-import { defineWizard, runWizard, runPipeline } from 'grimoire-wizard'
+import { defineWizard, runWizard, runPipeline } from "grimoire-wizard";
 
 const config = defineWizard({
-  meta: { name: 'Deploy' },
+  meta: { name: "Deploy" },
   steps: [
-    { id: 'env', type: 'select', message: 'Target?',
-      options: [{ value: 'prod', label: 'Production' }, { value: 'staging', label: 'Staging' }] },
-    { id: 'confirm', type: 'confirm', message: 'Deploy now?', default: false },
+    {
+      id: "env",
+      type: "select",
+      message: "Target?",
+      options: [
+        { value: "prod", label: "Production" },
+        { value: "staging", label: "Staging" },
+      ],
+    },
+    { id: "confirm", type: "confirm", message: "Deploy now?", default: false },
   ],
-  output: { format: 'json' },
-})
+  output: { format: "json" },
+});
 
 const answers = await runWizard(config, {
-  mockAnswers: { env: 'staging', confirm: true },  // CI mode
+  mockAnswers: { env: "staging", confirm: true }, // CI mode
   onStepComplete: (stepId, value) => console.log(stepId, value),
   onCancel: () => process.exit(1),
   asyncValidate: async (stepId, value) => {
-    if (stepId === 'env' && value === 'prod') return 'Use staging first'
-    return null
+    if (stepId === "env" && value === "prod") return "Use staging first";
+    return null;
   },
-  plugins: [],   // GrimoirePlugin[] for custom step types
-  cache: true,   // persist answers as defaults on next run
-})
+  plugins: [], // GrimoirePlugin[] for custom step types
+  cache: true, // persist answers as defaults on next run
+});
 ```
 
 Key `RunWizardOptions`: `mockAnswers`, `templateAnswers`, `onBeforeStep`, `onAfterStep`, `onStepComplete`, `onCancel`, `asyncValidate`, `plugins`, `cache`, `mru`, `renderer`, `quiet`, `plain`.
@@ -266,6 +273,14 @@ The reference doc covers the full schema, all step types, conditions, routes, ac
 
 ---
 
+## Contributors
+
+Thanks to all the amazing contributors who have helped make this project better! 🎉
+
+<a href="https://github.com/YosefHayim/grimoire/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=YosefHayim/grimoire" alt="Contributors" />
+</a>
+
 ## Contributing
 
 Open to contributors. Check the [issues](https://github.com/YosefHayim/grimoire/issues) for good first tasks, or open one if you have an idea.