check

type Check struct {
	Options *CheckOptions
}

type CheckOptions struct {
	LegacyDataSourceFile *LegacyDataSourceFileOptions
	LegacyGuideFile      *LegacyGuideFileOptions
	LegacyIndexFile      *LegacyIndexFileOptions
	LegacyResourceFile   *LegacyResourceFileOptions

	ProviderName string

	RegistryDataSourceFile *RegistryDataSourceFileOptions
	RegistryGuideFile      *RegistryGuideFileOptions
	RegistryIndexFile      *RegistryIndexFileOptions
	RegistryResourceFile   *RegistryResourceFileOptions

	SchemaDataSources map[string]*tfjson.Schema
	SchemaResources   map[string]*tfjson.Schema

	SideNavigation *SideNavigationOptions
}

type FileCheck interface {
	Run(string) error
	RunAll([]string) error
}

type FileOptions struct {
	BasePath string
}

type FrontMatterCheck struct {
	Options *FrontMatterOptions
}

type FrontMatterData struct {
	Description    *string `yaml:"description,omitempty"`
	Layout         *string `yaml:"layout,omitempty"`
	PageTitle      *string `yaml:"page_title,omitempty"`
	SidebarCurrent *string `yaml:"sidebar_current,omitempty"`
	Subcategory    *string `yaml:"subcategory,omitempty"`
}

type FrontMatterOptions struct {
	AllowedSubcategories []string
	NoDescription        bool
	NoLayout             bool
	NoPageTitle          bool
	NoSidebarCurrent     bool
	NoSubcategory        bool
	RequireDescription   bool
	RequireLayout        bool
	RequirePageTitle     bool
	RequireSubcategory   bool
}

type LegacyDataSourceFileCheck struct {
	FileCheck

	Options *LegacyDataSourceFileOptions
}

type LegacyDataSourceFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type LegacyGuideFileCheck struct {
	FileCheck

	Options *LegacyGuideFileOptions
}

type LegacyGuideFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type LegacyIndexFileCheck struct {
	FileCheck

	Options *LegacyIndexFileOptions
}

type LegacyIndexFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type LegacyResourceFileCheck struct {
	FileCheck

	Options *LegacyResourceFileOptions
}

type LegacyResourceFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type RegistryDataSourceFileCheck struct {
	FileCheck

	Options *RegistryDataSourceFileOptions
}

type RegistryDataSourceFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type RegistryGuideFileCheck struct {
	FileCheck

	Options *RegistryGuideFileOptions
}

type RegistryGuideFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type RegistryIndexFileCheck struct {
	FileCheck

	Options *RegistryIndexFileOptions
}

type RegistryIndexFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type RegistryResourceFileCheck struct {
	FileCheck

	Options *RegistryResourceFileOptions
}

type RegistryResourceFileOptions struct {
	*FileOptions

	FrontMatter *FrontMatterOptions
}

type SideNavigationOptions struct {
	*FileOptions

	IgnoreDataSources []string
	IgnoreResources   []string

	ProviderName string
}