Documentation
¶
Index ¶
- func CleanDir(dirPath string, exclusions StringSet) error
- func ExpandShortEnumName(name string) string
- func FilterExamples(description string, lang string) string
- func SortedKeys(m interface{}) []string
- func VisitTypeClosure(properties []*schema.Property, visitor func(t Type))
- type DocLanguageHelper
- type Set
- type StringSet
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CleanDir ¶
CleanDir removes all existing files from a directory except those in the exclusions list. Note: The exclusions currently don't function recursively, so you cannot exclude a single file in a subdirectory, only entire subdirectories. This function will need improvements to be able to target that use-case.
func ExpandShortEnumName ¶
func FilterExamples ¶
FilterExamples filters the code snippets in a schema docstring to include only those that target the given language.
func SortedKeys ¶
func SortedKeys(m interface{}) []string
SortedKeys returns a sorted list of keys for the given map. The map's key type must be of kind string.
func VisitTypeClosure ¶ added in v3.1.0
Types ¶
type DocLanguageHelper ¶
type DocLanguageHelper interface {
GetPropertyName(p *schema.Property) (string, error)
GetEnumName(e *schema.Enum, typeName string) (string, error)
GetDocLinkForResourceType(pkg *schema.Package, moduleName, typeName string) string
GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string
GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string
GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string
GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, args, optional bool) string
GetFunctionName(modName string, f *schema.Function) string
// GetResourceFunctionResultName returns the name of the result type when a static resource function is used to lookup
// an existing resource.
GetResourceFunctionResultName(modName string, f *schema.Function) string
// GetModuleDocLink returns the display name and the link for a module (including root modules) in a given package.
GetModuleDocLink(pkg *schema.Package, modName string) (string, string)
}
DocLanguageHelper is an interface for extracting language-specific information from a Pulumi schema. See the implementation for this interface under each of the language code generators.
type StringSet ¶
type StringSet map[string]struct{}
func NewStringSet ¶
func (StringSet) SortedValues ¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning. |
|
nolint: lll Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
|
nolint: lll Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning. |
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning. |
|
nolint: goconst
|
nolint: goconst |
|
internal
|
|
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning. |
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
|
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning. |