cant — API Reference - cleocode

API reference for the cant package.

Functions & Classes

Symbol	Kind	Description
`parseMarkdownSections()`	function	Parse markdown content into classified sections. Splits on `##` and `###` he…
`classifySection()`	function	Classify a markdown section based on its heading and content. Uses heuristic…
`extractProperties()`	function	Extract key-value properties from markdown bullet lists. Matches patterns li…
`extractPermissions()`	function	Extract permission entries from markdown content. Handles two formats: 1. St…
`headingToIdentifier()`	function	Normalize a heading into a valid CANT identifier. Converts “Code Review Agen…
`headingToEventName()`	function	Map a hook heading to a CAAMP event name. Converts headings like “On Session…
`getCaampEvents()`	function	Get the full set of CAAMP event names.
`serializeCantDocument()`	function	Serialize a CANT document IR into .cant file text. Produces a complete .cant…
`formatValue()`	function	Format a property value for .cant output. - Strings are double-quoted - Arra…
`propertiesToIR()`	function	Convert extracted properties to CANT property IR format. Maps known markdown…
`migrateMarkdown()`	function	Migrate a markdown file to CANT format. Parses the markdown into sections, c…
`showDiff()`	function	Show a color-coded diff of the migration result. Displays: - A summary heade…
`showSummary()`	function	Generate a simple text-only summary (no color). Suitable for logging or non-…
`isNativeAvailable()`	function	Check if the native addon is available
`cantParseNative()`	function	Parse a CANT message using the native addon
`cantClassifyDirectiveNative()`	function	Classify a directive using the native addon
`initCantParser()`	function	Initialize the CANT parser With napi-rs native addons, this is a no-op (nati…
`parseCANTMessage()`	function	Parse a CANT message If the native addon is available, uses the Rust cant-co…
`initWasm()`	function	Initialize the WASM module Must be called before using any WASM functions
`isWasmAvailable()`	function	Check if WASM is available
`cantParseWASM()`	function	Parse a CANT message using WASM
`cantClassifyDirectiveWASM()`	function	Classify a directive using WASM

Types & Interfaces

Symbol	Kind	Description
`MigrationOptions`	interface	Options controlling migration behavior.
`MigrationResult`	interface	Result of migrating a single markdown file.
`ConvertedFile`	interface	A single converted .cant output file.
`UnconvertedSection`	interface	A section of markdown that was not converted.
`MarkdownSection`	interface	A parsed markdown section identified by heading. Used internally by the mark…
`SectionClassification`	type	Classification of a markdown section for conversion purposes.
`ExtractedProperty`	interface	A key-value property extracted from a markdown bullet list. Matches patterns…
`ExtractedPermission`	interface	A permission entry extracted from markdown. Matches patterns like…
`CantDocumentIR`	interface	Intermediate representation of a CANT document for serialization. This is th…
`CantBlockIR`	interface	A CANT block (agent, skill, hook, or workflow).
`CantPropertyIR`	interface	A single property key-value pair.
`NativeParseResult`	interface	Shape returned by the native Rust WASM cantParse function.
`DirectiveType`	type
`ParsedCANTMessage`	interface

Other Exports

Symbol	Kind	Description
`vitest.config.ts`	file
`types.ts`	file
`markdown-parser.ts`	file
`serializer.ts`	file
`converter.ts`	file
`diff.ts`	file
`index.ts`	file
`isWasmAvailable`	variable
`initWasm`	variable
`native-loader.ts`	file
`types.ts`	file
`parse.ts`	file
`index.ts`	file
`wasm-loader.ts`	file
`parse.test.ts`	file
`converter.test.ts`	file
`diff.test.ts`	file
`markdown-parser.test.ts`	file
`roundtrip.test.ts`	file
`serializer.test.ts`	file