check

type Check struct {
	Options *CheckOptions
}

type CheckOptions struct {
	ActionFileMismatch       *FileMismatchOptions
	DataSourceFileMismatch   *FileMismatchOptions
	EphemeralFileMismatch    *FileMismatchOptions
	FunctionFileMismatch     *FileMismatchOptions
	ListResourceFileMismatch *FileMismatchOptions
	ResourceFileMismatch     *FileMismatchOptions

	LegacyActionFile       *LegacyActionFileOptions
	LegacyDataSourceFile   *LegacyDataSourceFileOptions
	LegacyEphemeralFile    *LegacyEphemeralFileOptions
	LegacyFunctionFile     *LegacyFunctionFileOptions
	LegacyGuideFile        *LegacyGuideFileOptions
	LegacyIndexFile        *LegacyIndexFileOptions
	LegacyListResourceFile *LegacyListResourceFileOptions
	LegacyResourceFile     *LegacyResourceFileOptions

	ProviderName   string
	ProviderSource string

	RegistryActionFile       *RegistryActionFileOptions
	RegistryDataSourceFile   *RegistryDataSourceFileOptions
	RegistryEphemeralFile    *RegistryEphemeralFileOptions
	RegistryFunctionFile     *RegistryFunctionFileOptions
	RegistryGuideFile        *RegistryGuideFileOptions
	RegistryIndexFile        *RegistryIndexFileOptions
	RegistryListResourceFile *RegistryListResourceFileOptions
	RegistryResourceFile     *RegistryResourceFileOptions

	IgnoreCdktfMissingFiles bool
}

type ContentsCheck struct {
	Options *ContentsOptions
}

type ContentsOptions struct {
	*FileOptions

	Enable                                 bool
	EnhancedRegionChecks                   bool
	ProviderName                           string
	RequireAttributesSection               contents.SectionRequirement
	RequireTimeoutsSection                 contents.SectionRequirement
	RequireImportSection                   contents.SectionRequirement
	RequireSchemaOrdering                  bool
	IgnoreContentsCheck                    []string
	IgnoreEnhancedRegionCheck              []string
	IgnoreEnhancedRegionCheckSubcategories []string
	TitleSectionPrefixes                   []string
	RequireSignatureSection                contents.SectionRequirement
	SignatureHeadingTexts                  []string
	SignatureRequiresCodeBlock             bool
	ArgumentsHeadingTexts                  []string
	AllowArgumentsMissingByline            bool

	DisableRegionArgumentCheck         bool
	DisallowAttributesSection          bool
	AttributesSectionDisallowedMessage string
	DisallowImportSection              bool
	ImportSectionDisallowedMessage     string
	ArgumentsBylineTexts               []string
}

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

type FileMismatchCheck struct {
	Options *FileMismatchOptions
}

type FileMismatchOptions struct {
	*FileOptions

	IgnoreFileMismatch []string

	IgnoreFileMissing []string

	ProviderName string

	ResourceType string

	ResourceNames []string
}

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 LegacyActionFileCheck struct {
	FileCheck

	Options *LegacyActionFileOptions
}

type LegacyActionFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type LegacyDataSourceFileCheck struct {
	FileCheck

	Options *LegacyDataSourceFileOptions
}

type LegacyDataSourceFileOptions struct {
	*FileOptions

	Contents    *ContentsOptions
	FrontMatter *FrontMatterOptions
}

type LegacyEphemeralFileCheck struct {
	FileCheck

	Options *LegacyEphemeralFileOptions
}

type LegacyEphemeralFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type LegacyFunctionFileCheck struct {
	FileCheck

	Options *LegacyFunctionFileOptions
}

type LegacyFunctionFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

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 LegacyListResourceFileCheck struct {
	FileCheck

	Options *LegacyListResourceFileOptions
}

type LegacyListResourceFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type LegacyResourceFileCheck struct {
	FileCheck

	Options *LegacyResourceFileOptions
}

type LegacyResourceFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type RegistryActionFileCheck struct {
	FileCheck

	Options *RegistryActionFileOptions
}

type RegistryActionFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type RegistryDataSourceFileCheck struct {
	FileCheck

	Options *RegistryDataSourceFileOptions
}

type RegistryDataSourceFileOptions struct {
	*FileOptions

	Contents    *ContentsOptions
	FrontMatter *FrontMatterOptions
}

type RegistryEphemeralFileCheck struct {
	FileCheck

	Options *RegistryEphemeralFileOptions
}

type RegistryEphemeralFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type RegistryFunctionFileCheck struct {
	FileCheck

	Options *RegistryFunctionFileOptions
}

type RegistryFunctionFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

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 RegistryListResourceFileCheck struct {
	FileCheck

	Options *RegistryListResourceFileOptions
}

type RegistryListResourceFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}

type RegistryResourceFileCheck struct {
	FileCheck

	Options *RegistryResourceFileOptions
}

type RegistryResourceFileOptions struct {
	*FileOptions

	Contents     *ContentsOptions
	FrontMatter  *FrontMatterOptions
	ProviderName string
}