check

Sep 17, 2025

Changes in this version

+ const LegacyActionsDirectory

+ const LegacyListResourcesDirectory

+ const RegistryActionsDirectory

+ const RegistryListResourcesDirectory

+ const ResourceTypeAction

+ const ResourceTypeListResource

type CheckOptions

+ ActionFileMismatch *FileMismatchOptions

+ LegacyActionFile *LegacyActionFileOptions

+ LegacyListResourceFile *LegacyListResourceFileOptions

+ ListResourceFileMismatch *FileMismatchOptions

+ RegistryActionFile *RegistryActionFileOptions

+ RegistryListResourceFile *RegistryListResourceFileOptions

type ContentsOptions

+ AllowArgumentsMissingByline bool

+ ArgumentsBylineTexts []string

+ ArgumentsHeadingTexts []string

+ AttributesSectionDisallowedMessage string

+ DisableRegionArgumentCheck bool

+ DisallowAttributesSection bool

+ DisallowImportSection bool

+ ImportSectionDisallowedMessage string

+ RequireAttributesSection contents.SectionRequirement

+ RequireImportSection contents.SectionRequirement

+ RequireSignatureSection contents.SectionRequirement

+ RequireTimeoutsSection contents.SectionRequirement

+ SignatureHeadingTexts []string

+ SignatureRequiresCodeBlock bool

+ TitleSectionPrefixes []string

+ type LegacyActionFileCheck struct

+ Options *LegacyActionFileOptions

+ func NewLegacyActionFileCheck(opts *LegacyActionFileOptions) *LegacyActionFileCheck

+ func (check *LegacyActionFileCheck) Run(path string, exampleLanguage string) error

+ func (check *LegacyActionFileCheck) RunAll(files []string, exampleLanguage string) error

+ type LegacyActionFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

type LegacyFunctionFileOptions

+ Contents *ContentsOptions

+ ProviderName string

+ type LegacyListResourceFileCheck struct

+ Options *LegacyListResourceFileOptions

+ func NewLegacyListResourceFileCheck(opts *LegacyListResourceFileOptions) *LegacyListResourceFileCheck

+ func (check *LegacyListResourceFileCheck) Run(path string, exampleLanguage string) error

+ func (check *LegacyListResourceFileCheck) RunAll(files []string, exampleLanguage string) error

+ type LegacyListResourceFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

+ type RegistryActionFileCheck struct

+ Options *RegistryActionFileOptions

+ func NewRegistryActionFileCheck(opts *RegistryActionFileOptions) *RegistryActionFileCheck

+ func (check *RegistryActionFileCheck) Run(path string, exampleLanguage string) error

+ func (check *RegistryActionFileCheck) RunAll(files []string, exampleLanguage string) error

+ type RegistryActionFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

type RegistryFunctionFileOptions

+ Contents *ContentsOptions

+ ProviderName string

+ type RegistryListResourceFileCheck struct

+ Options *RegistryListResourceFileOptions

+ func NewRegistryListResourceFileCheck(opts *RegistryListResourceFileOptions) *RegistryListResourceFileCheck

+ func (check *RegistryListResourceFileCheck) Run(path string, exampleLanguage string) error

+ func (check *RegistryListResourceFileCheck) RunAll(files []string, exampleLanguage string) error

+ type RegistryListResourceFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

May 21, 2025

Changes in this version

type ContentsOptions

+ EnhancedRegionChecks bool

+ IgnoreEnhancedRegionCheck []string

+ IgnoreEnhancedRegionCheckSubcategories []string

May 8, 2025

Changes in this version

type ContentsOptions

+ IgnoreContentsCheck []string

May 7, 2025

Changes in this version

type LegacyDataSourceFileOptions

+ Contents *ContentsOptions

type RegistryDataSourceFileOptions

+ Contents *ContentsOptions

Jan 2, 2025

Changes in this version

+ const FileIgnoreDSStore

+ var IgnoreFiles = []string

+ func FileIgnoreCheck(path string) bool

Oct 30, 2024

Changes in this version

+ const LegacyEphemeralsDirectory

+ const RegistryEphemeralsDirectory

+ const ResourceTypeEphemeral

type CheckOptions

+ EphemeralFileMismatch *FileMismatchOptions

+ LegacyEphemeralFile *LegacyEphemeralFileOptions

+ RegistryEphemeralFile *RegistryEphemeralFileOptions

+ type LegacyEphemeralFileCheck struct

+ Options *LegacyEphemeralFileOptions

+ func NewLegacyEphemeralFileCheck(opts *LegacyEphemeralFileOptions) *LegacyEphemeralFileCheck

+ func (check *LegacyEphemeralFileCheck) Run(path string, exampleLanguage string) error

+ func (check *LegacyEphemeralFileCheck) RunAll(files []string, exampleLanguage string) error

