dotnet

Documentation

Overview

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, goconst

nolint: lll

Index

• func GeneratePackage(tool string, pkg *schema.Package, extraFiles map[string][]byte) (map[string][]byte, error)
• func Title(s string) string
• type CSharpPackageInfo
• type DocLanguageHelper
  • func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, moduleName, typeName string, input bool) string
  • func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, moduleName, typeName string, input bool) string
  • func (d DocLanguageHelper) GetDocLinkForResourceType(packageName, _, typeName string) string
  • func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string
  • func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error)
  • func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string

Functions

func GeneratePackage

func GeneratePackage(tool string, pkg *schema.Package, extraFiles map[string][]byte) (map[string][]byte, error)

func Title

func Title(s string) string

Title converts the input string to a title case where only the initial letter is upper-cased.

Types

type CSharpPackageInfo

type CSharpPackageInfo struct {
	PackageReferences map[string]string `json:"packageReferences,omitempty"`
	Namespaces        map[string]string `json:"namespaces,omitempty"`
}

CSharpPackageInfo represents the C# language-specific info at the root of the schema.

type DocLanguageHelper

type DocLanguageHelper struct {
	// Namespaces is a map of Pulumi schema module names to their
	// C# equivalent names, to be used when creating fully-qualified
	// property type strings.
	Namespaces map[string]string
}

DocLanguageHelper is the DotNet-specific implementation of the DocLanguageHelper.

func (DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType

func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, moduleName, typeName string, input bool) string

GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.

func (DocLanguageHelper) GetDocLinkForResourceInputOrOutputType

func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, moduleName, typeName string, input bool) string

GetDocLinkForResourceInputOrOutputType returns the doc link for an input or output type of a Resource.

func (DocLanguageHelper) GetDocLinkForResourceType

func (d DocLanguageHelper) GetDocLinkForResourceType(packageName, _, typeName string) string

GetDocLinkForResourceType returns the .NET API doc URL for a type belonging to a resource provider.

func (DocLanguageHelper) GetLanguageTypeString

func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string

GetLanguageTypeString returns the DotNet-specific type given a Pulumi schema type.

func (DocLanguageHelper) GetPropertyName

func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error)

GetPropertyName uses the property's csharp-specific language info, if available, to generate the property name. Otherwise, returns the PascalCase as the default.

func (DocLanguageHelper) GetResourceFunctionResultName

func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string

GetResourceFunctionResultName returns the name of the result type when a function is used to lookup an existing resource.