Add 'docs <game_url>' command

Author: juho05

README.md

@@ -21,6 +21,11 @@ Get information about a game server:
 codegame info <url>
 ```
 
+View the documentation of a game:
+```sh
+codegame docs <url>
+```
+
 Help:
 ```sh
 codegame --help

commands/docs.go

@@ -0,0 +1,83 @@
+package commands
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/code-game-project/codegame-cli/cli"
+	"github.com/code-game-project/codegame-cli/external"
+	"github.com/gomarkdown/markdown"
+	"github.com/gomarkdown/markdown/html"
+	"github.com/gomarkdown/markdown/parser"
+	"github.com/ogier/pflag"
+
+	_ "embed"
+)
+
+//go:embed templates/css/docs.css
+var docsStyle string
+
+func Docs() error {
+	if pflag.NArg() == 1 {
+		cli.Begin("Opening documentation...")
+		err := external.OpenBrowser("https://docs.code-game.org")
+		if err != nil {
+			cli.Error(err.Error())
+		}
+		cli.Finish()
+		return err
+	}
+
+	cli.Begin("Generating markdown documentation...")
+
+	url := trimURL(pflag.Arg(1))
+	url = baseURL(url, isSSL(url))
+
+	cgeVersion, err := external.GetCGEVersion(url)
+	if err != nil {
+		return err
+	}
+
+	err = external.CGGenEvents(os.TempDir(), url, cgeVersion, "markdown")
+	if err != nil {
+		return err
+	}
+
+	cli.Finish()
+
+	cli.Begin("Converting documentation to HTML...")
+
+	md, err := os.ReadFile(filepath.Join(os.TempDir(), "event_docs.md"))
+	if err != nil {
+		return cli.Error(err.Error())
+	}
+
+	md = markdown.NormalizeNewlines(md)
+	text := markdown.ToHTML(md, parser.NewWithExtensions(parser.CommonExtensions|parser.AutoHeadingIDs), html.NewRenderer(html.RendererOptions{
+		CSS:   filepath.Join(os.TempDir(), "event_docs.css"),
+		Flags: html.CommonFlags | html.CompletePage,
+	}))
+
+	err = os.WriteFile(filepath.Join(os.TempDir(), "event_docs.html"), text, 0644)
+	if err != nil {
+		return cli.Error(err.Error())
+	}
+
+	err = os.WriteFile(filepath.Join(os.TempDir(), "event_docs.css"), []byte(docsStyle), 0644)
+	if err != nil {
+		return cli.Error(err.Error())
+	}
+
+	cli.Finish()
+
+	cli.Begin("Opening documentation...")
+
+	err = external.OpenBrowser(filepath.Join(os.TempDir(), "event_docs.html"))
+	if err != nil {
+		cli.Error(err.Error())
+	}
+
+	cli.Finish()
+
+	return nil
+}

commands/info.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"os"
 	"strings"
 	"unicode/utf8"
 
@@ -35,23 +36,16 @@ func Info() error {
 		}
 	}
 
-	if strings.HasPrefix(url, "http://") {
-		url = strings.TrimPrefix(url, "http://")
-	} else if strings.HasPrefix(url, "https://") {
-		url = strings.TrimPrefix(url, "https://")
-	} else if strings.HasPrefix(url, "ws://") {
-		url = strings.TrimPrefix(url, "ws://")
-	} else if strings.HasPrefix(url, "wss://") {
-		url = strings.TrimPrefix(url, "wss://")
-	}
-	url = strings.TrimSuffix(url, "/")
+	url = trimURL(url)
 
 	info, err := fetchInfo(url)
 	if err != nil {
 		return err
 	}
 
 	printInfo(info)
+
+	cli.Info("\nTo view the documentation of this game run:\n%s docs %s", os.Args[0], url)
 	return nil
 }
 

commands/new.go

@@ -101,16 +101,7 @@ func newClient(projectName string) error {
 	if err != nil {
 		return err
 	}
-	if strings.HasPrefix(url, "http://") {
-		url = strings.TrimPrefix(url, "http://")
-	} else if strings.HasPrefix(url, "https://") {
-		url = strings.TrimPrefix(url, "https://")
-	} else if strings.HasPrefix(url, "ws://") {
-		url = strings.TrimPrefix(url, "ws://")
-	} else if strings.HasPrefix(url, "wss://") {
-		url = strings.TrimPrefix(url, "wss://")
-	}
-	url = strings.TrimSuffix(url, "/")
+	url = trimURL(url)
 	ssl := isSSL(url)
 	name, cgVersion, err := getCodeGameInfo(baseURL(url, ssl))
 	if err != nil {
@@ -363,6 +354,19 @@ func execTemplate(templateText, path string, data any) error {
 	return tmpl.Execute(file, data)
 }
 
+func trimURL(url string) string {
+	if strings.HasPrefix(url, "http://") {
+		url = strings.TrimPrefix(url, "http://")
+	} else if strings.HasPrefix(url, "https://") {
+		url = strings.TrimPrefix(url, "https://")
+	} else if strings.HasPrefix(url, "ws://") {
+		url = strings.TrimPrefix(url, "ws://")
+	} else if strings.HasPrefix(url, "wss://") {
+		url = strings.TrimPrefix(url, "wss://")
+	}
+	return strings.TrimSuffix(url, "/")
+}
+
 func baseURL(domain string, ssl bool) string {
 	if ssl {
 		return "https://" + domain

commands/templates/css/docs.css

@@ -12,7 +12,7 @@ import (
 	"github.com/code-game-project/codegame-cli/cli"
 )
 
-const currentVersion = "0.4.1"
+const currentVersion = "0.5.0"
 
 func CheckVersion() {
 	latest, err := getLatestVersion()

external/version.go

@@ -5,6 +5,7 @@ go 1.18
 require (
 	github.com/AlecAivazis/survey/v2 v2.3.4
 	github.com/adrg/xdg v0.4.0
+	github.com/gomarkdown/markdown v0.0.0-20220603122033-8f3b341fef32
 	github.com/mattn/go-colorable v0.1.12
 	github.com/ogier/pflag v0.0.1
 )

go.mod

@@ -9,6 +9,8 @@ github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gomarkdown/markdown v0.0.0-20220603122033-8f3b341fef32 h1:QxcGJpbMJw6tHRtrHKJiL11LdX1SXDfV1f4t4mJl3QI=
+github.com/gomarkdown/markdown v0.0.0-20220603122033-8f3b341fef32/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
 github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec h1:qv2VnGeEQHchGaZ/u7lxST/RaJw+cv273q79D81Xbog=
 github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec/go.mod h1:Q48J4R4DvxnHolD5P8pOtXigYlRuPLGl6moFx3ulM68=
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs=

go.sum

@@ -41,10 +41,7 @@ func main() {
 	case "info":
 		err = commands.Info()
 	case "docs":
-		err = external.OpenBrowser("https://docs.code-game.org")
-		if err != nil {
-			cli.Error(err.Error())
-		}
+		err = commands.Docs()
 	default:
 		cli.Error("Unknown command: %s", strings.ToLower(pflag.Arg(0)))
 		pflag.Usage()