report

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package report holds the finding type every check in this module produces and the frozen list of rule identifiers.

A rule id is a stable, machine-readable name of one check (`schema.unresolved_ref`, `content.required`). Scripts and CI configurations match on these ids, so an id is never renamed or reused for a different check once released; a check that changes meaning gets a new id and the old one is retired.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Count

func Count(findings []Finding) (errors, warnings int)

Count returns how many findings are errors and how many are warnings.

func Sort

func Sort(findings []Finding)

Sort orders findings by file, path, severity (errors first), rule and message, so two runs over the same site print the same list.

Types

type Finding

type Finding struct {
	// File is the repository-relative path of the file the finding is
	// about. Empty for site-wide findings.
	File string `json:"file,omitempty"`
	// Path is the field path inside the file (`blocks[2].heading`),
	// empty for file-level findings.
	Path string `json:"path,omitempty"`
	// Severity is error or warning.
	Severity Severity `json:"severity"`
	// Rule is the frozen identifier of the check (see rules.go).
	Rule Rule `json:"rule"`
	// Message says what is wrong, in one sentence.
	Message string `json:"message"`
	// Hint says how to fix it, when the check knows.
	Hint string `json:"hint,omitempty"`
}

Finding is one problem found in a schema file, a content file or the links between them.

func (Finding) String

func (f Finding) String() string

String renders the finding the way a compiler would: file, path, severity, rule and message on one line.

type Rule

type Rule string

Rule is the frozen identifier of one check. The three prefixes group the checks by what they read: `schema.` the `.norcube/cms` directory alone, `content.` one content file against its collection, `links.` the whole site (URLs, assets, references between files).

const (
	// RuleSchemaParseError: a schema file is not valid YAML.
	RuleSchemaParseError Rule = "schema.parse_error"
	// RuleSchemaNotMapping: a schema file's document is not a mapping.
	RuleSchemaNotMapping Rule = "schema.not_mapping"
	// RuleSchemaUnsupportedVersion: `schemaVersion` names a version this
	// module does not know.
	RuleSchemaUnsupportedVersion Rule = "schema.unsupported_version"
	// RuleSchemaUnresolvedRef: a `$ref` names no block and no input.
	RuleSchemaUnresolvedRef Rule = "schema.unresolved_ref"
	// RuleSchemaRefCycle: `$ref` resolution ran deeper than the limit.
	RuleSchemaRefCycle Rule = "schema.ref_cycle"
	// RuleSchemaInputsGlobUnsupported: an `inputsFromGlob` pattern is not
	// of the supported `<dir>/*.yml` form.
	RuleSchemaInputsGlobUnsupported Rule = "schema.inputs_glob_unsupported"
	// RuleSchemaMissingKey: a field has no `key`.
	RuleSchemaMissingKey Rule = "schema.missing_key"
	// RuleSchemaMissingType: a field has no `type`.
	RuleSchemaMissingType Rule = "schema.missing_type"
	// RuleSchemaMissingLabel: a field has no `label`.
	RuleSchemaMissingLabel Rule = "schema.missing_label"
	// RuleSchemaUnknownType: a field's `type` is not one the editor renders.
	RuleSchemaUnknownType Rule = "schema.unknown_type"
	// RuleSchemaUnknownKnob: a field carries a key no field of its type
	// reads (a typo, or a knob from another type).
	RuleSchemaUnknownKnob Rule = "schema.unknown_knob"
	// RuleSchemaDuplicateKey: two fields in one list share a key.
	RuleSchemaDuplicateKey Rule = "schema.duplicate_key"
	// RuleSchemaEmptyOptions: a select or multichoice field has no options.
	RuleSchemaEmptyOptions Rule = "schema.empty_options"
	// RuleSchemaDefaultNotOption: a select's `default` is not one of its
	// options.
	RuleSchemaDefaultNotOption Rule = "schema.default_not_option"
	// RuleSchemaMinAboveMax: `min` exceeds `max`, or `minLength` exceeds
	// `maxLength`, or `minItems` exceeds `maxItems`.
	RuleSchemaMinAboveMax Rule = "schema.min_above_max"
	// RuleSchemaInvalidRegex: a `regex` or custom validator pattern does
	// not compile. The editor evaluates patterns in JavaScript; this
	// module evaluates them with Go's RE2 engine, so a pattern that only
	// RE2 rejects (lookaround, backreference) is reported with that
	// caveat in the message.
	RuleSchemaInvalidRegex Rule = "schema.invalid_regex"
	// RuleSchemaUnresolvedConditionPath: a `visibleIf` path names a field
	// that does not exist in its scope.
	RuleSchemaUnresolvedConditionPath Rule = "schema.unresolved_condition_path"
	// RuleSchemaUnresolvedComputedPath: a `computed.from` path names a
	// field that does not exist in its scope.
	RuleSchemaUnresolvedComputedPath Rule = "schema.unresolved_computed_path"
	// RuleSchemaUnknownCustomValidator: a `customValidators` entry has a
	// type no handler implements.
	RuleSchemaUnknownCustomValidator Rule = "schema.unknown_custom_validator"
	// RuleSchemaAmbiguousItemShapes: two primitive item shapes of one
	// multi-shape array hold the same value type, so items cannot be
	// told apart.
	RuleSchemaAmbiguousItemShapes Rule = "schema.ambiguous_item_shapes"
	// RuleSchemaAnonymousItemShapes: a group item shape of a multi-shape
	// array has no key, so no item can name it.
	RuleSchemaAnonymousItemShapes Rule = "schema.anonymous_item_shapes"
	// RuleSchemaUnknownStorage: a field's `storage` names no declared
	// storage.
	RuleSchemaUnknownStorage Rule = "schema.unknown_storage"
	// RuleSchemaUnknownDefaultStorage: `defaultStorage` names no declared
	// storage.
	RuleSchemaUnknownDefaultStorage Rule = "schema.unknown_default_storage"
	// RuleSchemaInvalidStorage: a storage entry is malformed (missing
	// type or path, invalid naming, dedup, mode or inline).
	RuleSchemaInvalidStorage Rule = "schema.invalid_storage"
	// RuleSchemaDuplicateCollectionPath: two collections share a `path`,
	// so files under it resolve to one of them arbitrarily.
	RuleSchemaDuplicateCollectionPath Rule = "schema.duplicate_collection_path"
	// RuleSchemaMissingCollectionPath: a collection other than `pages`
	// declares no `path`, so no file can belong to it by directory.
	RuleSchemaMissingCollectionPath Rule = "schema.missing_collection_path"
	// RuleSchemaUnknownPreviewToken: `previewPath` uses a token other than
	// `{locale}`, `{slug}` or `{fields.<key>}`.
	RuleSchemaUnknownPreviewToken Rule = "schema.unknown_preview_token"
	// RuleSchemaInvalidLocaleFrom: `localeFrom` is not `path`, `none` or
	// `field:<key>`.
	RuleSchemaInvalidLocaleFrom Rule = "schema.invalid_locale_from"
	// RuleSchemaDefaultLocaleNotDeclared: `preview.defaultLocale` is not
	// in `preview.locales`.
	RuleSchemaDefaultLocaleNotDeclared Rule = "schema.default_locale_not_declared"
	// RuleSchemaUnknownRedirectsFormat: `redirects.format` is not netlify
	// or vercel.
	RuleSchemaUnknownRedirectsFormat Rule = "schema.unknown_redirects_format"
	// RuleSchemaMissingVariablesFile: `variables.file` names a file the
	// site does not have.
	RuleSchemaMissingVariablesFile Rule = "schema.missing_variables_file"
)

