chore: docs + colors + --opengl flag on run

Minor style changes there and there.

Author: pchampio

cmd/build.go

@@ -285,7 +285,7 @@ func buildNormal(targetOS string, vmArguments []string) {
 			ignoreWarning := os.Getenv("HOVER_IGNORE_CHANNEL_WARNING")
 			if match[1] != "beta" && ignoreWarning != "true" {
 				log.Warnf("⚠ The go-flutter project tries to stay compatible with the beta channel of Flutter.")
-				log.Warnf("⚠     It's advised to use the beta channel: %s", log.Au().Magenta("flutter channel beta"))
+				log.Warnf("⚠     It's advised to use the beta channel: `%s`", log.Au().Magenta("flutter channel beta"))
 			}
 		} else {
 			log.Warnf("Failed to check your flutter channel: Unrecognized output format")

cmd/packaging/linux-deb.go

@@ -9,10 +9,11 @@ import (
 	"github.com/otiai10/copy"
 
 	"github.com/go-flutter-desktop/hover/internal/build"
-	"github.com/go-flutter-desktop/hover/internal/pubspec"
 	"github.com/go-flutter-desktop/hover/internal/log"
+	"github.com/go-flutter-desktop/hover/internal/pubspec"
 )
 
+// InitLinuxDeb initialize the a linux deb packagingFormat.
 func InitLinuxDeb() {
 	projectName := pubspec.GetPubSpec().Name
 	packagingFormat := "linux-deb"
@@ -126,6 +127,7 @@ func InitLinuxDeb() {
 	printInitFinished(packagingFormat)
 }
 
+// BuildLinuxDeb uses the InitLinuxDeb template to create a deb package.
 func BuildLinuxDeb() {
 	projectName := pubspec.GetPubSpec().Name
 	packagingFormat := "linux-deb"

cmd/packaging/linux-snap.go

@@ -8,10 +8,11 @@ import (
 	"github.com/otiai10/copy"
 
 	"github.com/go-flutter-desktop/hover/internal/build"
-	"github.com/go-flutter-desktop/hover/internal/pubspec"
 	"github.com/go-flutter-desktop/hover/internal/log"
+	"github.com/go-flutter-desktop/hover/internal/pubspec"
 )
 
+// InitLinuxSnap initialize the a linux snap packagingFormat
 func InitLinuxSnap() {
 	projectName := pubspec.GetPubSpec().Name
 	packagingFormat := "linux-snap"
@@ -92,6 +93,7 @@ func InitLinuxSnap() {
 	printInitFinished(packagingFormat)
 }
 
+// BuildLinuxSnap uses the InitLinuxSnap template to create a snap package.
 func BuildLinuxSnap() {
 	projectName := pubspec.GetPubSpec().Name
 	packagingFormat := "linux-snap"

cmd/packaging/packaging.go

@@ -38,6 +38,8 @@ func createPackagingFormatDirectory(packagingFormat string) {
 	}
 }
 
+// AssertPackagingFormatInitialized exits hover if the requested
+// packagingFormat isn't initialized.
 func AssertPackagingFormatInitialized(packagingFormat string) {
 	if _, err := os.Stat(packagingFormatPath(packagingFormat)); os.IsNotExist(err) {
 		log.Errorf("%s is not initialized for packaging. Please run `hover init-packaging %s` first.", packagingFormat, packagingFormat)
@@ -51,7 +53,7 @@ func removeDashesAndUnderscores(projectName string) string {
 
 func printInitFinished(packagingFormat string) {
 	log.Infof("go/packaging/%s has been created. You can modify the configuration files and add it to git.", packagingFormat)
-	log.Infof("You now can package the %s using `hover build %s`", strings.Split(packagingFormat, "-")[0], packagingFormat)
+	log.Infof(fmt.Sprintf("You now can package the %s using `%s`", strings.Split(packagingFormat, "-")[0], log.Au().Magenta("hover build "+packagingFormat)))
 }
 
 func printPackagingFinished(packagingFormat string) {
@@ -67,6 +69,7 @@ func getTemporaryBuildDirectory(projectName string, packagingFormat string) stri
 	return tmpPath
 }
 
+// DockerInstalled check if docker is installed on the host os.
 func DockerInstalled() bool {
 	if build.DockerBin == "" {
 		log.Warnf("To use packaging, Docker needs to be installed.\nhttps://docs.docker.com/install")

cmd/plugins.go

@@ -318,7 +318,7 @@ func hoverPluginGet(dryRun bool) bool {
 
 			// if local plugin
 			if dep.path != "" {
-				path, err := filepath.Abs(filepath.Join(dep.path, "go"))
+				path, err := filepath.Abs(filepath.Join(dep.path, build.BuildPath))
 				if err != nil {
 					log.Errorf("Failed to resolve absolute path for plugin '%s': %v", dep.name, err)
 					os.Exit(1)

cmd/publish-plugin.go

@@ -60,7 +60,7 @@ var publishPluginCmd = &cobra.Command{
 		}
 
 		// check if one of the git remote urls equals the package import 'url'
-		pluginImportStr, err := readPluginGoImport(filepath.Join("go", "import.go.tmpl"), pubspec.GetPubSpec().Name)
+		pluginImportStr, err := readPluginGoImport(filepath.Join(build.BuildPath, "import.go.tmpl"), pubspec.GetPubSpec().Name)
 		if err != nil {
 			log.Errorf("Failed to read the plugin import url: %v", err)
 			log.Infof("The file go/import.go.tmpl should look something like this:")

cmd/run.go

@@ -12,9 +12,9 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/go-flutter-desktop/hover/internal/build"
 	"github.com/go-flutter-desktop/hover/internal/log"
 	"github.com/go-flutter-desktop/hover/internal/pubspec"
-	"github.com/go-flutter-desktop/hover/internal/build"
 )
 
 var runObservatoryPort string
@@ -23,6 +23,7 @@ func init() {
 	runCmd.Flags().StringVarP(&buildTarget, "target", "t", "lib/main_desktop.dart", "The main entry-point file of the application.")
 	runCmd.Flags().StringVarP(&buildBranch, "branch", "b", "", "The 'go-flutter' version to use. (@master or @v0.20.0 for example)")
 	runCmd.Flags().StringVarP(&buildCachePath, "cache-path", "", "", "The path that hover uses to cache dependencies such as the Flutter engine .so/.dll (defaults to the standard user cache directory)")
+	runCmd.Flags().StringVar(&buildOpenGlVersion, "opengl", "3.3", "The OpenGL version specified here is only relevant for external texture plugin (i.e. video_plugin).\nIf 'none' is provided, texture won't be supported. Note: the Flutter Engine still needs a OpenGL compatible context.")
 	runCmd.Flags().StringVarP(&runObservatoryPort, "observatory-port", "", "50300", "The observatory port used to connect hover to VM services (hot-reload/debug/..)")
 	runCmd.Flags().BoolVar(&buildOmitEmbedder, "omit-embedder", false, "Don't (re)compile 'go-flutter' source code, useful when only working with Dart code")
 	runCmd.Flags().BoolVar(&buildOmitFlutterBundle, "omit-flutter", false, "Don't (re)compile the current Flutter project, useful when only working with Golang code (plugin)")

internal/build/binaries.go

@@ -1,5 +1,6 @@
 package build
 
+// Path to external tools used by hover
 var (
 	GoBin      string
 	FlutterBin string

internal/build/build.go

@@ -7,8 +7,13 @@ import (
 	"github.com/go-flutter-desktop/hover/internal/log"
 )
 
+// BuildPath sets the name of the directory used to store the go-flutter project.
+// Much like android and ios are already used.
 const BuildPath = "go"
 
+// OutputDirectoryPath returns the path where the go-flutter binary and flutter
+// binaries blobs will be stored for a particular platform.
+// If needed, the directory is create at the returned path.
 func OutputDirectoryPath(targetOS string) string {
 	outputDirectoryPath, err := filepath.Abs(filepath.Join(BuildPath, "build", "outputs", targetOS))
 	if err != nil {
@@ -25,6 +30,8 @@ func OutputDirectoryPath(targetOS string) string {
 	return outputDirectoryPath
 }
 
+// OutputBinaryName returns the string of the executable used to launch the
+// main desktop app. (appends .exe for windows)
 func OutputBinaryName(projectName string, targetOS string) string {
 	var outputBinaryName = projectName
 	switch targetOS {
@@ -41,6 +48,8 @@ func OutputBinaryName(projectName string, targetOS string) string {
 	return outputBinaryName
 }
 
+// OutputBinaryPath returns the path to the go-flutter Application for a
+// specified platform.
 func OutputBinaryPath(projectName string, targetOS string) string {
 	outputBinaryPath := filepath.Join(OutputDirectoryPath(targetOS), OutputBinaryName(projectName, targetOS))
 	return outputBinaryPath

internal/pubspec/pubspec.go

@@ -10,6 +10,7 @@ import (
 	"github.com/pkg/errors"
 )
 
+// PubSpec contains the parsed contents of pubspec.yaml
 type PubSpec struct {
 	Name         string
 	Description  string

internal/versioncheck/version.go

@@ -88,7 +88,7 @@ func CheckForGoFlutterUpdate(goDirectoryPath string, currentTag string) {
 		}
 		if res.Outdated {
 			log.Infof("The core library 'go-flutter' has an update available. (%s -> %s)", currentTag, res.Current)
-			log.Infof("              To update 'go-flutter' in this project run: $ hover upgrade")
+			log.Infof("              To update 'go-flutter' in this project run: `%s`", log.Au().Magenta("hover upgrade"))
 		}
 
 		if now.Sub(lastUpdateTimeStamp).Hours() > checkRate {