Documentation
¶
Index ¶
- func CleanDir(dirPath string, exclusions StringSet) error
- func ExpandShortEnumName(name string) string
- func FilterExamples(description string, lang string) string
- func IsNOptionalInput(t schema.Type) bool
- func IsProvideDefaultsFuncRequired(t schema.Type) bool
- func OptionalType(p *schema.Property) schema.Type
- func PlainType(t schema.Type) schema.Type
- func RequiredType(p *schema.Property) schema.Type
- func ResolvedType(t schema.Type) schema.Type
- func SimplifyInputUnion(t schema.Type) schema.Type
- func SortedKeys(m interface{}) []string
- func UnwrapType(t schema.Type) schema.Type
- func VisitTypeClosure(properties []*schema.Property, visitor func(t schema.Type))
- type DocLanguageHelper
- type Set
- type StringSet
- func (ss StringSet) Add(s string)
- func (ss StringSet) Any() bool
- func (ss StringSet) Contains(subset StringSet) bool
- func (ss StringSet) Delete(s string)
- func (ss StringSet) Except(s string) StringSet
- func (ss StringSet) Has(s string) bool
- func (ss StringSet) SortedValues() []string
- func (ss StringSet) Subtract(other StringSet) StringSet
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 IsNOptionalInput ¶ added in v3.17.0
func IsProvideDefaultsFuncRequired ¶ added in v3.19.0
If a helper function needs to be invoked to provide default values for a plain type. The provided map cannot be reused.
func OptionalType ¶ added in v3.6.0
OptionalType wraps the Property's type in an OptionalType if it is not already optional.
func PlainType ¶ added in v3.6.0
PlainType deeply removes any InputTypes from t, with the exception of argument structs. Use ResolvedType to unwrap argument structs as well.
func RequiredType ¶ added in v3.6.0
RequiredType unwraps the OptionalType enclosing the Property's type, if any.
func ResolvedType ¶ added in v3.6.0
ResolvedType deeply removes any InputTypes from t.
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 UnwrapType ¶ added in v3.6.0
UnwrapType removes any outer OptionalTypes and InputTypes from t.
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 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
GetMethodName(m *schema.Method) string
GetMethodResultName(pkg *schema.Package, modName string, r *schema.Resource, m *schema.Method) 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) Contains ¶ added in v3.5.0
Contains returns true if all elements of the subset are also present in the current set. It also returns true if subset is empty.
func (StringSet) SortedValues ¶
Source Files
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. |
|
hcl2
|
|
|
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 |
|
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. |
|
testing
|
|
|
tstypes
Helper code to assist emitting correctly minimally parenthesized TypeScript type literals.
|
Helper code to assist emitting correctly minimally parenthesized TypeScript type literals. |