Schema rules: the directory loads and makes sense on its own.

const (
	// RuleContentParseError: the frontmatter or data file is not valid
	// YAML.
	RuleContentParseError Rule = "content.parse_error"
	// RuleContentNoCollection: a content file under the pages directory
	// belongs to no collection.
	RuleContentNoCollection Rule = "content.no_collection"
	// RuleContentRequired: a required field is empty.
	RuleContentRequired Rule = "content.required"
	// RuleContentShape: a value's type does not match the field's type,
	// or a select value is not one of the options.
	RuleContentShape Rule = "content.shape"
	// RuleContentItemTypeMissing: a multi-shape array item carries no
	// discriminator.
	RuleContentItemTypeMissing Rule = "content.item_type_missing"
	// RuleContentItemTypeUnknown: a multi-shape array item's
	// discriminator names no shape.
	RuleContentItemTypeUnknown Rule = "content.item_type_unknown"
	// RuleContentMinItems: an array has fewer items than `minItems`.
	RuleContentMinItems Rule = "content.min_items"
	// RuleContentMaxItems: an array has more items than `maxItems`.
	RuleContentMaxItems Rule = "content.max_items"
	// RuleContentRegex: a value does not match the field's `regex`.
	RuleContentRegex Rule = "content.regex"
	// RuleContentMinLength: a value is shorter than `minLength`.
	RuleContentMinLength Rule = "content.min_length"
	// RuleContentMaxLength: a value is longer than `maxLength`.
	RuleContentMaxLength Rule = "content.max_length"
	// RuleContentMin: a number is below `min`.
	RuleContentMin Rule = "content.min"
	// RuleContentMax: a number is above `max`.
	RuleContentMax Rule = "content.max"
	// RuleContentUnique: two array items share the value `uniqueOn`
	// points at.
	RuleContentUnique Rule = "content.unique"
	// RuleContentCustom: a `customValidators` entry rejected the value.
	RuleContentCustom Rule = "content.custom"
	// RuleContentExtraKeys: the file has keys the schema does not declare.
	// A warning under `extraKeysPolicy: show`, an error under `strip`
	// (the next save deletes them), silent under `hide`.
	RuleContentExtraKeys Rule = "content.extra_keys"
	// RuleContentUnexpectedBody: a file in a collection without a body
	// has one.
	RuleContentUnexpectedBody Rule = "content.unexpected_body"
)

Content rules: one file against its collection.

const (
	// RuleLinksURLCollision: two files whose collections derive URLs from
	// the file resolve to the same URL.
	RuleLinksURLCollision Rule = "links.url_collision"
	// RuleLinksUnresolvedLink: a site link points at no file's URL, no
	// asset and no known path.
	RuleLinksUnresolvedLink Rule = "links.unresolved_link"
	// RuleLinksMissingAsset: an image or file value points at a file the
	// repository does not have.
	RuleLinksMissingAsset Rule = "links.missing_asset"
	// RuleLinksUnresolvedReference: a reference field's value names no
	// entry.
	RuleLinksUnresolvedReference Rule = "links.unresolved_reference"
	// RuleLinksOrphanSidecar: a `.norcube/cms/meta` sidecar belongs to a
	// content file that no longer exists.
	RuleLinksOrphanSidecar Rule = "links.orphan_sidecar"
)

Links rules: the whole site.

func Rules

func Rules() []Rule

Rules lists every rule id this version knows, in a stable order.

type Severity

type Severity string

Severity of a finding.

const (
	// SeverityError marks a finding the site should not ship with: the
	// editor would refuse the value, the build would break, or a link
	// provably points at nothing.
	SeverityError Severity = "error"
	// SeverityWarning marks a finding worth a look that does not break
	// anything by itself.
	SeverityWarning Severity = "warning"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL