patternkit

package

v0.14.1 Latest Latest Go to latest Published: Oct 21, 2026 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zadstack/gorun

Links

Open Source Insights

Documentation ¶

Overview ¶

Package patternkit validates declarative site-layout pattern packages. Patterns are opinionated page structures layered above themes; they must not declare identity tokens or HTTP extension endpoints.

Constants ¶

View Source

const (
	// ManifestFile is the required package descriptor.
	ManifestFile = "pattern.json"
	// KindPattern is the only accepted kind value.
	KindPattern = "pattern"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Issue ¶

type Issue struct {
	Path string `json:"path,omitempty"`
	Code string `json:"code"`
	Msg  string `json:"msg"`
}

Issue is one validation failure.

func ValidateDir ¶

func ValidateDir(dir string) []Issue

ValidateDir checks a pattern package directory.

func (Issue) String ¶

func (i Issue) String() string

type Manifest ¶

type Manifest struct {
	Kind        string            `json:"kind"`
	Slug        string            `json:"slug"`
	Version     string            `json:"version"`
	Name        map[string]string `json:"name"`
	Description map[string]string `json:"description"`
}

Manifest is the on-disk pattern.json shape.

Source Files ¶

View all Source files

contract.go

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