okf 0.2.0
okf: ^0.2.0 copied to clipboard
A format-first Dart toolkit for reading, validating, writing, indexing, and graphing Open Knowledge Format bundles.
0.2.0 #
- Add the engine contract types: findings, the immutable OKF Spec report and conformance judgment, adapter verdicts, change descriptions, and index/log entries.
- Pin the finding ID grammar to lowercase kebab-case
<namespace>/<code>and holdOkfReportfindings in one canonical order on every surface: path, line, column, ID, severity, message. - Move
OkfIndexEntryinto the index/log model and add value equality to index and log entries. - Add
OkfIndexDocumentandOkfLogDocument, which parse and emit theindex.mdandlog.mdentry format. The index generator and the reserved file rules consume them instead of carrying their own copy of the format. - Namespace every Spec finding as
okf/<code>and expose read-only rule descriptors while keeping execution fixed insideOkfSpecValidator. Validation text and JSON now project the shared Report, bundle load failures are findings, and CLI exit status is judged by the Verdict.okf validate --strictfails on advisories;--warnings-as-errorsremains as an alias. - Add prepared bundle changes as the single safe write path for create, update, link, and deprecate operations. Preparation validates a complete immutable candidate with the closed Spec validator; commit detects stale source state and writes the exact prepared files transactionally.
- Add composable graph filters for concept type, path prefix, and edge resolution.
- Version and document the graph JSON schema.
- Add
okf mcp, a Model Context Protocol server over stdio with thelist-concepts,lookup-concept,query-graph, andvalidatetools. Itsvalidatetool returns the same Report and Verdict as the command line, andquery-graphtakes the graph filter vocabulary as its input schema. - Add the
create-conceptandupdate-conceptMCP write tools, thin adapters overOkfBundleChangeApplier: one call writes the concept and maintains theindex.mdandlog.mdentries atomically. A Spec-invalid candidate is refused with the Report the command line prints for the same state and leaves no file changed, while input that describes no bundle state is a plain tool error. Updates managetype,title,description,tags, andbody, and retain every other frontmatter field. - Add the
link-conceptsanddeprecate-conceptMCP write tools, completing the fixed tool surface. A link records the relationship on the source concept; an absent target is accepted and remains an unresolved graph edge. A deprecation setsstatus: deprecated. Both update the concept andlog.mdin the same operation and share the write path's refusal and tool-error tiers. - Breaking:
okf validate --output jsonreplaces thevalid,error_count,warning_count, anddiagnosticsfields with the Report projection — afindingsarray whose entries carryid,severity,message, andlocation. - Breaking: remove
OkfDiagnosticandOkfValidationReport(withisValid,errorCount, andwarningCount) in favor ofOkfFinding,OkfReport, and the closedOkfSpecValidator. - Enforce one non-normalizing POSIX grammar across bundle inventories, concept IDs, and file-system adapters.
- Snapshot bundle change descriptions faithfully, keeping frontmatter value
types, key order, and the body verbatim, and reject YAML values no change
kind can represent with
ArgumentError. - Validate relationship names, and escape control characters in one-line finding text while retaining raw locations and messages in JSON.
- Add the CI gate: releases attach
dart compile exebinaries for Linux and macOS, and a composite GitHub Action pins an engine version, downloads the matching attested binary from an immutable release, and runs OKF Spec validation as a single invocation whose exit code decides the job. - Define the index link destination grammar (ADR-0008): destinations are
percent-encoded — generated links now encode parentheses too — and
CommonMark angle-bracket destinations (
(<…>)) parse and normalize to the encoded spelling, so reference filenames with spaces and parentheses are writable and parseable. Plain destinations carrying raw whitespace, parentheses, or angle brackets surface the new advisoryokf/non-portable-index-link, andOkfIndexDocumentrejects them withArgumentErrorinstead of emitting a line CommonMark cannot read. - Fix graph target resolution crashing the host process on link targets that
fail percent-decoding: a segment with no
%(raw non-ASCII such as an em dash in a reference filename) now resolves against the bundle as already decoded, and a segment with a genuinely malformed escape resolves as aninvalidedge. - Classify prose
sources[].resourcedescriptors that contain slashes ("extracted PDF/OOXML text") asdescriptorgraph edges: whitespace or a backtick now marks a source resource as prose before the slash test, since genuine link paths percent-encode whitespace (ADR-0008).
0.1.2 #
- Move package ownership to the verified
concepta.devpublisher. - Update repository and issue links for the
conceptadevorganization.
0.1.1 #
- Remove development-only and copied third-party test artifacts.
- Replace copied fixtures with independently authored compatibility tests.
0.1.0 #
- Initial implementation of the Open Knowledge Format v0.2.
- Parse, write, validate, index, and graph OKF bundles.
- Add the
okfcommand-line interface.