@issuegraph/core
v0.1.3
Published
The Issuegraph format's shared vocabulary as frozen constants and derived types — field names, cardinality, defaults and value sets. No parsing, no I/O. The reader, the writer and the viewer all read the format through this.
Maintainers
Readme
@issuegraph/core
The vocabulary of the Issuegraph format, as data.
This is what every layer agrees on: the field names, their cardinality, the value sets and the documented defaults. The reader, the writer and the viewer each read the format through this package, which is what keeps them from growing three copies of it.
It holds what the spec fixes and nothing it derives — it parses nothing, reads nothing and builds no graph, so you can depend on the vocabulary without taking on a parser.
npm install @issuegraph/coreimport { FIELDS, EDGE_CARDINALITY, DEFAULT_PRIORITY, isField, isPriority } from '@issuegraph/core';
FIELDS; // the seven recognised fields, frozen
EDGE_CARDINALITY['blocked-by']; // 'list' — every other edge field is 'single'
DEFAULT_PRIORITY; // 2, per SPEC.md §4.3.5
isField('blocks'); // false — there is no `blocks` field; see §4.3.1
isPriority('2'); // false — YAML hands you strings; a priority is an integer 0–3Every export is frozen. A shared vocabulary a consumer can mutate is a vocabulary that disagrees with itself in the next process.
What it does not do
No frontmatter parsing, no graph construction, no readiness or effective-priority computation, no tracker access. Those arrive as separate packages.
Stability
0.x, and unstable. It tracks a draft specification (SPEC.md §8), so breaking changes before 1.0 are expected and a minor bump may break you. Pin exactly if that matters.
Licence
Apache-2.0. Stewarded by Autonomy LLC.
