22aeaa43b1
* Add new templates for generating index files. Remove the now irrelevant code. * Add comment for generating index files by deduping module names. Use the path format of a module name as the link. * Add a trailing slash for module links in the index page. * Move the categories rendered in the index file into their own template file. Handle kubernetes provider specific module name conversion while generating parent modules. * Fix issue with the k8s provider resource being generated as a module rather than a resource on the package-level index page. * Show the deprecation message of a resource at the top of the document. * Move k8s specific things to its own file. * Add title attribute to the list items. Show the last part of a module name, in case it contains path separators * Lookup the package name from the Go language info object for k8s then use that to lookup the C# namespace. * Move the logic for cleaning a property type string for display names to a separate function. * Export the title function from go and dotnet code generators for use in the resource doc generator. Use the title function from the respective lang code gens to match the correct title case used there. Fix issue with the Kubernetes namespace not being stripped for C# property type strings. * Skip including apiVersion and kind as input properties for Kubernetes until pulumi-kubernetes#1062 is merged.
74 lines
2.2 KiB
Go
74 lines
2.2 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 docs
|
|
|
|
import (
|
|
"strings"
|
|
"unicode"
|
|
|
|
"github.com/pulumi/pulumi/pkg/codegen/dotnet"
|
|
go_gen "github.com/pulumi/pulumi/pkg/codegen/go"
|
|
"github.com/pulumi/pulumi/sdk/go/common/util/contract"
|
|
)
|
|
|
|
func isDotNetTypeNameBoundary(prev rune, next rune) bool {
|
|
// For C# type names, which are PascalCase are qualified using "." as the separator.
|
|
return prev == rune('.') && unicode.IsUpper(next)
|
|
}
|
|
|
|
func isPythonTypeNameBoundary(prev rune, next rune) bool {
|
|
// For Python, names are snake_cased (Duh?).
|
|
return (prev == rune('_') && unicode.IsLower(next))
|
|
}
|
|
|
|
// wbr inserts HTML <wbr> in between case changes, e.g. "fooBar" becomes "foo<wbr>Bar".
|
|
func wbr(s string) string {
|
|
var runes []rune
|
|
var prev rune
|
|
for i, r := range s {
|
|
if i != 0 &&
|
|
// For TS, JS and Go, property names are camelCase and types are PascalCase.
|
|
((unicode.IsLower(prev) && unicode.IsUpper(r)) ||
|
|
isDotNetTypeNameBoundary(prev, r) ||
|
|
isPythonTypeNameBoundary(prev, r)) {
|
|
runes = append(runes, []rune("<wbr>")...)
|
|
}
|
|
runes = append(runes, r)
|
|
prev = r
|
|
}
|
|
return string(runes)
|
|
}
|
|
|
|
// tokenToName returns the resource name from a Pulumi token.
|
|
func tokenToName(tok string) string {
|
|
components := strings.Split(tok, ":")
|
|
contract.Assertf(len(components) == 3, "malformed token %v", tok)
|
|
return strings.Title(components[2])
|
|
}
|
|
|
|
func title(s, lang string) string {
|
|
switch lang {
|
|
case "go":
|
|
return go_gen.Title(s)
|
|
case "csharp":
|
|
return dotnet.Title(s)
|
|
default:
|
|
return strings.Title(s)
|
|
}
|
|
}
|