soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs: plugins are explicit opt-in — correct the README scale section and plugins config comment

Browse source 
A clean-room install smoke of the published GA pair caught the README telling
scale-up users the native provider is auto-detected. It is not, by design: the
loader (loadPlugins) does no auto-detection — undefined means no plugins, and
only an explicit plugins: ['@soulcraft/cor'] loads the native engine (loud
failure if it can't). The stale comment on the plugins config field in the
public types claimed auto-detection and is corrected to match the loader; one
phrase in the plugin-author guide likewise.
This commit is contained in:
David Snelling 2026-07-02 15:47:31 -07:00
parent 99d526d394
commit e420369850
4 changed files with 21 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/types/brainy.types.ts
View file

@ -1804,11 +1804,12 @@ export interface BrainyConfig {
eagerEmbeddings?: boolean
// Plugin configuration
// Controls which plugins are loaded during init()
// - undefined (default): Auto-detect installed plugins (@soulcraft/cor, etc.)
// - false: No plugins — skip auto-detection entirely
// - []: No plugins — skip auto-detection entirely
// - ['@soulcraft/cor']: Load only specified plugins, no auto-detection
// Controls which plugins are loaded during init(). Plugins are explicit
// opt-in — brainy NEVER auto-imports a package that isn't listed here.
// - undefined (default): no plugins loaded (same as [] / false)
// - false / []: no plugins loaded
// - ['@soulcraft/cor']: load exactly these packages; a listed plugin that
// fails to load or is invalid THROWS (loud, never a silent JS fallback)
plugins?: string[] | false
// Logging configuration