Merge branch 'master' into feature/packaging/darwin-pkg

Author: jld3103

assets/app/main_desktop.dart

@@ -0,0 +1,10 @@
+import 'package:flutter/foundation.dart'
+    show debugDefaultTargetPlatformOverride;
+import 'package:flutter/material.dart';
+
+import './main.dart';
+
+void main() {
+  debugDefaultTargetPlatformOverride = TargetPlatform.fuchsia;
+  runApp(MyApp());
+}

assets/plugin/README.md.tmpl

@@ -0,0 +1,17 @@
+# {{.pluginName}}
+
+This Go package implements the host-side of the Flutter [{{.pluginName}}](https://{{.urlVSCRepo}}) plugin.
+
+## Usage
+
+Import as:
+
+```go
+import {{.pluginName}} "{{.urlVSCRepo}}/go"
+```
+
+Then add the following option to your go-flutter [application options](https://github.com/go-flutter-desktop/go-flutter/wiki/Plugin-info):
+
+```go
+flutter.AddPlugin(&{{.pluginName}}.{{.structName}}{}),
+```

assets/plugin/import.go.tmpl.tmpl

@@ -0,0 +1,13 @@
+package main
+
+// DO NOT EDIT, this file is generated by hover at compile-time for the {{.pluginName}} plugin.
+
+import (
+	flutter "github.com/go-flutter-desktop/go-flutter"
+	{{.pluginName}} "{{.urlVSCRepo}}/go"
+)
+
+func init() {
+	// Only the init function can be tweaked by plugin maker.
+	options = append(options, flutter.AddPlugin(&{{.pluginName}}.{{.structName}}{}))
+}

assets/plugin/plugin.go.tmpl

@@ -0,0 +1,24 @@
+package {{.pluginName}}
+
+import (
+	flutter "github.com/go-flutter-desktop/go-flutter"
+	"github.com/go-flutter-desktop/go-flutter/plugin"
+)
+
+const channelName = "{{.pluginName}}"
+
+// {{.structName}} implements flutter.Plugin and handles method.
+type {{.structName}} struct{}
+
+var _ flutter.Plugin = &{{.structName}}{} // compile-time type check
+
+// InitPlugin initializes the plugin.
+func (p *{{.structName}}) InitPlugin(messenger plugin.BinaryMessenger) error {
+	channel := plugin.NewMethodChannel(messenger, channelName, plugin.StandardMethodCodec{})
+	channel.HandleFunc("getPlatformVersion", p.handlePlatformVersion)
+	return nil
+}
+
+func (p *{{.structName}}) handlePlatformVersion(arguments interface{}) (reply interface{}, err error) {
+	return "go-flutter " + flutter.PlatformVersion, nil
+}

cmd/build.go

@@ -14,12 +14,13 @@ import (
 	"github.com/otiai10/copy"
 	"github.com/spf13/cobra"
 
+	"github.com/go-flutter-desktop/hover/internal/build"
 	"github.com/go-flutter-desktop/hover/internal/enginecache"
+	"github.com/go-flutter-desktop/hover/internal/fileutils"
 	"github.com/go-flutter-desktop/hover/internal/log"
-	"github.com/go-flutter-desktop/hover/internal/versioncheck"
-	"github.com/go-flutter-desktop/hover/internal/build"
 	"github.com/go-flutter-desktop/hover/internal/pubspec"
 	"github.com/go-flutter-desktop/hover/internal/androidmanifest"
+  "github.com/go-flutter-desktop/hover/internal/versioncheck"
 	"github.com/go-flutter-desktop/hover/cmd/packaging"
 )
 
@@ -158,6 +159,31 @@ var buildWindowsCmd = &cobra.Command{
 	},
 }
 
+// checkForMainDesktop checks and adds the lib/main_desktop.dart dart entry
+// point if needed
+func checkForMainDesktop() {
+	if buildTarget != "lib/main_desktop.dart" {
+		return
+	}
+	_, err := os.Stat("lib/main_desktop.dart")
+	if os.IsNotExist(err) {
+		log.Warnf("Target file \"lib/main_desktop.dart\" not found.")
+		log.Warnf("Let hover add the \"lib/main_desktop.dart\" file? ")
+		if askForConfirmation() {
+			fileutils.CopyAsset("app/main_desktop.dart", filepath.Join("lib", "main_desktop.dart"), assetsBox)
+			log.Infof("Target file \"lib/main_desktop.dart\" has been created.")
+			log.Infof("       Depending on your project, you might want to tweak it.")
+			return
+		}
+		log.Printf("You can define a custom traget by using the %s flag.", log.Au().Magenta("--target"))
+		os.Exit(1)
+	}
+	if err != nil {
+		log.Errorf("Failed to stat lib/main_desktop.dart: %v\n", err)
+		os.Exit(1)
+	}
+}
+
 func buildInDocker(targetOS string, vmArguments []string) {
 	crossCompilingDir, err := filepath.Abs(filepath.Join(build.BuildPath, "cross-compiling"))
 	err = os.MkdirAll(crossCompilingDir, 0755)
@@ -257,6 +283,7 @@ func buildInDocker(targetOS string, vmArguments []string) {
 }
 
 func buildNormal(targetOS string, vmArguments []string) {
+	checkForMainDesktop()
 	crossCompile = targetOS != runtime.GOOS
 	buildDocker = crossCompile || buildDocker
 
@@ -305,6 +332,14 @@ func buildNormal(targetOS string, vmArguments []string) {
 		trackWidgetCreation = "--track-widget-creation"
 	}
 
+	// must be run before `flutter build bundle`
+	// because `build bundle` will update the file timestamp
+	runPluginGet, err := shouldRunPluginGet()
+	if err != nil {
+		log.Errorf("Failed to check if plugin get should be run: %v.\n", err)
+		os.Exit(1)
+	}
+
 	cmdFlutterBuild := exec.Command(build.FlutterBin, "build", "bundle",
 		"--asset-dir", filepath.Join(build.OutputDirectoryPath(targetOS), "flutter_assets"),
 		"--target", buildTarget,
@@ -322,6 +357,16 @@ func buildNormal(targetOS string, vmArguments []string) {
 		}
 	}
 
+	if runPluginGet {
+		log.Printf("listing available plugins:")
+		if hoverPluginGet(true) {
+			log.Infof(fmt.Sprintf("run `%s`? ", log.Au().Magenta("hover plugins get")))
+			if askForConfirmation() {
+				hoverPluginGet(false)
+			}
+		}
+	}
+
 	var engineFile string
 	switch targetOS {
 	case "darwin":

cmd/common.go

@@ -5,13 +5,18 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
+	"runtime"
 	"strings"
+	"time"
 
 	"github.com/go-flutter-desktop/hover/internal/build"
 	"github.com/go-flutter-desktop/hover/internal/log"
 	"github.com/go-flutter-desktop/hover/internal/pubspec"
 )
 
+// initBinaries is used to ensure go and flutter exec are found in the
+// user's path
 func initBinaries() {
 	var err error
 	goAvailable := false
@@ -37,13 +42,25 @@ func initBinaries() {
 		log.Errorf("Failed to lookup 'flutter' executable. Please install flutter.\nhttps://flutter.dev/docs/get-started/install")
 		os.Exit(1)
 	}
+	gitBin, err = exec.LookPath("git")
+	if err != nil {
+		log.Warnf("Failed to lookup 'git' executable.")
+	}
 }
 
 // assertInFlutterProject asserts this command is executed in a flutter project
 func assertInFlutterProject() {
 	pubspec.GetPubSpec()
 }
 
+// assertInFlutterPluginProject asserts this command is executed in a flutter plugin project
+func assertInFlutterPluginProject() {
+	if _, ok := pubspec.GetPubSpec().Flutter["plugin"]; !ok {
+		log.Errorf("The directory doesn't appear to contain a plugin package.\nTo create a new plugin, first run `%s`, then run `%s`.", log.Au().Magenta("flutter create --template=plugin"), log.Au().Magenta("hover init-plugin"))
+		os.Exit(1)
+	}
+}
+
 func assertHoverInitialized() {
 	_, err := os.Stat(build.BuildPath)
 	if os.IsNotExist(err) {
@@ -59,6 +76,7 @@ func assertHoverInitialized() {
 	}
 }
 
+// hoverMigration migrates from old hover buildPath directory to the new one ("desktop" -> "go")
 func hoverMigration() bool {
 	oldBuildPath := "desktop"
 	file, err := os.Open(filepath.Join(oldBuildPath, "go.mod"))
@@ -86,7 +104,7 @@ func hoverMigration() bool {
 
 // askForConfirmation asks the user for confirmation.
 func askForConfirmation() bool {
-	log.Printf("[y/N]: ")
+	fmt.Print(log.Au().Bold(log.Au().Cyan("hover: ")).String() + "[y/N]? ")
 	in := bufio.NewReader(os.Stdin)
 	s, err := in.ReadString('\n')
 	if err != nil {

cmd/create-plugin.go

@@ -0,0 +1,56 @@
+package cmd
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+
+	"github.com/go-flutter-desktop/hover/internal/build"
+	"github.com/go-flutter-desktop/hover/internal/fileutils"
+	"github.com/go-flutter-desktop/hover/internal/log"
+	"github.com/go-flutter-desktop/hover/internal/pubspec"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(createPluginCmd)
+}
+
+var createPluginCmd = &cobra.Command{
+	Use:   "init-plugin",
+	Short: "Initialize a go-flutter plugin in a existing flutter platform plugin",
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return errors.New("requires one argument, the VCS repository path. e.g.: github.com/my-organization/" + pubspec.GetPubSpec().Name + "\n" +
+				"This path will be used by Golang to fetch the plugin, make sure it correspond to the code repository of the plugin!")
+		}
+		return nil
+	},
+	Run: func(cmd *cobra.Command, args []string) {
+		assertInFlutterPluginProject()
+
+		vcsPath := args[0]
+
+		err := os.Mkdir(build.BuildPath, 0775)
+		if err != nil {
+			if os.IsExist(err) {
+				log.Errorf("A file or directory named `" + build.BuildPath + "` already exists. Cannot continue init-plugin.")
+				os.Exit(1)
+			}
+			log.Errorf("Failed to create '%s' directory: %v", build.BuildPath, err)
+			os.Exit(1)
+		}
+
+		templateData := map[string]string{
+			"pluginName": pubspec.GetPubSpec().Name,
+			"structName": toCamelCase(pubspec.GetPubSpec().Name + "Plugin"),
+			"urlVSCRepo": vcsPath,
+		}
+
+		fileutils.CopyTemplate("plugin/plugin.go.tmpl", filepath.Join(build.BuildPath, "plugin.go"), assetsBox, templateData)
+		fileutils.CopyTemplate("plugin/README.md.tmpl", filepath.Join(build.BuildPath, "README.md"), assetsBox, templateData)
+		fileutils.CopyTemplate("plugin/import.go.tmpl.tmpl", filepath.Join(build.BuildPath, "import.go.tmpl"), assetsBox, templateData)
+
+		initializeGoModule(vcsPath)
+	},
+}

cmd/init-plugin.go

@@ -2,14 +2,13 @@ package cmd
 
 import (
 	"errors"
-	"io"
 	"os"
-	"os/exec"
 	"path/filepath"
 
 	"github.com/spf13/cobra"
 
 	"github.com/go-flutter-desktop/hover/internal/build"
+	"github.com/go-flutter-desktop/hover/internal/fileutils"
 	"github.com/go-flutter-desktop/hover/internal/log"
 	"github.com/go-flutter-desktop/hover/internal/pubspec"
 )
@@ -43,6 +42,8 @@ var initCmd = &cobra.Command{
 				log.Errorf("A file or directory named '%s' already exists. Cannot continue init.", build.BuildPath)
 				os.Exit(1)
 			}
+			log.Errorf("Failed to create '%s' directory: %v", build.BuildPath, err)
+			os.Exit(1)
 		}
 
 		desktopCmdPath := filepath.Join(build.BuildPath, "cmd")
@@ -59,62 +60,13 @@ var initCmd = &cobra.Command{
 			os.Exit(1)
 		}
 
-		copyAsset("app/main.go", filepath.Join(desktopCmdPath, "main.go"))
-		copyAsset("app/options.go", filepath.Join(desktopCmdPath, "options.go"))
-		copyAsset("app/icon.png", filepath.Join(desktopAssetsPath, "icon.png"))
-		copyAsset("app/gitignore", filepath.Join(build.BuildPath, ".gitignore"))
-
-		wd, err := os.Getwd()
-		if err != nil {
-			log.Errorf("Failed to get working dir: %v", err)
-			os.Exit(1)
-		}
-
-		cmdGoModInit := exec.Command(build.GoBin, "mod", "init", projectPath+"/"+build.BuildPath)
-		cmdGoModInit.Dir = filepath.Join(wd, build.BuildPath)
-		cmdGoModInit.Env = append(os.Environ(),
-			"GO111MODULE=on",
-		)
-		cmdGoModInit.Stderr = os.Stderr
-		cmdGoModInit.Stdout = os.Stdout
-		err = cmdGoModInit.Run()
-		if err != nil {
-			log.Errorf("Go mod init failed: %v", err)
-			os.Exit(1)
-		}
+		fileutils.CopyAsset("app/main.go", filepath.Join(desktopCmdPath, "main.go"), assetsBox)
+		fileutils.CopyAsset("app/options.go", filepath.Join(desktopCmdPath, "options.go"), assetsBox)
+		fileutils.CopyAsset("app/icon.png", filepath.Join(desktopAssetsPath, "icon.png"), assetsBox)
+		fileutils.CopyAsset("app/gitignore", filepath.Join(build.BuildPath, ".gitignore"), assetsBox)
 
-		cmdGoModTidy := exec.Command(build.GoBin, "mod", "tidy")
-		cmdGoModTidy.Dir = filepath.Join(wd, build.BuildPath)
-		log.Printf(cmdGoModTidy.Dir)
-		cmdGoModTidy.Env = append(os.Environ(),
-			"GO111MODULE=on",
-		)
-		cmdGoModTidy.Stderr = os.Stderr
-		cmdGoModTidy.Stdout = os.Stdout
-		err = cmdGoModTidy.Run()
-		if err != nil {
-			log.Errorf("Go mod tidy failed: %v", err)
-			os.Exit(1)
-		}
+		initializeGoModule(projectPath)
+		log.Printf("Available plugin for this project:")
+		pluginListCmd.Run(cmd, []string{})
 	},
 }
-
-func copyAsset(boxed, to string) {
-	file, err := os.Create(to)
-	if err != nil {
-		log.Errorf("Failed to create %s: %v", to, err)
-		os.Exit(1)
-	}
-	defer file.Close()
-	boxedFile, err := assetsBox.Open(boxed)
-	if err != nil {
-		log.Errorf("Failed to find boxed file %s: %v", boxed, err)
-		os.Exit(1)
-	}
-	defer boxedFile.Close()
-	_, err = io.Copy(file, boxedFile)
-	if err != nil {
-		log.Errorf("Failed to write file %s: %v", to, err)
-		os.Exit(1)
-	}
-}