@mistralys/persona-builder 2.1.1 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -52
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -58,68 +58,33 @@ See the [CLI docs](docs/cli.md) for config file format and all flags.
|
|
|
58
58
|
|
|
59
59
|
## 📖 Documentation
|
|
60
60
|
|
|
61
|
+
**Guides** — conceptual and procedural reading:
|
|
62
|
+
|
|
61
63
|
| Guide | Description |
|
|
62
64
|
|-------|-------------|
|
|
65
|
+
| [Getting Started](docs/getting-started.md) | Step-by-step tutorial — build your first persona from scratch |
|
|
63
66
|
| [Directory Convention](docs/directory-convention.md) | Expected source layout (`meta/`, `content/`, `partials/`) |
|
|
64
67
|
| [Template Syntax](docs/template-syntax.md) | Variables, partials, conditionals, and built-in context variables |
|
|
68
|
+
| [Plugins](docs/plugins.md) | `PersonaBuildPlugin` interface and examples |
|
|
69
|
+
|
|
70
|
+
**Reference** — look-up material:
|
|
71
|
+
|
|
72
|
+
| Reference | Description |
|
|
73
|
+
|-----------|-------------|
|
|
74
|
+
| [Metadata Reference](docs/metadata-reference.md) | All recognized YAML metadata fields, tiers, and fallback rules |
|
|
65
75
|
| [Configuration Reference](docs/configuration.md) | `BuildConfig`, `SuiteConfig`, and `BuildSummary` fields |
|
|
66
76
|
| [CLI Reference](docs/cli.md) | Command-line flags, config file format, and common patterns |
|
|
67
|
-
| [Plugins](docs/plugins.md) | `PersonaBuildPlugin` interface, examples, and the built-in Ledger Plugin |
|
|
68
77
|
| [Public API](docs/api.md) | All exported types and functions |
|
|
69
78
|
|
|
70
|
-
## 🔌
|
|
71
|
-
|
|
72
|
-
The ledger plugin is a first-party plugin shipped as a sub-path export. It adds ledger-specific rendering (roster table, MCP tools table) and role validation into the standard build hooks.
|
|
73
|
-
|
|
74
|
-
### Installation
|
|
75
|
-
|
|
76
|
-
The plugin ships with the library — no extra install needed.
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
npm install @mistralys/persona-builder
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### Usage
|
|
83
|
-
|
|
84
|
-
```js
|
|
85
|
-
// personas/persona-build.config.js
|
|
86
|
-
const { ledgerPlugin } = require('@mistralys/persona-builder/plugins/ledger');
|
|
87
|
-
const manifest = require('../shared/workflow-manifest.json');
|
|
88
|
-
|
|
89
|
-
module.exports = {
|
|
90
|
-
rootDir: __dirname,
|
|
91
|
-
sharedPartialsDir: './shared/partials',
|
|
92
|
-
suites: {
|
|
93
|
-
ledger: {
|
|
94
|
-
srcDir: './ledger/src',
|
|
95
|
-
outVscode: './ledger/vs-code',
|
|
96
|
-
outClaudeCode: './ledger/claude-code',
|
|
97
|
-
personaMode: 'numbered',
|
|
98
|
-
},
|
|
99
|
-
standalone: {
|
|
100
|
-
srcDir: './standalone/src',
|
|
101
|
-
outVscode: './standalone/vs-code',
|
|
102
|
-
outClaudeCode: './standalone/claude-code',
|
|
103
|
-
personaMode: 'standalone',
|
|
104
|
-
},
|
|
105
|
-
},
|
|
106
|
-
plugins: [
|
|
107
|
-
ledgerPlugin({
|
|
108
|
-
manifestRoles: manifest.roles.map(r => r.name),
|
|
109
|
-
warnOnUnknownRole: true,
|
|
110
|
-
}),
|
|
111
|
-
],
|
|
112
|
-
};
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
### Options — `LedgerPluginOptions`
|
|
79
|
+
## 🔌 Plugins
|
|
116
80
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
| `warnOnUnknownRole` | `boolean` | `true` | When `true`, an unknown `role` field emits a warning-level validation result. |
|
|
81
|
+
The library ships with a plugin system that lets you inject custom frontmatter, run validators, or
|
|
82
|
+
post-process output without touching the core engine. See [docs/plugins.md](docs/plugins.md) for
|
|
83
|
+
the `PersonaBuildPlugin` interface, examples, and the available hooks.
|
|
121
84
|
|
|
122
|
-
|
|
85
|
+
> **Ledger plugin:** The first-party ledger plugin was migrated out of this library in v2.0.0 and
|
|
86
|
+
> is now maintained in the [ai-insights](https://github.com/mistralys/ai-insights-dev) workspace.
|
|
87
|
+
> The `@mistralys/persona-builder/plugins/ledger` sub-path export no longer exists.
|
|
123
88
|
|
|
124
89
|
---
|
|
125
90
|
|
package/package.json
CHANGED