+ type LegacyEphemeralFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

+ type RegistryEphemeralFileCheck struct

+ Options *RegistryEphemeralFileOptions

+ func NewRegistryEphemeralFileCheck(opts *RegistryEphemeralFileOptions) *RegistryEphemeralFileCheck

+ func (check *RegistryEphemeralFileCheck) Run(path string, exampleLanguage string) error

+ func (check *RegistryEphemeralFileCheck) RunAll(files []string, exampleLanguage string) error

+ type RegistryEphemeralFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

Mar 6, 2024

Changes in this version

+ const LegacyFunctionsDirectory

+ const RegistryFunctionsDirectory

+ const ResourceTypeFunction

type CheckOptions

+ FunctionFileMismatch *FileMismatchOptions

+ LegacyFunctionFile *LegacyFunctionFileOptions

+ RegistryFunctionFile *RegistryFunctionFileOptions

type FileMismatchOptions

+ ResourceNames []string

+ type LegacyFunctionFileCheck struct

+ Options *LegacyFunctionFileOptions

+ func NewLegacyFunctionFileCheck(opts *LegacyFunctionFileOptions) *LegacyFunctionFileCheck

+ func (check *LegacyFunctionFileCheck) Run(path string) error

+ func (check *LegacyFunctionFileCheck) RunAll(files []string) error

+ type LegacyFunctionFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type RegistryFunctionFileCheck struct

+ Options *RegistryFunctionFileOptions

+ func NewRegistryFunctionFileCheck(opts *RegistryFunctionFileOptions) *RegistryFunctionFileCheck

+ func (check *RegistryFunctionFileCheck) Run(path string) error

+ func (check *RegistryFunctionFileCheck) RunAll(files []string) error

+ type RegistryFunctionFileOptions struct

+ FrontMatter *FrontMatterOptions

Jun 29, 2023

Changes in this version

+ const CdktfIndexDirectory

+ const DocumentationGlobPattern

+ const FileExtensionHtmlMarkdown

+ const FileExtensionHtmlMd

+ const FileExtensionMarkdown

+ const FileExtensionMd

+ const LegacyDataSourcesDirectory

+ const LegacyGuidesDirectory

+ const LegacyIndexDirectory

+ const LegacyResourcesDirectory

+ const RegistryDataSourcesDirectory

+ const RegistryGuidesDirectory

+ const RegistryIndexDirectory

+ const RegistryMaximumNumberOfFiles

+ const RegistryMaximumSizeOfFile

+ const RegistryResourcesDirectory

+ const ResourceTypeDataSource

+ const ResourceTypeResource

+ var ValidCdktfLanguages = []string

+ var ValidLegacyDirectories = []string

+ var ValidLegacyFileExtensions = []string

+ var ValidLegacySubdirectories = []string

+ var ValidRegistryDirectories = []string

+ var ValidRegistryFileExtensions = []string

+ var ValidRegistrySubdirectories = []string

+ func FilePathEndsWithExtensionFrom(path string, validExtensions []string) bool

+ func FileSizeCheck(fullpath string) error

+ func GetDirectories(basepath string) (map[string][]string, error)

+ func InvalidDirectoriesCheck(directories map[string][]string) error

+ func IsValidCdktfDirectory(directory string) bool

+ func IsValidLegacyDirectory(directory string) bool

+ func IsValidRegistryDirectory(directory string) bool

+ func LegacyFileExtensionCheck(path string) error

+ func MixedDirectoriesCheck(directories map[string][]string) error

+ func NumberOfFilesCheck(directories map[string][]string) error

+ func RegistryFileExtensionCheck(path string) error

+ func TrimFileExtension(path string) string

+ type Check struct

+ Options *CheckOptions

+ func NewCheck(opts *CheckOptions) *Check

+ func (check *Check) Run(directories map[string][]string) error

+ type CheckOptions struct

+ DataSourceFileMismatch *FileMismatchOptions

+ IgnoreCdktfMissingFiles bool

+ LegacyDataSourceFile *LegacyDataSourceFileOptions

+ LegacyGuideFile *LegacyGuideFileOptions

+ LegacyIndexFile *LegacyIndexFileOptions

+ LegacyResourceFile *LegacyResourceFileOptions

+ ProviderName string

+ ProviderSource string

+ RegistryDataSourceFile *RegistryDataSourceFileOptions

+ RegistryGuideFile *RegistryGuideFileOptions

+ RegistryIndexFile *RegistryIndexFileOptions

+ RegistryResourceFile *RegistryResourceFileOptions

+ ResourceFileMismatch *FileMismatchOptions

+ type ContentsCheck struct

+ Options *ContentsOptions

+ func NewContentsCheck(opts *ContentsOptions) *ContentsCheck

