mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
104 lines
3.0 KiB
104 lines
3.0 KiB
/*
|
|
Copyright The Helm Authors.
|
|
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.
|
|
*/
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"path"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/cobra/doc"
|
|
"golang.org/x/text/cases"
|
|
"golang.org/x/text/language"
|
|
|
|
"helm.sh/helm/v4/pkg/cmd/require"
|
|
)
|
|
|
|
const docsDesc = `
|
|
Generate documentation files for Helm.
|
|
|
|
This command can generate documentation for Helm in the following formats:
|
|
|
|
- Markdown
|
|
- Man pages
|
|
|
|
It can also generate bash autocompletions.
|
|
`
|
|
|
|
type docsOptions struct {
|
|
dest string
|
|
docTypeString string
|
|
topCmd *cobra.Command
|
|
generateHeaders bool
|
|
}
|
|
|
|
func newDocsCmd(out io.Writer) *cobra.Command {
|
|
o := &docsOptions{}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "docs",
|
|
Short: "generate documentation as markdown or man pages",
|
|
Long: docsDesc,
|
|
Hidden: true,
|
|
Args: require.NoArgs,
|
|
ValidArgsFunction: noMoreArgsCompFunc,
|
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
|
o.topCmd = cmd.Root()
|
|
return o.run(out)
|
|
},
|
|
}
|
|
|
|
f := cmd.Flags()
|
|
f.StringVar(&o.dest, "dir", "./", "directory to which documentation is written")
|
|
f.StringVar(&o.docTypeString, "type", "markdown", "the type of documentation to generate (markdown, man, bash)")
|
|
f.BoolVar(&o.generateHeaders, "generate-headers", false, "generate standard headers for markdown files")
|
|
|
|
cmd.RegisterFlagCompletionFunc("type", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
|
|
return []string{"bash", "man", "markdown"}, cobra.ShellCompDirectiveNoFileComp
|
|
})
|
|
|
|
return cmd
|
|
}
|
|
|
|
func (o *docsOptions) run(_ io.Writer) error {
|
|
switch o.docTypeString {
|
|
case "markdown", "mdown", "md":
|
|
if o.generateHeaders {
|
|
standardLinks := func(s string) string { return s }
|
|
|
|
hdrFunc := func(filename string) string {
|
|
base := filepath.Base(filename)
|
|
name := strings.TrimSuffix(base, path.Ext(base))
|
|
title := cases.Title(language.Und, cases.NoLower).String(strings.ReplaceAll(name, "_", " "))
|
|
return fmt.Sprintf("---\ntitle: \"%s\"\n---\n\n", title)
|
|
}
|
|
|
|
return doc.GenMarkdownTreeCustom(o.topCmd, o.dest, hdrFunc, standardLinks)
|
|
}
|
|
return doc.GenMarkdownTree(o.topCmd, o.dest)
|
|
case "man":
|
|
manHdr := &doc.GenManHeader{Title: "HELM", Section: "1"}
|
|
return doc.GenManTree(o.topCmd, manHdr, o.dest)
|
|
case "bash":
|
|
return o.topCmd.GenBashCompletionFile(filepath.Join(o.dest, "completions.bash"))
|
|
default:
|
|
return fmt.Errorf("unknown doc type %q. Try 'markdown' or 'man'", o.docTypeString)
|
|
}
|
|
}
|