Merge branch 'develop' of github.com:wailsapp/wails into develop

CONTRIBUTORS.md

@@ -35,3 +35,5 @@ Wails is what it is because of the time and effort given by these great people.
   * [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)

cmd/helpers.go

@@ -143,6 +143,7 @@ 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",
@@ -248,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())
 	}
@@ -535,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))

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
@@ -163,6 +165,23 @@ type ProjectOptions struct {
 	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
@@ -233,13 +252,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 {
@@ -250,6 +272,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
@@ -372,5 +398,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/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*

cmd/templates/vue3-full/frontend/README.md

@@ -0,0 +1,35 @@
+# vue basic
+
+## Project setup
+
+```
+npm install
+```
+
+### Compiles and hot-reloads for development
+
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+
+```
+npm run build
+```
+
+### Run your tests
+
+```
+npm run test
+```
+
+### Lints and fixes files
+
+```
+npm run lint
+```
+
+### Customize configuration
+
+See [Configuration Reference](https://cli.vuejs.org/config/).

cmd/templates/vue3-full/frontend/package.json.template

@@ -0,0 +1,37 @@
+{
+  "name": "{{.NPMProjectName}}",
+  "author": "{{.Author.Name}}<{{.Author.Email}}>",
+  "private": true,
+  "scripts": {
+    "serve": "vue-cli-service serve",
+    "build": "vue-cli-service build",
+    "test:unit": "vue-cli-service test:unit",
+    "lint": "vue-cli-service lint"
+  },
+  "dependencies": {
+    "vue": "^3.0.0-0",
+    "vue-router": "^4.0.0-0",
+    "regenerator-runtime": "^0.13.7",
+    "@wailsapp/runtime": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.12",
+    "@types/mocha": "^8.0.3",
+    "@typescript-eslint/eslint-plugin": "^4.3.0",
+    "@typescript-eslint/parser": "^4.3.0",
+    "@vue/cli-plugin-eslint": "~4.5.6",
+    "@vue/cli-plugin-router": "~4.5.6",
+    "@vue/cli-plugin-typescript": "~4.5.6",
+    "@vue/cli-plugin-unit-mocha": "~4.5.6",
+    "@vue/cli-service": "~4.5.6",
+    "@vue/compiler-sfc": "^3.0.0",
+    "@vue/eslint-config-typescript": "^5.1.0",
+    "@vue/test-utils": "^2.0.0-0",
+    "chai": "^4.2.0",
+    "eslint": "^7.10.0",
+    "eslint-plugin-vue": "^7.0.0",
+    "node-sass": "^4.14.1",
+    "sass-loader": "^10.0.2",
+    "typescript": "~4.0.3"
+  }
+}

cmd/templates/vue3-full/frontend/src/App.vue

@@ -0,0 +1,32 @@
+<template>
+  <div id=app>
+    <div id="nav">
+      <router-link to="/">Home</router-link> |
+      <router-link to="/about">About</router-link>
+    </div>
+    <router-view/>
+  </div>
+</template>
+
+<style lang="scss">
+#app {
+  font-family: Avenir, Helvetica, Arial, sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  text-align: center;
+  color: #2c3e50;
+}
+
+#nav {
+  padding: 30px;
+
+  a {
+    font-weight: bold;
+    color: #2c3e50;
+
+    &.router-link-exact-active {
+      color: #42b983;
+    }
+  }
+}
+</style>

cmd/templates/vue3-full/frontend/src/components/HelloWorld.vue

@@ -0,0 +1,34 @@
+<template>
+  <div class="hello">
+    <h1>{{ msg }}</h1>
+  </div>
+</template>
+
+<script lang="ts">
+import { defineComponent } from 'vue';
+
+export default defineComponent({
+  name: 'HelloWorld',
+  props: {
+    msg: String,
+  },
+});
+</script>
+
+<!-- Add "scoped" attribute to limit CSS to this component only -->
+<style scoped lang="scss">
+h3 {
+  margin: 40px 0 0;
+}
+ul {
+  list-style-type: none;
+  padding: 0;
+}
+li {
+  display: inline-block;
+  margin: 0 10px;
+}
+a {
+  color: #42b983;
+}
+</style>

cmd/templates/vue3-full/frontend/src/main.ts

@@ -0,0 +1,8 @@
+import { createApp } from 'vue';
+import App from './App.vue';
+import router from './router';
+import * as Wails from '@wailsapp/runtime';
+
+Wails.Init(() => {
+    createApp(App).use(router).mount('#app');
+});

cmd/templates/vue3-full/frontend/src/router/index.ts

@@ -0,0 +1,27 @@
+import { createRouter, createMemoryHistory, RouteRecordRaw } from 'vue-router'
+import Home from '../views/Home.vue'
+import About from '../views/About.vue'
+
+const routes: Array<RouteRecordRaw> = [
+  {
+    path: '/',
+    name: 'Home',
+    component: Home
+  },
+  {
+    path: '/about',
+    name: 'About',
+    // route level code-splitting
+    // this generates a separate chunk (about.[hash].js) for this route
+    // which is lazy-loaded when the route is visited.
+    // component: () => import(/* webpackChunkName: "about" */ '../views/About.vue')
+    component: About
+  }
+]
+
+const router = createRouter({
+  history: createMemoryHistory(),
+  routes
+})
+
+export default router

cmd/templates/vue3-full/frontend/src/shims-vue.d.ts

@@ -0,0 +1,5 @@
+declare module '*.vue' {
+  import { defineComponent } from 'vue'
+  const component: ReturnType<typeof defineComponent>
+  export default component
+}

cmd/templates/vue3-full/frontend/src/views/About.vue

@@ -0,0 +1,5 @@
+<template>
+  <div class="about">
+    <h1>This is an about page</h1>
+  </div>
+</template>

cmd/templates/vue3-full/frontend/src/views/Home.vue

@@ -0,0 +1,40 @@
+<template>
+  <div class="home">
+    <img @click="getMessage" alt="Vue logo" src="../assets/appicon.png" :style="{ height: '400px' }"/>
+    <HelloWorld :msg="message" />
+  </div>
+</template>
+
+<script lang="ts">
+import { ref, defineComponent } from "vue";
+import HelloWorld from "@/components/HelloWorld.vue"; // @ is an alias to /src
+
+interface Backend {
+  basic(): Promise<string>;
+}
+
+declare global {
+  interface Window {
+    backend: Backend;
+  }
+}
+
+export default defineComponent({
+  name: "Home",
+  components: {
+    HelloWorld,
+  },
+  setup() {
+    
+    const message = ref("Click the Icon");
+
+    const getMessage = () => {
+      window.backend.basic().then(result => {
+        message.value = result;
+      });
+    }
+
+    return { message: message, getMessage: getMessage };
+  },
+});
+</script>

cmd/templates/vue3-full/frontend/tests/unit/example.spec.ts

@@ -0,0 +1,14 @@
+import { expect } from 'chai';
+import { describe, it } from 'mocha';
+import { shallowMount } from '@vue/test-utils';
+import HelloWorld from '@/components/HelloWorld.vue';
+
+describe('HelloWorld.vue', () => {
+	it('renders props.msg when passed', () => {
+		const msg = 'new message';
+		const wrapper = shallowMount(HelloWorld, {
+			props: { msg }
+		});
+		expect(wrapper.text()).to.include(msg);
+	});
+});

cmd/templates/vue3-full/frontend/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "esnext",
+    "strict": true,
+    "jsx": "preserve",
+    "importHelpers": true,
+    "moduleResolution": "node",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "baseUrl": ".",
+    "types": [
+      "webpack-env",
+      "mocha",
+      "chai"
+    ],
+    "paths": {
+      "@/*": [
+        "src/*"
+      ]
+    },
+    "lib": [
+      "esnext",
+      "dom",
+      "dom.iterable",
+      "scripthost"
+    ]
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "src/**/*.vue",
+    "tests/**/*.ts",
+    "tests/**/*.tsx"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

cmd/templates/vue3-full/frontend/vue.config.js

@@ -0,0 +1,42 @@
+let cssConfig = {};
+
+if (process.env.NODE_ENV == 'production') {
+	cssConfig = {
+		extract: {
+			filename: '[name].css',
+			chunkFilename: '[name].css'
+		}
+	};
+}
+
+module.exports = {
+	chainWebpack: config => {
+		let limit = 9999999999999999;
+		config.module
+			.rule('images')
+			.test(/\.(png|gif|jpg)(\?.*)?$/i)
+			.use('url-loader')
+			.loader('url-loader')
+			.tap(options => Object.assign(options, { limit: limit }));
+		config.module
+			.rule('fonts')
+			.test(/\.(woff2?|eot|ttf|otf|svg)(\?.*)?$/i)
+			.use('url-loader')
+			.loader('url-loader')
+			.options({
+				limit: limit
+			});
+	},
+	css: cssConfig,
+	configureWebpack: {
+		output: {
+			filename: '[name].js'
+		},
+		optimization: {
+			splitChunks: false
+		}
+	},
+	devServer: {
+		disableHostCheck: true
+	}
+};

cmd/templates/vue3-full/go.mod.template

@@ -0,0 +1,5 @@
+module {{.BinaryName}}
+
+require (
+	github.com/wailsapp/wails {{.WailsVersion}}
+)

cmd/templates/vue3-full/main.go.template

@@ -0,0 +1,27 @@
+package main
+
+import (
+  "github.com/leaanthony/mewn"
+  "github.com/wailsapp/wails"
+)
+
+func basic() string {
+  return "Hello World!"
+}
+
+func main() {
+
+  js := mewn.String("./frontend/dist/app.js")
+  css := mewn.String("./frontend/dist/app.css")
+
+  app := wails.CreateApp(&wails.AppConfig{
+    Width:  1024,
+    Height: 768,
+    Title:  "{{.Name}}",
+    JS:     js,
+    CSS:    css,
+    Colour: "#131313",
+  })
+  app.Bind(basic)
+  app.Run()
+}

cmd/templates/vue3-full/template.json

@@ -0,0 +1,15 @@
+{
+  "name": "Vue3 Full",
+  "version": "1.0.0",
+  "shortdescription": "Vue 3, Vuex, Vue-router, and Webpack4",
+  "description": "Vue3.0.0 Vuex, Vue-router, and Webpack 4",
+  "install": "npm install",
+  "build": "npm run build",
+  "author": "Kyle Muchmore <kmuchmor@gmail.com>",
+  "created": "2020-09-24 21:18:55.09417 +0000 UTC m=+90.125590001",
+  "frontenddir": "frontend",
+  "serve": "npm run serve",
+  "bridge": "src",
+  "wailsdir": "",
+  "platforms": ["linux", "darwin"]
+}

cmd/wails/4_build.go

@@ -31,6 +31,7 @@ func init() {
 	var verbose = false
 	var platform = ""
 	var ldflags = ""
+	var tags = ""
 
 	buildSpinner := spinner.NewSpinner()
 	buildSpinner.SetSpinSpeed(50)
@@ -44,7 +45,8 @@ func init() {
 		BoolFlag("verbose", "Verbose output", &verbose).
 		StringFlag("t", "Generate Typescript definitions to given file (at runtime)", &typescriptFilename).
 		StringFlag("ldflags", "Extra options for -ldflags", &ldflags).
-		StringFlag("gopath", "Specify your GOPATH location. Mounted to /go during cross-compilation.", &gopath)
+		StringFlag("gopath", "Specify your GOPATH location. Mounted to /go during cross-compilation.", &gopath).
+		StringFlag("tags", "Build tags to pass to the go compiler (quoted and space separated)", &tags)
 
 	var b strings.Builder
 	for _, plat := range getSupportedPlatforms() {
@@ -78,6 +80,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 {
@@ -101,6 +108,9 @@ func init() {
 		projectOptions.LdFlags = ldflags
 		projectOptions.GoPath = gopath
 
+		// Add tags
+		projectOptions.Tags = tags
+
 		// Validate config
 		// Check if we have a frontend
 		err = cmd.ValidateFrontendConfig(projectOptions)
@@ -184,6 +194,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)
 	})
 }