Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
104 lines
3 KiB
Go
104 lines
3 KiB
Go
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
v0 "github.com/ignite/cli/v29/ignite/config/chain/v0"
|
|
v1 "github.com/ignite/cli/v29/ignite/config/chain/v1"
|
|
"github.com/ignite/cli/v29/ignite/pkg/clidoc"
|
|
"github.com/ignite/cli/v29/ignite/pkg/cliui"
|
|
"github.com/ignite/cli/v29/ignite/pkg/errors"
|
|
"github.com/ignite/cli/v29/ignite/pkg/xgenny"
|
|
|
|
"github.com/ignite/cli/ignite/internal/tools/gen-config-doc/templates/doc"
|
|
)
|
|
|
|
const (
|
|
flagVersion = "version"
|
|
flagOutput = "output"
|
|
flagFilename = "filename"
|
|
flagYes = "yes"
|
|
|
|
defaultFilename = "02-config_example.md"
|
|
defaultDocPath = "docs/docs/08-configuration"
|
|
)
|
|
|
|
// NewRootCmd creates a new root command.
|
|
func NewRootCmd() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "gen-config-doc",
|
|
Short: "generate configuration file documentation",
|
|
Long: "This tool is used to generate the chain configuration file documentation",
|
|
RunE: func(cmd *cobra.Command, args []string) (err error) {
|
|
var (
|
|
version, _ = cmd.Flags().GetString(flagVersion)
|
|
output, _ = cmd.Flags().GetString(flagOutput)
|
|
fileName, _ = cmd.Flags().GetString(flagFilename)
|
|
yes, _ = cmd.Flags().GetBool(flagYes)
|
|
)
|
|
session := cliui.New(cliui.WithoutUserInteraction(yes))
|
|
defer session.End()
|
|
|
|
output, err = filepath.Abs(output)
|
|
if err != nil {
|
|
return errors.Wrap(err, "failed to find the abs path")
|
|
}
|
|
|
|
var docs clidoc.Docs
|
|
switch version {
|
|
case "v0":
|
|
docs, err = clidoc.GenDoc(v0.Config{})
|
|
case "v1":
|
|
docs, err = clidoc.GenDoc(v1.Config{})
|
|
default:
|
|
return errors.Errorf("unknown version: %s", version)
|
|
}
|
|
if err != nil {
|
|
return errors.Wrapf(err, "failed to generate migration doc %s", version)
|
|
}
|
|
|
|
// Generate the docs file.
|
|
g, err := doc.NewGenerator(doc.Options{
|
|
Path: output,
|
|
FileName: fileName,
|
|
Config: docs.String(),
|
|
})
|
|
if err != nil {
|
|
return errors.Wrap(err, "failed to create the doc generator object")
|
|
}
|
|
|
|
runner := xgenny.NewRunner(cmd.Context(), output)
|
|
sm, err := runner.RunAndApply(g, xgenny.ApplyPreRun(func(_, _, duplicated []string) error {
|
|
if len(duplicated) == 0 {
|
|
return nil
|
|
}
|
|
question := fmt.Sprintf("Do you want to overwrite the existing files? \n%s", strings.Join(duplicated, "\n"))
|
|
return session.AskConfirm(question)
|
|
}))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
files := append(sm.CreatedFiles(), sm.ModifiedFiles()...)
|
|
if len(files) == 0 {
|
|
return errors.Errorf("config doc not created at %s", output)
|
|
}
|
|
session.EventBus().SendInfo(
|
|
fmt.Sprintf("Config doc generated successfully at %s", files[0]),
|
|
)
|
|
|
|
return nil
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringP(flagVersion, "v", "v1", "Version of Ignite config file")
|
|
cmd.Flags().StringP(flagOutput, "o", defaultDocPath, "Output directory to save the config document")
|
|
cmd.Flags().StringP(flagFilename, "f", defaultFilename, "Document file name")
|
|
cmd.Flags().BoolP(flagYes, "y", false, "answers interactive yes/no questions with yes")
|
|
|
|
return cmd
|
|
}
|