guidelines

Documentation

Index

• type DB
  • func Load() (*DB, error)
  • func (db *DB) Get(section string) (*Guideline, bool)
  • func (db *DB) Search(query string) []Guideline
  • func (db *DB) TopLevel() []Guideline
• type Guideline

Types

type DB

type DB struct {
	Guidelines []Guideline `json:"guidelines"`
	// contains filtered or unexported fields
}

DB holds the full set of guidelines for querying.

func Load

func Load() (*DB, error)

Load parses the embedded guidelines JSON.

func (*DB) Get

func (db *DB) Get(section string) (*Guideline, bool)

Get returns a guideline by section number (e.g. "2.1", "5.1.1").

func (*DB) Search

func (db *DB) Search(query string) []Guideline

Search finds guidelines matching a keyword query.

func (*DB) TopLevel

func (db *DB) TopLevel() []Guideline

TopLevel returns the 5 top-level guideline sections.

type Guideline

type Guideline struct {
	Section          string      `json:"section"`
	Title            string      `json:"title"`
	Content          string      `json:"content"`
	CommonViolations []string    `json:"common_violations,omitempty"`
	Subsections      []Guideline `json:"subsections,omitempty"`
}

Guideline represents a single Apple review guideline.