Send config to modules as a temporary JSON file

Author: juho05

README.md

@@ -140,6 +140,93 @@ cd codegame-cli
 go build .
 ```
 
+## Modules
+
+Language specific functionality is provided by modules.
+*codegame-cli* automatically downloads the correct module version corresponding to the CodeGame version and
+executes the downloaded binary at the root of the project directory with the respective command.
+
+Additionally, the _CONFIG_FILE_ environment variable is set with the path to a temporary file containing command specific configuration in JSON format.
+
+Modules can be implemented in any language. However, it is recommended to write them in Go
+using the `github.com/code-game-project/codegame-cli/pkg/*` packages and the `github.com/Bananenpro/cli` package for CLI interaction in order to be consistent with the CLI and other modules.
+
+### new
+
+Creates a new project of the type provided by a second command line argument:
+
+#### client
+
+Creates a new game client.
+This includes integration with the client library for the language, a functioning template with a main file and language specific metadata files like `package.json` or similar
+and wrappers around the library to make its usage easier including setting the game URL with the CG_GAME_URL environment variable (required).
+
+##### config data
+
+```jsonc
+{
+	"lang": "go", // the chosen programming language (in case one module supports multiple languages)
+	"name": "my_game", // the name of the game
+	"url": "my_game.example.com", // the URL of the game server
+	"library_version": "0.9.2" // the version of the client library to use
+}
+```
+
+#### server
+
+Creates a new game server.
+This includes integration with the server library of the language and a functioning template, which implements common logic like starting the server and providing a game class.
+
+##### config data
+
+```jsonc
+{
+	"lang": "go", // the chosen programming language (in case one module supports multiple languages)
+	"library_version": "0.9.2" // the version of the server library to use
+}
+```
+
+### update
+
+Updates the library to the specified version and all other dependencies used by the project to their newest compatible version.
+Additionally all wrappers are updated.
+
+##### config data
+
+```jsonc
+{
+	"lang": "go", // the chosen programming language (in case one module supports multiple languages)
+	"library_version": "0.9.2" // the new version of the library to use
+}
+
+```
+
+### run
+
+Runs the project with the specified command line arguments.
+
+##### config data
+
+```jsonc
+{
+	"lang": "go", // the chosen programming language (in case one module supports multiple languages)
+	"args": ["-f", "my_file.txt"] // the command line arguments for the application
+}
+```
+
+### build
+
+Builds the projects and injects the URL specified in the `.codegame.json` file, which makes the *CG_GAME_URL* environment variable optional.
+
+##### config data
+
+```jsonc
+{
+	"lang": "go", // the chosen programming language (in case one module supports multiple languages)
+	"output": "bin/my-game" // The name of the output file
+}
+```
+
 ## License
 
 Copyright (c) 2022 CodeGame Contributors (https://code-game.org/contributors)

cmd/build.go

@@ -1,35 +1,42 @@
-/*
-Copyright © 2022 NAME HERE <EMAIL ADDRESS>
-
-*/
 package cmd
 
 import (
 	"fmt"
+	"os"
 
 	"github.com/code-game-project/codegame-cli/pkg/cgfile"
+	"github.com/code-game-project/codegame-cli/pkg/external"
 	"github.com/code-game-project/codegame-cli/pkg/modules"
 	"github.com/spf13/cobra"
 )
 
 // buildCmd represents the build command
 var buildCmd = &cobra.Command{
-	Use:                "build",
-	Short:              "Build the current project.",
-	DisableFlagParsing: true,
+	Use:   "build",
+	Short: "Build the current project.",
 	Run: func(cmd *cobra.Command, args []string) {
-		rootRelative, err := cgfile.FindProjectRootRelative()
+		root, err := cgfile.FindProjectRoot()
+		abort(err)
+		err = os.Chdir(root)
 		abort(err)
 
-		data, err := cgfile.LoadCodeGameFile(rootRelative)
+		data, err := cgfile.LoadCodeGameFile("")
 		abortf("failed to load .codegame.json: %w", err)
+		data.URL = external.TrimURL(data.URL)
+		abort(data.Write(""))
 
 		cmdArgs := []string{"build"}
 		cmdArgs = append(cmdArgs, args...)
 
+		output, err := cmd.Flags().GetString("output")
+		abort(err)
+		buildData := modules.BuildData{
+			Lang:   data.Lang,
+			Output: output,
+		}
 		switch data.Lang {
 		case "go":
-			err = modules.Execute("go", "latest", data.Type, cmdArgs...)
+			err = modules.ExecuteBuild(buildData, data)
 			abort(err)
 		default:
 			abort(fmt.Errorf("'build' is not supported for '%s'", data.Lang))
@@ -39,4 +46,5 @@ var buildCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(buildCmd)
+	buildCmd.Flags().StringP("output", "o", "", "The name of the output file.")
 }

cmd/changeUrl.go

@@ -1,16 +1,12 @@
-/*
-Copyright © 2022 NAME HERE <EMAIL ADDRESS>
-
-*/
 package cmd
 
 import (
 	"errors"
-	"os"
 	"strings"
 
 	"github.com/Bananenpro/cli"
 	"github.com/code-game-project/codegame-cli/pkg/cgfile"
+	"github.com/code-game-project/codegame-cli/pkg/external"
 	"github.com/code-game-project/codegame-cli/pkg/server"
 	"github.com/spf13/cobra"
 )
@@ -25,8 +21,8 @@ var changeUrlCmd = &cobra.Command{
 		abort(err)
 
 		var url string
-		if len(os.Args) >= 3 {
-			url = strings.ToLower(os.Args[2])
+		if len(args) > 0 {
+			url = strings.ToLower(args[0])
 		} else {
 			var err error
 			url, err = cli.Input("New game URL:")
@@ -50,7 +46,7 @@ var changeUrlCmd = &cobra.Command{
 
 		prevURL := config.URL
 
-		config.URL = url
+		config.URL = external.TrimURL(url)
 		err = config.Write(root)
 		abort(err)
 

cmd/info.go

@@ -1,7 +1,3 @@
-/*
-Copyright © 2022 NAME HERE <EMAIL ADDRESS>
-
-*/
 package cmd
 
 import (

cmd/new.go

@@ -1,7 +1,3 @@
-/*
-Copyright © 2022 NAME HERE <EMAIL ADDRESS>
-
-*/
 package cmd
 
 import (
@@ -22,7 +18,6 @@ import (
 	"github.com/code-game-project/codegame-cli/pkg/exec"
 	"github.com/code-game-project/codegame-cli/pkg/external"
 	"github.com/code-game-project/codegame-cli/pkg/modules"
-	"github.com/code-game-project/codegame-cli/pkg/semver"
 	"github.com/code-game-project/codegame-cli/pkg/server"
 	"github.com/spf13/cobra"
 )
@@ -89,36 +84,31 @@ func init() {
 }
 
 func newServer(projectName string) error {
-	var language string
-	if len(os.Args) >= 4 {
-		language = strings.ToLower(os.Args[3])
-	} else {
-		var err error
-		language, err = cli.SelectString("Language:", []string{"Go", "JavaScript", "TypeScript"}, []string{"go", "js", "ts"})
-		if err != nil {
-			return err
-		}
+	language, err := cli.SelectString("Language:", []string{"Go", "JavaScript", "TypeScript"}, []string{"go", "js", "ts"})
+	if err != nil {
+		return err
 	}
 
 	file := cgfile.CodeGameFileData{
 		Game: projectName,
 		Type: "server",
 		Lang: language,
 	}
-	err := file.Write("")
+	err = file.Write("")
 	if err != nil {
-		return fmt.Errorf("Failed to create .codegame.json: %s", err)
+		return fmt.Errorf("Failed to create .codegame.json: %w", err)
+	}
+
+	newData := modules.NewServerData{
+		Lang:           language,
+		LibraryVersion: "latest",
 	}
 
 	switch language {
-	case "go":
-		err = modules.Execute("go", "latest", "server", "new", "server")
-	case "js":
-		err = modules.Execute("js", "latest", "server", "new", "server")
-	case "ts":
-		err = modules.Execute("js", "latest", "server", "new", "server", "--typescript")
+	case "go", "js", "ts":
+		err = modules.ExecuteNewServer(newData)
 	default:
-		return fmt.Errorf("'new server' is not supported for '%s'", language)
+		err = fmt.Errorf("'new server' is not supported for '%s'", language)
 	}
 	if err != nil {
 		return err
@@ -156,6 +146,7 @@ func newClient() error {
 	if err != nil {
 		return err
 	}
+	url = external.TrimURL(url)
 	api, err := server.NewAPI(url)
 	if err != nil {
 		return err
@@ -173,18 +164,7 @@ func newClient() error {
 		return err
 	}
 
-	var language string
-	if len(os.Args) >= 4 {
-		language = strings.ToLower(os.Args[3])
-	} else {
-		var err error
-		language, err = cli.SelectString("Language:", []string{"Go", "JavaScript", "TypeScript"}, []string{"go", "js", "ts"})
-		if err != nil {
-			return err
-		}
-	}
-
-	cgeMajor, cgeMinor, _, err := semver.ParseVersion(cgeVersion)
+	language, err := cli.SelectString("Language:", []string{"Go", "JavaScript", "TypeScript"}, []string{"go", "js", "ts"})
 	if err != nil {
 		return err
 	}
@@ -193,25 +173,28 @@ func newClient() error {
 		Game: info.Name,
 		Type: "client",
 		Lang: language,
-		URL:  external.TrimURL(url),
+		URL:  url,
 	}
 	err = file.Write("")
 	if err != nil {
 		return fmt.Errorf("Failed to create .codegame.json: %s", err)
 	}
 
+	newData := modules.NewClientData{
+		Lang: language,
+		Name: info.Name,
+		URL:  url,
+	}
+
 	switch language {
 	case "go":
-		libraryVersion := external.LibraryVersionFromCGVersion("code-game-project", "go-client", info.CGVersion)
-		err = modules.Execute("go", libraryVersion, "client", "new", "client", "--library-version="+libraryVersion, "--game-name="+info.Name, "--url="+external.TrimURL(url), fmt.Sprintf("--generate-wrappers=%t", cgeMajor > 0 || cgeMinor >= 3))
-	case "js":
-		libraryVersion := external.LibraryVersionFromCGVersion("code-game-project", "javascript-client", info.CGVersion)
-		err = modules.Execute("js", libraryVersion, "client", "new", "client", "--library-version="+libraryVersion, "--game-name="+info.Name, "--url="+external.TrimURL(url))
-	case "ts":
-		libraryVersion := external.LibraryVersionFromCGVersion("code-game-project", "javascript-client", info.CGVersion)
-		err = modules.Execute("js", libraryVersion, "client", "new", "client", "--typescript", "--library-version="+libraryVersion, "--game-name="+info.Name, "--url="+external.TrimURL(url))
+		newData.LibraryVersion = external.LibraryVersionFromCGVersion("code-game-project", "go-client", info.CGVersion)
+		err = modules.ExecuteNewClient(newData)
+	case "js", "ts":
+		newData.LibraryVersion = external.LibraryVersionFromCGVersion("code-game-project", "javascript-client", info.CGVersion)
+		err = modules.ExecuteNewClient(newData)
 	default:
-		return fmt.Errorf("'new client' is not supported for '%s'", language)
+		err = fmt.Errorf("'new client' is not supported for '%s'", language)
 	}
 	if err != nil {
 		return err
@@ -223,7 +206,7 @@ func newClient() error {
 	}
 
 	if language == "go" || language == "ts" {
-		err = cggenevents.CGGenEvents(cgeVersion, eventsOutput, url, language)
+		err = cggenevents.CGGenEvents(cgeVersion, eventsOutput, external.BaseURL("http", external.IsTLS(url), url), language)
 		if err != nil {
 			return err
 		}

cmd/root.go

@@ -2,8 +2,8 @@ package cmd
 
 import (
 	"errors"
-	"fmt"
 	"os"
+	"os/exec"
 
 	"github.com/Bananenpro/cli"
 	"github.com/spf13/cobra"
@@ -31,15 +31,9 @@ func abort(err error) {
 		return
 	}
 
-	if errors.Is(err, cli.ErrCanceled) {
-		cli.Print(err.Error())
-	} else {
+	if _, ok := err.(*exec.ExitError); !ok && !errors.Is(err, cli.ErrCanceled) {
 		cli.Error(err.Error())
 	}
-
-	if err == cli.ErrCanceled {
-		os.Exit(0)
-	}
 	os.Exit(1)
 }
 
@@ -50,14 +44,8 @@ func abortf(format string, err error) {
 		return
 	}
 
-	if errors.Is(err, cli.ErrCanceled) {
-		cli.Print(format, err)
-	} else {
-		cli.Error(fmt.Errorf(format, err).Error())
-	}
-
-	if err == cli.ErrCanceled {
-		os.Exit(0)
+	if _, ok := err.(*exec.ExitError); !ok && !errors.Is(err, cli.ErrCanceled) {
+		cli.Error(err.Error())
 	}
 	os.Exit(1)
 }