v1.10.1 (#572)

* Fix custom HTML

* Update HTML escaping

* Added more docs around config

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,8 +8,12 @@ assignees: ''
 ---
 
 #####################################################
-     If you have a technical issue, please do not open a bug this way! 
-                      Please use the `wails issue` command!                          
+     **If you have a technical issue, please do not open a bug this way!** 
+                      Please use the `wails issue` command!
+          If you do not do this then the issue may be closed automatically.                      
+
+ NOTE: If your bug is related to Windows, make sure you read 
+ the [Windows Developer Guide](https://wails.app/guides/windows/)
 #####################################################
 
 **Description**
@@ -33,3 +37,5 @@ Please provide your platform, GO version and variables, etc
 
 **Additional context**
 Add any other context about the problem here.
+
+- [ ] This issue is for Windows and I have read the [Windows Developer Guide](https://wails.app/guides/windows/)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -16,4 +16,9 @@ examples/**/example*
 cmd/wails/wails
 .DS_Store
 tmp
-node_modules/
+node_modules/
+v2/test/kitchensink/frontend/public
+v2/internal/ffenestri/runtime.c
+v2/internal/runtime/assets/desktop.js
+v2/test/kitchensink/build/darwin/desktop/kitchensink
+v2/test/kitchensink/frontend/package.json.md5

CONTRIBUTORS.md

@@ -33,3 +33,10 @@ Wails is what it is because of the time and effort given by these great people.
   * [artem](https://github.com/Unix4ever)
   * [Tim Kipp](https://github.com/timkippdev)
   * [Dmitry Gomzyakov](https://github.com/kyoto44)
+  * [Arthur Wiebe](https://github.com/artooro)
+  * [Ilgıt Yıldırım](https://github.com/ilgityildirim)
+  * [Altynbek](https://github.com/gelleson)
+  * [Kyle](https://github.com/kmuchmore)
+  * [Balakrishna Prasad Ganne](https://github.com/aayush420)
+  * [Charaf Rezrazi](https://github.com/Rezrazi)
+  * [misitebao](https://github.com/misitebao)

README.md

@@ -12,7 +12,6 @@
    <a href="https://houndci.com"><img src="https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg"/></a>
    <a href="https://github.com/avelino/awesome-go" rel="nofollow"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome"></a>
    <a href="https://github.com/wailsapp/wails/workflows/release/badge.svg?branch=master" rel="nofollow"><img src="https://github.com/wailsapp/wails/workflows/release/badge.svg?branch=master" alt="Release Pipelines"></a>
-   <a href="https://github.com/wailsapp/wails/workflows/latest-pre/badge.svg?branch=masterr" rel="nofollow"><img src="https://github.com/wailsapp/wails/workflows/latest-pre/badge.svg?branch=master" alt="Pre-Release Pipelines"></a>
 </p>
 
 The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative!

app.go

@@ -2,7 +2,6 @@ package wails
 
 import (
 	"os"
-	"runtime"
 	"syscall"
 
 	"github.com/syossan27/tebata"
@@ -117,11 +116,6 @@ func (a *App) start() error {
 		return err
 	}
 
-	// Enable console for Windows debug builds
-	if runtime.GOOS == "windows" && BuildMode == cmd.BuildModeDebug {
-		a.renderer.EnableConsole()
-	}
-
 	// Start signal handler
 	t := tebata.New(os.Interrupt, os.Kill, syscall.SIGTERM, syscall.SIGINT, syscall.SIGKILL)
 	t.Reserve(func() {

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 {
@@ -140,24 +143,31 @@ func BuildDocker(binaryName string, buildMode string, projectOptions *ProjectOpt
 		"-v", fmt.Sprintf("%s:/build", filepath.Join(fs.Cwd(), "build")),
 		"-v", fmt.Sprintf("%s:/source", fs.Cwd()),
 		"-e", fmt.Sprintf("LOCAL_USER_ID=%v", userid),
+		"-e", fmt.Sprintf("FLAG_TAGS=%s", projectOptions.Tags),
 		"-e", fmt.Sprintf("FLAG_LDFLAGS=%s", ldFlags(projectOptions, buildMode)),
 		"-e", "FLAG_V=false",
 		"-e", "FLAG_X=false",
 		"-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",
-		projectOptions.Platform, projectOptions.Architecture)
+		"Packing + Compiling project for %s/%s using docker image wailsapp/xgo:%s",
+		projectOptions.Platform, projectOptions.Architecture, xgoVersion)
 
 	if buildMode == BuildModeDebug {
 		compileMessage += " (Debug Mode)"
@@ -216,10 +226,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
@@ -243,6 +249,10 @@ func BuildNative(binaryName string, forceRebuild bool, buildMode string, project
 
 	buildCommand.AddSlice([]string{"-ldflags", ldFlags(projectOptions, buildMode)})
 
+	if projectOptions.Tags != "" {
+		buildCommand.AddSlice([]string{"--tags", projectOptions.Tags})
+	}
+
 	if projectOptions.Verbose {
 		fmt.Printf("Command: %v\n", buildCommand.AsSlice())
 	}
@@ -530,6 +540,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))
@@ -561,6 +574,10 @@ func ldFlags(po *ProjectOptions, buildMode string) string {
 		ldflags += "-H windowsgui "
 	}
 
+	if po.UseFirebug {
+		ldflags += "-X github.com/wailsapp/wails/lib/renderer.UseFirebug=true "
+	}
+
 	ldflags += "-X github.com/wailsapp/wails.BuildMode=" + buildMode
 
 	// Add additional ldflags passed in via the `ldflags` cli flag

cmd/linux.go

@@ -65,6 +65,8 @@ const (
 	Solus
 	// Ctlos Linux distribution
 	Ctlos
+	// EndeavourOS linux distribution
+	EndeavourOS
 )
 
 // DistroInfo contains all the information relating to a linux distribution
@@ -132,7 +134,7 @@ func parseOsRelease(osRelease string) *DistroInfo {
 	case "archlabs":
 		result.Distribution = ArchLabs
 	case "ctlos":
-		result.Distribution = Ctlos	
+		result.Distribution = Ctlos
 	case "debian":
 		result.Distribution = Debian
 	case "ubuntu":
@@ -171,6 +173,8 @@ func parseOsRelease(osRelease string) *DistroInfo {
 		result.Distribution = PopOS
 	case "solus":
 		result.Distribution = Solus
+	case "endeavouros":
+		result.Distribution = EndeavourOS
 	default:
 		result.Distribution = Unknown
 	}

cmd/linuxdb.yaml

@@ -202,7 +202,16 @@ distributions:
         name: Ctlos Linux
         gccversioncommand: *gccdumpversion
         programs: *archdefaultprograms
-        libraries: *archdefaultlibraries                
+        libraries: *archdefaultlibraries   
+  endeavouros:
+    id: endeavouros
+    releases:
+      default:
+        version: default
+        name: EndeavourOS
+        gccversioncommand: *gccdumpversion
+        programs: *archdefaultprograms
+        libraries: *archdefaultlibraries             
   manjaro:
     id: manjaro
     releases:

cmd/project.go

@@ -6,6 +6,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"runtime"
 	"sort"
 	"strings"
 
@@ -150,6 +151,7 @@ type ProjectOptions struct {
 	Template               string    `json:"-"`
 	BinaryName             string    `json:"binaryname"`
 	FrontEnd               *frontend `json:"frontend,omitempty"`
+	Tags                   string    `json:"tags"`
 	NPMProjectName         string    `json:"-"`
 	system                 *SystemHelper
 	log                    *Logger
@@ -162,6 +164,25 @@ type ProjectOptions struct {
 	Platform               string
 	Architecture           string
 	LdFlags                string
+	GoPath                 string
+	UseFirebug             bool
+
+	// 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 +253,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 +273,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 +399,9 @@ func processTemplateMetadata(templateMetadata *TemplateMetadata, po *ProjectOpti
 		}
 		po.FrontEnd.Serve = templateMetadata.Serve
 	}
+
+	// Save platforms
+	po.Platforms = templateMetadata.Platforms
+
 	return nil
 }

cmd/system.go

@@ -276,7 +276,7 @@ func CheckDependencies(logger *Logger) (bool, error) {
 		switch distroInfo.Distribution {
 		case Ubuntu, Debian, Zorin, Parrot, Linuxmint, Elementary, Kali, Neon, Deepin, Raspbian, PopOS:
 			libraryChecker = DpkgInstalled
-		case Arch, ArcoLinux, ArchLabs, Ctlos, Manjaro, ManjaroARM:
+		case Arch, ArcoLinux, ArchLabs, Ctlos, Manjaro, ManjaroARM, EndeavourOS:
 			libraryChecker = PacmanInstalled
 		case CentOS, Fedora, Tumbleweed, Leap:
 			libraryChecker = RpmInstalled

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/templates/angular-template/frontend/src/app/app-routing.module.ts

@@ -5,7 +5,7 @@ const routes: Routes = [];
 
 @NgModule({
   imports: [
-    RouterModule.forRoot(routes)
+    RouterModule.forRoot(routes,{useHash:true})
   ],
   exports: [RouterModule]
 })

cmd/templates/svelte/frontend/package.json.template

@@ -7,18 +7,25 @@
     "start": "sirv public"
   },
   "devDependencies": {
+    "@babel/core": "^7.11.6",
+    "@babel/plugin-syntax-dynamic-import": "^7.8.3",
+    "@babel/plugin-transform-runtime": "^7.11.5",
+    "@babel/preset-env": "^7.11.5",
     "@rollup/plugin-commonjs": "^14.0.0",
-	"@rollup/plugin-image": "^2.0.5",
+    "@rollup/plugin-image": "^2.0.5",
     "@rollup/plugin-node-resolve": "^8.0.0",
+    "core-js": "^3.6.5",
     "rollup": "^2.3.4",
+    "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-livereload": "^2.0.0",
+    "rollup-plugin-polyfill": "^3.0.0",
     "rollup-plugin-svelte": "^6.0.0",
     "rollup-plugin-terser": "^7.0.0",
     "svelte": "^3.0.0"
   },
   "dependencies": {
     "sirv-cli": "^1.0.0",
-	"@wailsapp/runtime": "^1.0.10",
-	"svelte-simple-modal": "^0.6.0"
+	  "@wailsapp/runtime": "^1.0.10",
+	  "svelte-simple-modal": "^0.6.0"
   }
 }

cmd/templates/svelte/frontend/rollup.config.js

@@ -4,6 +4,8 @@ import commonjs from '@rollup/plugin-commonjs';
 import livereload from 'rollup-plugin-livereload';
 import { terser } from 'rollup-plugin-terser';
 import image from '@rollup/plugin-image';
+import babel from 'rollup-plugin-babel';
+import polyfill from 'rollup-plugin-polyfill';
 
 const production = !process.env.ROLLUP_WATCH;
 
@@ -67,6 +69,37 @@ export default {
 		// browser on changes when not in production
 		!production && livereload('public'),
 
+		// Credit: https://blog.az.sg/posts/svelte-and-ie11/
+		babel({
+			extensions: [ '.js', '.jsx', '.es6', '.es', '.mjs', '.svelte', '.html' ],
+			runtimeHelpers: true,
+			exclude: [ 'node_modules/@babel/**', 'node_modules/core-js/**' ],
+			presets: [
+			  [
+				'@babel/preset-env',
+				{
+				  targets: '> 0.25%, not dead, IE 11',
+				  modules: false,
+				  spec: true, 
+				  useBuiltIns: 'usage',
+				  forceAllTransforms: true,
+				  corejs: 3,
+				},
+
+			  ]
+			],
+			plugins: [
+			  '@babel/plugin-syntax-dynamic-import',
+			  [
+				'@babel/plugin-transform-runtime',
+				{
+				  useESModules: true
+				}
+			  ]
+			]
+		  }),
+		  polyfill(['@webcomponents/webcomponentsjs']),
+
 		// If we're building for production (npm run build
 		// instead of npm run dev), minify
 		production && terser()

cmd/templates/vanilla/frontend/src/main.css

@@ -2,29 +2,33 @@
 html, 
 body {
   background-color: white;
+  color: black;
   width: 100%;
   height: 100%;
   margin: 0;
 }
 
+input {
+  background-color: rgb(254,254,254);
+  color: black;
+}
+
 .container {
   display: block;
   width:100%;
   text-align: center;
-  margin-top: 3rem;
+  margin-top: 1rem;
   font-size: 2rem;
 }
 
 button {
   font-size: 1rem;
-}
-
-#newCounter {
-  color: white;
+  background-color: white;
+  color: black;
 }
 
 .result {
-  margin-top: 3rem;
+  margin-top: 1rem;
   text-align: center;
   font-size: 2rem;
 }

cmd/templates/vanilla/frontend/src/main.js

@@ -36,7 +36,7 @@ function start() {
 		mystore.set(newValue);
 	};
 
-	mystore.subscribe( (state) => {
+	mystore.subscribe( function(state) {
 		document.getElementById('counter').innerText = state;
 	});
 	

cmd/templates/vue3-full/frontend/.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+last 2 versions
+not dead

cmd/templates/vue3-full/frontend/.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true
+  },
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/typescript/recommended'
+  ],
+  parserOptions: {
+    ecmaVersion: 2020
+  },
+  rules: {
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
+  },
+  overrides: [
+    {
+      files: [
+        '**/__tests__/*.{j,t}s?(x)',
+        '**/tests/unit/**/*.spec.{j,t}s?(x)'
+      ],
+      env: {
+        mocha: true
+      }
+    }
+  ]
+}

cmd/templates/vue3-full/frontend/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+node_modules
+/dist
+
+# local env files
+.env.local
+.env.*.local
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw*