40f17faa73
* Added a new template for Functions. Implement the genFunction method for generating the docs for Functions. * Rename type resourceArgs to resourceDocArgs. Minor updates the resource template. * Generate nested types for Functions. * Unexport types that don't need to be exported. Create the doc language helper objects in an init function and reuse them rather than recreating them every time. Update genNestedTypes to work with schema functions or resources. * Fixed bug in nested type generation for Functions. Fixed bug in generating input and output doc links for nested types.
78 lines
3 KiB
Go
78 lines
3 KiB
Go
// 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.
|
|
|
|
// 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
|
|
package gen
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/pulumi/pulumi/pkg/codegen"
|
|
"github.com/pulumi/pulumi/pkg/codegen/schema"
|
|
)
|
|
|
|
// DocLanguageHelper is the Go-specific implementation of the DocLanguageHelper.
|
|
type DocLanguageHelper struct{}
|
|
|
|
var _ codegen.DocLanguageHelper = DocLanguageHelper{}
|
|
|
|
// GetDocLinkForResourceType returns the godoc URL for a type belonging to a resource provider.
|
|
func (d DocLanguageHelper) GetDocLinkForResourceType(packageName string, moduleName string, typeName string) string {
|
|
path := fmt.Sprintf("%s/%s", packageName, moduleName)
|
|
typeNameParts := strings.Split(typeName, ".")
|
|
typeName = typeNameParts[len(typeNameParts)-1]
|
|
typeName = strings.TrimPrefix(typeName, "*")
|
|
return fmt.Sprintf("https://pkg.go.dev/github.com/pulumi/pulumi-%s/sdk/go/%s?tab=doc#%s", packageName, path, typeName)
|
|
}
|
|
|
|
// GetDocLinkForResourceInputOrOutputType returns the godoc URL for an input or output type.
|
|
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, moduleName, typeName string, input bool) string {
|
|
link := d.GetDocLinkForResourceType(packageName, moduleName, typeName)
|
|
if !input {
|
|
return link + "Output"
|
|
}
|
|
return link + "Args"
|
|
}
|
|
|
|
// GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.
|
|
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, moduleName, typeName string, input bool) string {
|
|
link := d.GetDocLinkForResourceType(packageName, moduleName, typeName)
|
|
if !input {
|
|
return link
|
|
}
|
|
return link + "Args"
|
|
}
|
|
|
|
// GetDocLinkForBuiltInType returns the godoc URL for a built-in type.
|
|
func GetDocLinkForBuiltInType(typeName string) string {
|
|
return fmt.Sprintf("https://golang.org/pkg/builtin/#%s", typeName)
|
|
}
|
|
|
|
// GetLanguageTypeString returns the Go-specific type given a Pulumi schema type.
|
|
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string {
|
|
mod := &pkgContext{
|
|
pkg: pkg,
|
|
}
|
|
return mod.plainType(t, optional)
|
|
}
|
|
|
|
// GetResourceFunctionResultName returns the name of the result type when a function is used to lookup
|
|
// an existing resource.
|
|
func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string {
|
|
return "Lookup" + resourceName + "Result"
|
|
}
|