-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
doc.go
187 lines (166 loc) 路 6.55 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// Copyright 2016-2020, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// nolint: lll
package dotnet
import (
"encoding/json"
"fmt"
"strings"
"github.com/pulumi/pulumi/pkg/v3/codegen"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
)
// DocLanguageHelper is the DotNet-specific implementation of the 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
}
var _ codegen.DocLanguageHelper = DocLanguageHelper{}
// GetDocLinkForPulumiType returns the .Net API doc link for a Pulumi type.
func (d DocLanguageHelper) GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string {
var filename string
switch typeName {
// We use docfx to generate the .NET language docs. docfx adds a suffix
// to generic classes. The suffix depends on the number of type args the class accepts,
// which in the case of the Pulumi.Input class is 1.
case "Pulumi.Input":
filename = "Pulumi.Input-1"
default:
filename = typeName
}
return fmt.Sprintf("/docs/reference/pkg/dotnet/Pulumi/%s.html", filename)
}
// GetDocLinkForResourceType returns the .NET API doc URL for a type belonging to a resource provider.
func (d DocLanguageHelper) GetDocLinkForResourceType(pkg *schema.Package, _, typeName string) string {
typeName = strings.ReplaceAll(typeName, "?", "")
var packageNamespace string
if pkg == nil {
packageNamespace = ""
} else if pkg.Name != "" {
packageNamespace = "." + namespaceName(d.Namespaces, pkg.Name)
}
return fmt.Sprintf("/docs/reference/pkg/dotnet/Pulumi%s/%s.html", packageNamespace, typeName)
}
// GetDocLinkForResourceInputOrOutputType returns the doc link for an input or output type of a Resource.
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
return d.GetDocLinkForResourceType(pkg, moduleName, typeName)
}
// GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
return d.GetDocLinkForResourceType(pkg, moduleName, typeName)
}
// GetLanguageTypeString returns the DotNet-specific type given a Pulumi schema type.
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input bool) string {
info, ok := pkg.Language["csharp"].(CSharpPackageInfo)
if !ok {
info = CSharpPackageInfo{}
}
typeDetails := map[*schema.ObjectType]*typeDetails{}
mod := &modContext{
pkg: pkg,
mod: moduleName,
typeDetails: typeDetails,
namespaces: d.Namespaces,
rootNamespace: info.GetRootNamespace(),
}
qualifier := "Inputs" // nolint: goconst
if !input {
qualifier = "Outputs"
}
return mod.typeString(t, qualifier, input, false /*state*/, true /*requireInitializers*/)
}
func (d DocLanguageHelper) GetFunctionName(modName string, f *schema.Function) string {
return tokenToFunctionName(f.Token)
}
// GetResourceFunctionResultName returns the name of the result type when a function is used to lookup
// an existing resource.
func (d DocLanguageHelper) GetResourceFunctionResultName(modName string, f *schema.Function) string {
funcName := d.GetFunctionName(modName, f)
return funcName + "Result"
}
func (d DocLanguageHelper) GetMethodName(m *schema.Method) string {
return Title(m.Name)
}
func (d DocLanguageHelper) GetMethodResultName(pkg *schema.Package, modName string, r *schema.Resource,
m *schema.Method) string {
var returnType *schema.ObjectType
if m.Function.ReturnType != nil {
if objectType, ok := m.Function.ReturnType.(*schema.ObjectType); ok {
returnType = objectType
} else {
typeDetails := map[*schema.ObjectType]*typeDetails{}
mod := &modContext{
pkg: pkg,
mod: modName,
typeDetails: typeDetails,
namespaces: d.Namespaces,
}
return mod.typeString(m.Function.ReturnType, "", false, false, false)
}
}
if info, ok := pkg.Language["csharp"].(CSharpPackageInfo); ok {
if info.LiftSingleValueMethodReturns && returnType != nil && len(returnType.Properties) == 1 {
typeDetails := map[*schema.ObjectType]*typeDetails{}
mod := &modContext{
pkg: pkg,
mod: modName,
typeDetails: typeDetails,
namespaces: d.Namespaces,
rootNamespace: info.GetRootNamespace(),
}
return mod.typeString(returnType.Properties[0].Type, "", false, false, false)
}
}
return fmt.Sprintf("%s.%sResult", resourceName(r), d.GetMethodName(m))
}
// GetPropertyName uses the property's csharp-specific language info, if available, to generate
// the property name. Otherwise, returns the PascalCase as the default.
func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error) {
propLangName := strings.Title(p.Name)
if raw, ok := p.Language["csharp"].(json.RawMessage); ok {
val, err := Importer.ImportPropertySpec(p, raw)
if err != nil {
return "", err
}
p.Language["csharp"] = val
}
names := map[*schema.Property]string{}
properties := []*schema.Property{p}
computePropertyNames(properties, names)
if name, ok := names[p]; ok {
return name, nil
}
return propLangName, nil
}
// GetEnumName returns the enum name specific to C#.
func (d DocLanguageHelper) GetEnumName(e *schema.Enum, typeName string) (string, error) {
name := fmt.Sprintf("%v", e.Value)
if e.Name != "" {
name = e.Name
}
return makeSafeEnumName(name, typeName)
}
// GetModuleDocLink returns the display name and the link for a module.
func (d DocLanguageHelper) GetModuleDocLink(pkg *schema.Package, modName string) (string, string) {
var displayName string
var link string
if modName == "" {
displayName = fmt.Sprintf("Pulumi.%s", namespaceName(d.Namespaces, pkg.Name))
} else {
displayName = fmt.Sprintf("Pulumi.%s.%s", namespaceName(d.Namespaces, pkg.Name), modName)
}
link = d.GetDocLinkForResourceType(pkg, "", displayName)
return displayName, link
}