Object fields • Katalyst Documentation

Inspector ID#

object_fields

Layer#

collection

Purpose#

A data dictionary over item frontmatter: per-field presence, types, cardinality, and common values.

Usage#

Inspectors emit evidence: counts and distributions, for the reader to judge. Run this one with:

katalyst inspect <target> --inspector object_fields

Worked example#

Once a collection is configured, inspect <name> runs the collection inspectors. object_fields reports, per field, how often it appears over n, its observed types, and its value cardinality: the evidence behind required/optional and enum decisions.

Input#

wiki/dune.md

---
title: Dune
author: Frank Herbert
status: read
---
# Dune

## Review
A landmark of the genre.

wiki/neuromancer.md

---
title: Neuromancer
author: William Gibson
status: reading
---
# Neuromancer

## Review

wiki/foundation.md

---
title: Foundation
author: Isaac Asimov
status: to-read
---
# Foundation

## Review

wiki/snow-crash.md

---
title: Snow Crash
author: Neal Stephenson
status: read
---
# Snow Crash

## Review

wiki/Dune Messiah.md

---
title: Dune Messiah
status: read
---
# Dune Messiah

.katalyst/storage/my_directory.yaml

type: filesystem
root: .
collections:
  books:
    path: wiki
    schema: book

.katalyst/schemas/book.yaml

type: object
required: [title, author, status]
properties:
  title:  { type: string }
  author: { type: string }
  status: { enum: [read, reading, to-read] }

Command#

$ katalyst inspect books --inspector object_fields -v
# Inspection report: books

## Object

### object_fields (n=5)

_A data dictionary over item frontmatter: per-field presence, types, cardinality, and common values._

- author:
  - cardinality: 4
  - present: 4
  - types:
    - string: 4
  - values:
    - Frank Herbert: 1
    - Isaac Asimov: 1
    - Neal Stephenson: 1
    - William Gibson: 1
- status:
  - cardinality: 3
  - present: 5
  - types:
    - string: 5
  - values:
    - read: 3
    - reading: 1
    - to-read: 1
- title:
  - cardinality: 5
  - present: 5
  - types:
    - string: 5
  - values:
    - Dune: 1
    - Dune Messiah: 1
    - Foundation: 1
    - Neuromancer: 1
    - Snow Crash: 1