Export changes as KGCL

Aperta
  • Qualcosa non va?
#10 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python, typescript
Ambito
backend, cli

Direzione di ricerca

Read packages/core/src/types.ts and formatHunk in packages/core/src/i18n.ts, then compare the exporter and argument handling in packages/cli/src/markdown.ts and packages/cli/src/args.ts. Inspect examples/datasets/ontology-release/ and resolve the listed grammar, unsupported-change, CURIE, and package questions in a comment before coding. Done means the example produces a KGCL snapshot accepted by the reference parser, with CLI docs in English and Chinese and a changeset.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement help wanted
Why

KGCL (Knowledge Graph Change Language) is how the OBO
community writes ontology changes down: rename, obsolete … with replacement, move … from … to …, create synonym, create edge, and so on. Ontology editors and bots already read and
apply it. A KGCL export would let a reviewer go from "here is what changed" in kgdiff to a
change list the OBO tooling understands, and makes kgdiff easier to adopt in ontology
repositories.

What

kgdiff a.obo b.obo --kgcl [file] (CLI) and a toKgcl(result) function (library) that write
one KGCL command per change.

docs/delta-format.md already sketches the mapping
(Relation to other formats).
Hunks carry the semantics KGCL has words for (move, merge, rename); the delta carries the
primitive operations for everything else. Roughly:

kgdiff KGCL
rename (node.set label) rename X from 'old' to 'new'
move hunk move X from P to Q
merge hunk, deprecation with replacedBy obsolete X with replacement Y
alias added / removed create synonym 'a' for X / remove synonym
node.add / node.remove create node X 'label' / delete X
edge.add / edge.remove create edge X R Y / delete edge X R Y

Check every command against the current KGCL grammar; the table is a starting point, not the spec.

Open questions (answer them in a comment before writing code)
  • Changes KGCL cannot express (attribute edits it has no command for, splits): skip with a
    warning, or emit them as comments?
  • Ids: KGCL wants CURIEs. Full IRIs from RDF inputs need compacting (compactIri in
    @kgdiff/formats), with the file's own prefixes.
  • Which package: @kgdiff/core stays format-agnostic and dependency-free, so this probably
    belongs next to the CLI's markdown.ts, or in a small new package.
Where to start
  • Hunk and op types: packages/core/src/types.ts; how hunks are worded: formatHunk in
    packages/core/src/i18n.ts.
  • An exporter with the same shape: packages/cli/src/markdown.ts (--markdown), and how
    options with an optional file argument are parsed: json / delta / markdown in
    packages/cli/src/args.ts.
  • Test data: examples/datasets/ontology-release/ has merges, a split, moves, renames and
    obsoletions.
Done when
  • The ontology-release example exports to KGCL that the reference parser
    (kgcl-schema, Python) accepts, checked once by hand and
    pinned as a golden snapshot in packages/cli/test/__snapshots__/.
  • docs/cli.md documents the option (en + zh), plus a changeset.
Lingua principale
TypeScript
Stelle
47
Fork
6
Merge medio
2h 32m
PR unite (30g)
22

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di iiwish/kgdiff

Tutte le issue di iiwish/kgdiff

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.