7b17463031
* Add a new DocLangHelper interface method to generate function names per language. Use the functionNames override map in Go to correctly generate a function name. * Add kong to the title lookup map. * Check if item was found in map. * Use title case for the nodejs Function args type name. Use title case for the function name in the index page. * Also fix the result name for a Function in nodejs to use title case. * Use the module name to lookup the package. * Use the title-case name for the Function name in the index page. Fix the language value passed to the lang chooser in function.tmpl. * Use title case for nested type titles. * Add title lookup for GitHub.
75 lines
2.2 KiB
Go
75 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/v2/codegen/dotnet"
|
|
go_gen "github.com/pulumi/pulumi/pkg/v2/codegen/go"
|
|
"github.com/pulumi/pulumi/sdk/v2/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 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)
|
|
}
|
|
}
|