Add warnings for windows builds

TODO: allow image override

cmd/helpers.go

@@ -18,6 +18,8 @@ import (
 	"github.com/leaanthony/spinner"
 )
 
+const xgoVersion = "1.0.1"
+
 var fs = NewFSHelper()
 
 // ValidateFrontendConfig checks if the frontend config is valid
@@ -90,16 +92,17 @@ func InitializeCrossCompilation(verbose bool) error {
 	}
 
 	var packSpinner *spinner.Spinner
+	msg := fmt.Sprintf("Pulling wailsapp/xgo:%s docker image... (may take a while)", xgoVersion)
 	if !verbose {
-		packSpinner = spinner.New("Pulling wailsapp/xgo:latest docker image... (may take a while)")
+		packSpinner = spinner.New(msg)
 		packSpinner.SetSpinSpeed(50)
 		packSpinner.Start()
 	} else {
-		println("Pulling wailsapp/xgo:latest docker image... (may take a while)")
+		println(msg)
 	}
 
 	err := NewProgramHelper(verbose).RunCommandArray([]string{"docker",
-		"pull", "wailsapp/xgo:latest"})
+		"pull", fmt.Sprintf("wailsapp/xgo:%s", xgoVersion)})
 
 	if err != nil {
 		if packSpinner != nil {
@@ -114,7 +117,7 @@ func InitializeCrossCompilation(verbose bool) error {
 	return nil
 }
 
-// BuildDocker builds the project using the cross compiling wailsapp/xgo:latest container
+// BuildDocker builds the project using the cross compiling wailsapp/xgo:<xgoVersion> container
 func BuildDocker(binaryName string, buildMode string, projectOptions *ProjectOptions) error {
 	var packSpinner *spinner.Spinner
 	if buildMode == BuildModeBridge {
@@ -146,18 +149,24 @@ func BuildDocker(binaryName string, buildMode string, projectOptions *ProjectOpt
 		"-e", "FLAG_RACE=false",
 		"-e", "FLAG_BUILDMODE=default",
 		"-e", "FLAG_TRIMPATH=false",
-		"-e", fmt.Sprintf("TARGETS=%s", projectOptions.Platform+"/"+projectOptions.Architecture),
+		"-e", fmt.Sprintf("TARGETS=%s/%s", projectOptions.Platform, projectOptions.Architecture),
 		"-e", "GOPROXY=",
 		"-e", "GO111MODULE=on",
-		"wailsapp/xgo:latest",
-		".",
 	} {
 		buildCommand.Add(arg)
 	}
 
+	if projectOptions.GoPath != "" {
+		buildCommand.Add("-v")
+		buildCommand.Add(fmt.Sprintf("%s:/go", projectOptions.GoPath))
+	}
+
+	buildCommand.Add(fmt.Sprintf("wailsapp/xgo:%s", xgoVersion))
+	buildCommand.Add(".")
+
 	compileMessage := fmt.Sprintf(
-		"Packing + Compiling project for %s/%s using docker image wailsapp/xgo:latest",
+		"Packing + Compiling project for %s/%s using docker image wailsapp/xgo:%s",
-		projectOptions.Platform, projectOptions.Architecture)
+		projectOptions.Platform, projectOptions.Architecture, xgoVersion)
 
 	if buildMode == BuildModeDebug {
 		compileMessage += " (Debug Mode)"
@@ -216,10 +225,6 @@ func BuildNative(binaryName string, forceRebuild bool, buildMode string, project
 	buildCommand.Add("go")
 
 	buildCommand.Add("build")
-	if buildMode == BuildModeBridge {
-		// Ignore errors
-		buildCommand.Add("-i")
-	}
 
 	if binaryName != "" {
 		// Alter binary name based on OS
@@ -530,6 +535,9 @@ func InstallProdRuntime(projectDir string, projectOptions *ProjectOptions) error
 func ServeProject(projectOptions *ProjectOptions, logger *Logger) error {
 	go func() {
 		time.Sleep(2 * time.Second)
+		if projectOptions.Platform == "windows" {
+			logger.Yellow("*** Please note: Windows builds use mshtml which is only compatible with IE11. We strongly recommend only using IE11 when running 'wails serve'! For more information, please read https://wails.app/guides/windows/ ***")
+		}
 		logger.Green(">>>>> To connect, you will need to run '" + projectOptions.FrontEnd.Serve + "' in the '" + projectOptions.FrontEnd.Dir + "' directory <<<<<")
 	}()
 	location, err := filepath.Abs(filepath.Join("build", projectOptions.BinaryName))

cmd/project.go

@@ -6,6 +6,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"runtime"
 	"sort"
 	"strings"
 
@@ -162,6 +163,24 @@ type ProjectOptions struct {
 	Platform               string
 	Architecture           string
 	LdFlags                string
+	GoPath                 string
+
+	// Supported platforms
+	Platforms []string `json:"platforms,omitempty"`
+}
+
+// PlatformSupported returns true if the template is supported
+// on the current platform
+func (po *ProjectOptions) PlatformSupported() bool {
+
+	// Default is all platforms supported
+	if len(po.Platforms) == 0 {
+		return true
+	}
+
+	// Check that the platform is in the list
+	platformsSupported := slicer.String(po.Platforms)
+	return platformsSupported.Contains(runtime.GOOS)
 }
 
 // Defaults sets the default project template
@@ -232,13 +251,16 @@ func (po *ProjectOptions) PromptForInputs() error {
 		for _, k := range keys {
 			templateDetail := templateDetails[k]
 			templateList.Add(templateDetail)
+			if !templateDetail.Metadata.PlatformSupported() {
+				templateDetail.Metadata.Name = "* " + templateDetail.Metadata.Name
+			}
 			options.Add(fmt.Sprintf("%s - %s", templateDetail.Metadata.Name, templateDetail.Metadata.ShortDescription))
 		}
 
 		templateIndex := 0
 
 		if len(options.AsSlice()) > 1 {
-			templateIndex = PromptSelection("Please select a template", options.AsSlice(), 0)
+			templateIndex = PromptSelection("Please select a template (* means unsupported on current platform)", options.AsSlice(), 0)
 		}
 
 		if len(templateList.AsSlice()) == 0 {
@@ -249,6 +271,10 @@ func (po *ProjectOptions) PromptForInputs() error {
 		po.selectedTemplate = templateList.AsSlice()[templateIndex].(*TemplateDetails)
 	}
 
+	po.selectedTemplate.Metadata.Name = strings.TrimPrefix(po.selectedTemplate.Metadata.Name, "* ")
+	if !po.selectedTemplate.Metadata.PlatformSupported() {
+		println("WARNING: This template is unsupported on this platform!")
+	}
 	fmt.Println("Template: " + po.selectedTemplate.Metadata.Name)
 
 	// Setup NPM Project name
@@ -371,5 +397,9 @@ func processTemplateMetadata(templateMetadata *TemplateMetadata, po *ProjectOpti
 		}
 		po.FrontEnd.Serve = templateMetadata.Serve
 	}
+
+	// Save platforms
+	po.Platforms = templateMetadata.Platforms
+
 	return nil
 }

cmd/templates.go

@@ -7,6 +7,7 @@ import (
 	"io/ioutil"
 	"log"
 	"path/filepath"
+	"runtime"
 	"strings"
 	"text/template"
 
@@ -29,6 +30,26 @@ type TemplateMetadata struct {
 	Bridge               string                `json:"bridge"`
 	WailsDir             string                `json:"wailsdir"`
 	TemplateDependencies []*TemplateDependency `json:"dependencies,omitempty"`
+
+	// List of platforms that this template is supported on.
+	// No value means all platforms. A platform name is the same string
+	// as `runtime.GOOS` will return, eg: "darwin". NOTE: This is
+	// case sensitive.
+	Platforms []string `json:"platforms,omitempty"`
+}
+
+// PlatformSupported returns true if this template supports the
+// currently running platform
+func (m *TemplateMetadata) PlatformSupported() bool {
+
+	// Default is all platforms supported
+	if len(m.Platforms) == 0 {
+		return true
+	}
+
+	// Check that the platform is in the list
+	platformsSupported := slicer.String(m.Platforms)
+	return platformsSupported.Contains(runtime.GOOS)
 }
 
 // TemplateDependency defines a binary dependency for the template
@@ -128,11 +149,11 @@ func (t *TemplateHelper) GetTemplateDetails() (map[string]*TemplateDetails, erro
 		result[name] = &TemplateDetails{
 			Path: dir,
 		}
-		_ = &TemplateMetadata{}
 		metadata, err := t.LoadMetadata(dir)
 		if err != nil {
 			return nil, err
 		}
+
 		result[name].Metadata = metadata
 		if metadata.Name != "" {
 			result[name].Name = metadata.Name

cmd/version.go

@@ -1,4 +1,4 @@
 package cmd
 
 // Version - Wails version
-const Version = "v1.8.0"
+const Version = "v1.8.1-pre1"

cmd/wails/4_build.go

@@ -26,6 +26,7 @@ func init() {
 	var packageApp = false
 	var forceRebuild = false
 	var debugMode = false
+	var gopath = ""
 	var typescriptFilename = ""
 	var verbose = false
 	var platform = ""
@@ -42,7 +43,8 @@ func init() {
 		BoolFlag("d", "Build in Debug mode", &debugMode).
 		BoolFlag("verbose", "Verbose output", &verbose).
 		StringFlag("t", "Generate Typescript definitions to given file (at runtime)", &typescriptFilename).
-		StringFlag("ldflags", "Extra options for -ldflags", &ldflags)
+		StringFlag("ldflags", "Extra options for -ldflags", &ldflags).
+		StringFlag("gopath", "Specify your GOPATH location. Mounted to /go during cross-compilation.", &gopath)
 
 	var b strings.Builder
 	for _, plat := range getSupportedPlatforms() {
@@ -76,6 +78,11 @@ func init() {
 			return fmt.Errorf("Unable to find 'project.json'. Please check you are in a Wails project directory")
 		}
 
+		// Check that this platform is supported
+		if !projectOptions.PlatformSupported() {
+			logger.Yellow("WARNING: This project is unsupported on %s - it probably won't work!\n         Valid platforms: %s\n", runtime.GOOS, strings.Join(projectOptions.Platforms, ", "))
+		}
+
 		// Set cross-compile
 		projectOptions.Platform = runtime.GOOS
 		if len(platform) > 0 {
@@ -97,6 +104,7 @@ func init() {
 
 		// Add ldflags
 		projectOptions.LdFlags = ldflags
+		projectOptions.GoPath = gopath
 
 		// Validate config
 		// Check if we have a frontend
@@ -181,6 +189,10 @@ func init() {
 			return err
 		}
 
+		if projectOptions.Platform == "windows" {
+			logger.Yellow("*** Please note: Windows builds use mshtml which is only compatible with IE11. For more information, please read https://wails.app/guides/windows/ ***")
+		}
+
 		logger.Yellow("Awesome! Project '%s' built!", projectOptions.Name)
 
 		return nil

cmd/wails/6_serve.go

@@ -70,6 +70,7 @@ func init() {
 		}
 
 		logger.Yellow("Awesome! Project '%s' built!", projectOptions.Name)
+
 		return cmd.ServeProject(projectOptions, logger)
 	})
 }

runtime/store.go

@@ -291,3 +291,8 @@ func (s *Store) Update(updater interface{}) {
 		s.errorHandler(err)
 	}
 }
+
+// Get returns the value of the data that's kept in the current state / Store
+func (s *Store) Get() interface{} {
+	return s.data.Interface()
+}