merpeeps-pack-state

The Merpeeps State machine stencil pack, distributed as YAML data only. Includes four stencils: Start, State, Choice, and End, with shape and colour defaults for initial markers, ordinary states, guarded branches, and final markers.

Install and read

npm install merpeeps-pack-state

From a Node.js ES module:

import { readFileSync } from 'node:fs';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const yaml = readFileSync(require.resolve('merpeeps-pack-state'), 'utf8');

The explicit data path merpeeps-pack-state/state.merpeeps-pack.yml resolves to the same file. Pass the text to your host application's YAML parser and compatible Merpeeps pack loader. This package does not include a parser or runtime dependencies. Do not import or require the YAML directly as JavaScript; require.resolve locates the data without executing it.

Contents and scope

The tarball contains only:

• state.merpeeps-pack.yml
• LICENSE
• README.md
• package.json

The YAML defines stencil labels, text, shapes, fill and stroke defaults, and hints. This pack declares no icons or custom icon geometry and includes no new artwork. Your host supplies shape rendering and any mapping to Mermaid state syntax; this package supplies neither a renderer nor glyph implementations.

Installing with npm only makes the data available to your project. It does not automatically install anything into the Merpeeps desktop app or register a Mermaid plugin. The desktop already embeds this same default pack. The separate merpeeps-mermaid-layout package provides layout functionality, not an automatic installation mechanism for this pack.

Source and publishing

The canonical source is src/Merpeeps.Core/Packs/state.merpeeps-pack.yml. From the repository, npm pack and npm publish run prepack to copy that file and the root MIT license into this package. Edit the canonical YAML, not the generated package copy. Installing the resulting tarball needs no repository checkout, build, or install lifecycle script.

See the pack usage guide and the manual publishing checklist.

MIT licensed — see LICENSE.