check

package

Go to main page

Versions in this module

v0

v0.24.0

Oct 13, 2025

Changes in this version

+ const LegacyListResourcesDirectory

+ const RegistryListResourcesDirectory

type FileMismatchOptions

+ ListResourceEntries []os.DirEntry

v0.23.0

Sep 17, 2025

Changes in this version

+ const LegacyActionsDirectory

+ const RegistryActionsDirectory

type FileMismatchCheck

+ func (check *FileMismatchCheck) ActionFileMismatchCheck(files []os.DirEntry, actionType string, ...) error

type FileMismatchOptions

+ ActionEntries []os.DirEntry

v0.22.0

Jul 1, 2025

Changes in this version

type FrontMatterOptions

+ AllowedSubcategories []string

v0.21.0

Feb 27, 2025

v0.20.1

Nov 26, 2024

v0.20.0

Nov 6, 2024

Changes in this version

+ const LegacyEphemeralResourcesDirectory

+ const RegistryEphemeralResourcesDirectory

type FileMismatchOptions

+ EphemeralResourceEntries []os.DirEntry

type ProviderFileCheck

+ ProviderFs fs.FS

v0.19.4

Jun 4, 2024

v0.19.3

May 28, 2024

v0.19.2

Apr 29, 2024

v0.19.1

Apr 22, 2024

v0.19.0

Apr 15, 2024

Changes in this version

+ const CdktfIndexDirectory

+ const FileExtensionHtmlMarkdown

+ const FileExtensionHtmlMd

+ const FileExtensionMarkdown

+ const FileExtensionMd

+ const LegacyDataSourcesDirectory

+ const LegacyFunctionsDirectory

+ const LegacyGuidesDirectory

+ const LegacyIndexDirectory

+ const LegacyResourcesDirectory

+ const RegistryDataSourcesDirectory

+ const RegistryFunctionsDirectory

+ const RegistryGuidesDirectory

+ const RegistryIndexDirectory

+ const RegistryMaximumNumberOfFiles

+ const RegistryMaximumSizeOfFile

+ const RegistryResourcesDirectory

+ var ValidCdktfLanguages = []string

+ var ValidLegacyDirectories = []string

+ var ValidLegacyFileExtensions = []string

+ var ValidLegacySubdirectories = []string

+ var ValidRegistryDirectories = []string

+ var ValidRegistryFileExtensions = []string

+ var ValidRegistrySubdirectories = []string

+ func FileExtensionCheck(path string, validExtensions []string) error

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

+ func FileSizeCheck(fullpath string) error

+ func InvalidDirectoriesCheck(dirPath string) error

+ func IsValidCdktfDirectory(directory string) bool

+ func IsValidLegacyDirectory(directory string) bool

+ func IsValidRegistryDirectory(directory string) bool

+ func MixedDirectoriesCheck(docFiles []string) error

+ func NumberOfFilesCheck(docFiles []string) error

+ func TrimFileExtension(path string) string

+ type FileMismatchCheck struct

+ Options *FileMismatchOptions

+ func NewFileMismatchCheck(opts *FileMismatchOptions) *FileMismatchCheck

+ func (check *FileMismatchCheck) FunctionFileMismatchCheck(files []os.DirEntry, functions map[string]*tfjson.FunctionSignature) error

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

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

+ func (check *FileMismatchCheck) ResourceFileMismatchCheck(files []os.DirEntry, resourceType string, schemas map[string]*tfjson.Schema) error

+ func (check *FileMismatchCheck) Run() error

+ type FileMismatchOptions struct

+ DatasourceEntries []os.DirEntry

+ FunctionEntries []os.DirEntry

+ IgnoreFileMismatch []string

+ IgnoreFileMissing []string

+ ProviderShortName string

+ ResourceEntries []os.DirEntry

+ Schema *tfjson.ProviderSchema

+ 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

+ NoLayout bool

+ NoPageTitle bool

+ NoSidebarCurrent bool

+ NoSubcategory bool

+ RequireDescription bool

+ RequireLayout bool

+ RequirePageTitle bool

+ type ProviderFileCheck struct

+ Options *ProviderFileOptions

+ func NewProviderFileCheck(opts *ProviderFileOptions) *ProviderFileCheck

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

+ type ProviderFileOptions struct

+ FrontMatter *FrontMatterOptions

+ ValidExtensions []string

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