b8ee5c5eba
Add documentation comments to exported symbols across all remaining smaller packages including cmd/gen-docs, context, internal/browser, internal/gh, internal/ghcmd, internal/ghinstance, internal/ghrepo, internal/keyring, internal/run, internal/safepaths, internal/tableprinter, internal/text, internal/update, pkg/cmd/accessibility, pkg/cmd/actions, pkg/cmd/alias, pkg/cmd/api, pkg/cmd/browse, pkg/cmd/cache, pkg/cmd/completion, pkg/cmd/copilot, pkg/cmd/factory, pkg/cmd/gpg-key, pkg/cmd/label, pkg/cmd/licenses, pkg/cmd/org, pkg/cmd/preview, pkg/cmd/ssh-key, pkg/cmd/version, pkg/extensions, pkg/jsoncolor, pkg/markdown, pkg/option, pkg/set, pkg/ssh, pkg/surveyext, test, internal/authflow, and utils. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
143 lines
3.2 KiB
Go
143 lines
3.2 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/cli/cli/v2/internal/config"
|
|
"github.com/cli/cli/v2/internal/docs"
|
|
"github.com/cli/cli/v2/internal/gh"
|
|
"github.com/cli/cli/v2/internal/ghrepo"
|
|
"github.com/cli/cli/v2/pkg/cmd/root"
|
|
"github.com/cli/cli/v2/pkg/cmdutil"
|
|
"github.com/cli/cli/v2/pkg/extensions"
|
|
"github.com/cli/cli/v2/pkg/iostreams"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
func main() {
|
|
if err := run(os.Args); err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
|
|
func run(args []string) error {
|
|
flags := pflag.NewFlagSet("", pflag.ContinueOnError)
|
|
manPage := flags.BoolP("man-page", "", false, "Generate manual pages")
|
|
website := flags.BoolP("website", "", false, "Generate website pages")
|
|
dir := flags.StringP("doc-path", "", "", "Path directory where you want generate doc files")
|
|
help := flags.BoolP("help", "h", false, "Help about any command")
|
|
|
|
if err := flags.Parse(args); err != nil {
|
|
return err
|
|
}
|
|
|
|
if *help {
|
|
fmt.Fprintf(os.Stderr, "Usage of %s:\n\n%s", filepath.Base(args[0]), flags.FlagUsages())
|
|
return nil
|
|
}
|
|
|
|
if *dir == "" {
|
|
return fmt.Errorf("error: --doc-path not set")
|
|
}
|
|
|
|
ios, _, _, _ := iostreams.Test()
|
|
rootCmd, _ := root.NewCmdRoot(&cmdutil.Factory{
|
|
IOStreams: ios,
|
|
Browser: &browser{},
|
|
Config: func() (gh.Config, error) {
|
|
return config.NewFromString(""), nil
|
|
},
|
|
ExtensionManager: &em{},
|
|
}, "", "")
|
|
rootCmd.InitDefaultHelpCmd()
|
|
|
|
if err := os.MkdirAll(*dir, 0755); err != nil {
|
|
return err
|
|
}
|
|
|
|
if *website {
|
|
if err := docs.GenMarkdownTreeCustom(rootCmd, *dir, filePrepender, linkHandler); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if *manPage {
|
|
if err := docs.GenManTree(rootCmd, *dir); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func filePrepender(filename string) string {
|
|
return `---
|
|
layout: manual
|
|
permalink: /:path/:basename
|
|
---
|
|
|
|
`
|
|
}
|
|
|
|
func linkHandler(name string) string {
|
|
return fmt.Sprintf("./%s", strings.TrimSuffix(name, ".md"))
|
|
}
|
|
|
|
// Implements browser.Browser interface.
|
|
type browser struct{}
|
|
|
|
// Browse opens the given URL in a browser.
|
|
func (b *browser) Browse(_ string) error {
|
|
return nil
|
|
}
|
|
|
|
// Implements extensions.ExtensionManager interface.
|
|
type em struct{}
|
|
|
|
// List returns the list of installed extensions.
|
|
func (e *em) List() []extensions.Extension {
|
|
return nil
|
|
}
|
|
|
|
// Install installs an extension from a repository.
|
|
func (e *em) Install(_ ghrepo.Interface, _ string) error {
|
|
return nil
|
|
}
|
|
|
|
// InstallLocal installs an extension from a local directory.
|
|
func (e *em) InstallLocal(_ string) error {
|
|
return nil
|
|
}
|
|
|
|
// Upgrade upgrades an installed extension.
|
|
func (e *em) Upgrade(_ string, _ bool) error {
|
|
return nil
|
|
}
|
|
|
|
// Remove deletes a value from the set.
|
|
func (e *em) Remove(_ string) error {
|
|
return nil
|
|
}
|
|
|
|
// Dispatch executes an installed extension.
|
|
func (e *em) Dispatch(_ []string, _ io.Reader, _, _ io.Writer) (bool, error) {
|
|
return false, nil
|
|
}
|
|
|
|
// Create initializes a new extension project.
|
|
func (e *em) Create(_ string, _ extensions.ExtTemplateType) error {
|
|
return nil
|
|
}
|
|
|
|
// EnableDryRunMode enables dry run mode for the extension manager.
|
|
func (e *em) EnableDryRunMode() {}
|
|
|
|
// UpdateDir sets the directory used for extension updates.
|
|
func (e *em) UpdateDir(_ string) string {
|
|
return ""
|
|
}
|