@mistralys/persona-builder 2.1.1 → 2.1.3
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 +26 -51
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -58,71 +58,46 @@ 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
|
-
## 🔌
|
|
79
|
+
## 🔌 Plugins
|
|
71
80
|
|
|
72
|
-
The
|
|
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.
|
|
73
84
|
|
|
74
|
-
|
|
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.
|
|
75
88
|
|
|
76
|
-
|
|
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`
|
|
89
|
+
---
|
|
116
90
|
|
|
117
|
-
|
|
118
|
-
|--------|------|---------|-------------|
|
|
119
|
-
| `manifestRoles` | `ReadonlyArray<string>` | `[]` | Canonical role names from your workflow manifest. Each persona's `role` field is validated against this list. When omitted or empty, role validation is skipped. |
|
|
120
|
-
| `warnOnUnknownRole` | `boolean` | `true` | When `true`, an unknown `role` field emits a warning-level validation result. |
|
|
91
|
+
## 📄 License
|
|
121
92
|
|
|
122
|
-
|
|
93
|
+
MIT
|
|
123
94
|
|
|
124
95
|
---
|
|
125
96
|
|
|
126
|
-
##
|
|
97
|
+
## Release Workflow
|
|
127
98
|
|
|
128
|
-
|
|
99
|
+
1. Add changelog entries
|
|
100
|
+
2. `npm version 0.0.0` - Updates package and lock versions + commit
|
|
101
|
+
3. `npm publish` - Publish version on NPM
|
|
102
|
+
4. `git push origin 0.0.0` - Add the tag in GIT
|
|
103
|
+
5. Add the release on Github
|
package/package.json
CHANGED