+ func (check *ContentsCheck) Run(path string, exampleLanguage string) error

+ type ContentsOptions struct

+ Enable bool

+ ProviderName string

+ RequireSchemaOrdering bool

+ type FileCheck interface

+ Run func(string) error

+ RunAll func([]string) error

+ type FileMismatchCheck struct

+ Options *FileMismatchOptions

+ func NewFileMismatchCheck(opts *FileMismatchOptions) *FileMismatchCheck

+ func (check *FileMismatchCheck) IgnoreFileMismatch(file string) bool

+ func (check *FileMismatchCheck) IgnoreFileMissing(resourceName string) bool

+ func (check *FileMismatchCheck) Run(files []string) error

+ type FileMismatchOptions struct

+ IgnoreFileMismatch []string

+ IgnoreFileMissing []string

+ ProviderName string

+ ResourceType string

+ Schemas map[string]*tfjson.Schema

+ type FileOptions struct

+ BasePath string

+ func (opts *FileOptions) FullPath(path string) string

+ type FrontMatterCheck struct

+ Options *FrontMatterOptions

+ func NewFrontMatterCheck(opts *FrontMatterOptions) *FrontMatterCheck

+ func (check *FrontMatterCheck) Run(src []byte) error

+ type FrontMatterData struct

+ Description *string

+ Layout *string

+ PageTitle *string

+ SidebarCurrent *string

+ Subcategory *string

+ 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

+ Options *LegacyDataSourceFileOptions

+ func NewLegacyDataSourceFileCheck(opts *LegacyDataSourceFileOptions) *LegacyDataSourceFileCheck

+ func (check *LegacyDataSourceFileCheck) Run(path string) error

+ func (check *LegacyDataSourceFileCheck) RunAll(files []string) error

+ type LegacyDataSourceFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type LegacyGuideFileCheck struct

+ Options *LegacyGuideFileOptions

+ func NewLegacyGuideFileCheck(opts *LegacyGuideFileOptions) *LegacyGuideFileCheck

+ func (check *LegacyGuideFileCheck) Run(path string) error

+ func (check *LegacyGuideFileCheck) RunAll(files []string) error

+ type LegacyGuideFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type LegacyIndexFileCheck struct

+ Options *LegacyIndexFileOptions

+ func NewLegacyIndexFileCheck(opts *LegacyIndexFileOptions) *LegacyIndexFileCheck

+ func (check *LegacyIndexFileCheck) Run(path string) error

+ func (check *LegacyIndexFileCheck) RunAll(files []string) error

+ type LegacyIndexFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type LegacyResourceFileCheck struct

+ Options *LegacyResourceFileOptions

+ func NewLegacyResourceFileCheck(opts *LegacyResourceFileOptions) *LegacyResourceFileCheck

+ func (check *LegacyResourceFileCheck) Run(path string, exampleLanguage string) error

+ func (check *LegacyResourceFileCheck) RunAll(files []string, exampleLanguage string) error

+ type LegacyResourceFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string

+ type RegistryDataSourceFileCheck struct

+ Options *RegistryDataSourceFileOptions

+ func NewRegistryDataSourceFileCheck(opts *RegistryDataSourceFileOptions) *RegistryDataSourceFileCheck

+ func (check *RegistryDataSourceFileCheck) Run(path string) error

+ func (check *RegistryDataSourceFileCheck) RunAll(files []string) error

+ type RegistryDataSourceFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type RegistryGuideFileCheck struct

+ Options *RegistryGuideFileOptions

+ func NewRegistryGuideFileCheck(opts *RegistryGuideFileOptions) *RegistryGuideFileCheck

+ func (check *RegistryGuideFileCheck) Run(path string) error

+ func (check *RegistryGuideFileCheck) RunAll(files []string) error

+ type RegistryGuideFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type RegistryIndexFileCheck struct

+ Options *RegistryIndexFileOptions

+ func NewRegistryIndexFileCheck(opts *RegistryIndexFileOptions) *RegistryIndexFileCheck

+ func (check *RegistryIndexFileCheck) Run(path string) error

+ func (check *RegistryIndexFileCheck) RunAll(files []string) error

+ type RegistryIndexFileOptions struct

+ FrontMatter *FrontMatterOptions

+ type RegistryResourceFileCheck struct

+ Options *RegistryResourceFileOptions

+ func NewRegistryResourceFileCheck(opts *RegistryResourceFileOptions) *RegistryResourceFileCheck

+ func (check *RegistryResourceFileCheck) Run(path string, exampleLanguage string) error

+ func (check *RegistryResourceFileCheck) RunAll(files []string, exampleLanguage string) error

+ type RegistryResourceFileOptions struct

+ Contents *ContentsOptions

+ FrontMatter *FrontMatterOptions

+ ProviderName string