From 79edec1f07a8e74d791342d317fe37dac2acb981 Mon Sep 17 00:00:00 2001 From: Maas Lalani Date: Thu, 13 Jul 2023 11:05:27 -0400 Subject: [PATCH] feat: add man page --- go.mod | 4 ++++ go.sum | 8 ++++++++ main.go | 22 +++++++++++++++++++++- 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 9c77abe..659fb02 100644 --- a/go.mod +++ b/go.mod @@ -6,6 +6,8 @@ require ( github.com/charmbracelet/bubbles v0.16.2-0.20230711184233-0bdcc628fb8f github.com/charmbracelet/bubbletea v0.24.3-0.20230710130425-c4c83ba757f8 github.com/charmbracelet/lipgloss v0.7.1 + github.com/muesli/mango-cobra v1.2.0 + github.com/muesli/roff v0.1.0 github.com/resendlabs/resend-go v1.7.0 github.com/spf13/cobra v1.7.0 github.com/yuin/goldmark v1.5.4 @@ -24,6 +26,8 @@ require ( github.com/mattn/go-runewidth v0.0.14 // indirect github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect github.com/muesli/cancelreader v0.2.2 // indirect + github.com/muesli/mango v0.1.0 // indirect + github.com/muesli/mango-pflag v0.1.0 // indirect github.com/muesli/reflow v0.3.0 // indirect github.com/muesli/termenv v0.15.2 // indirect github.com/rivo/uniseg v0.4.4 // indirect diff --git a/go.sum b/go.sum index 8821445..104c6d4 100644 --- a/go.sum +++ b/go.sum @@ -38,8 +38,16 @@ github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo= github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= +github.com/muesli/mango v0.1.0 h1:DZQK45d2gGbql1arsYA4vfg4d7I9Hfx5rX/GCmzsAvI= +github.com/muesli/mango v0.1.0/go.mod h1:5XFpbC8jY5UUv89YQciiXNlbi+iJgt29VDC5xbzrLL4= +github.com/muesli/mango-cobra v1.2.0 h1:DQvjzAM0PMZr85Iv9LIMaYISpTOliMEg+uMFtNbYvWg= +github.com/muesli/mango-cobra v1.2.0/go.mod h1:vMJL54QytZAJhCT13LPVDfkvCUJ5/4jNUKF/8NC2UjA= +github.com/muesli/mango-pflag v0.1.0 h1:UADqbYgpUyRoBja3g6LUL+3LErjpsOwaC9ywvBWe7Sg= +github.com/muesli/mango-pflag v0.1.0/go.mod h1:YEQomTxaCUp8PrbhFh10UfbhbQrM/xJ4i2PB8VTLLW0= github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= +github.com/muesli/roff v0.1.0 h1:YD0lalCotmYuF5HhZliKWlIx7IEhiXeSfq7hNjFqGF8= +github.com/muesli/roff v0.1.0/go.mod h1:pjAHQM9hdUUwm/krAfrLGgJkXJ+YuhtsfZ42kieB2Ig= github.com/muesli/termenv v0.15.1 h1:UzuTb/+hhlBugQz28rpzey4ZuKcZ03MeKsoG7IJZIxs= github.com/muesli/termenv v0.15.1/go.mod h1:HeAQPTzpfs016yGtA4g00CsdYnVLJvxsS4ANqrZs2sQ= github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo= diff --git a/main.go b/main.go index e4c0e4b..0c64fdb 100644 --- a/main.go +++ b/main.go @@ -8,6 +8,8 @@ import ( "strings" tea "github.com/charmbracelet/bubbletea" + mcobra "github.com/muesli/mango-cobra" + "github.com/muesli/roff" "github.com/resendlabs/resend-go" "github.com/spf13/cobra" ) @@ -119,8 +121,26 @@ var CompletionCmd = &cobra.Command{ }, } +var ManCmd = &cobra.Command{ + Use: "man", + Short: "Generate man page", + Long: `To generate the man page`, + Args: cobra.NoArgs, + Hidden: true, + RunE: func(cmd *cobra.Command, args []string) error { + page, err := mcobra.NewManPage(1, rootCmd) // . + if err != nil { + return err + } + + page = page.WithSection("Copyright", "© 2023 Charmbracelet, Inc.\n"+"Released under MIT License.") + fmt.Println(page.Build(roff.NewDocument())) + return nil + }, +} + func init() { - rootCmd.AddCommand(CompletionCmd) + rootCmd.AddCommand(CompletionCmd, ManCmd) rootCmd.Flags().StringSliceVar(&to, "bcc", []string{}, "BCC recipients") rootCmd.Flags().StringSliceVar(&to, "cc", []string{}, "CC recipients")