Merge pull request #107 from wailsapp/develop

Release v0.15.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,11 @@ assignees: ''
 
 ---
 
+#####################################################
+     If you have a technical issue, please do not open a bug this way! 
+                      Please use the `wails issue` command!                          
+#####################################################
+
 **Description**
 A clear and concise description of what the bug is.
 
@@ -24,7 +29,7 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **System Details**
-Please paste the output of `wails report` here.
+Please provide your platform, GO version and variables, etc
 
 **Additional context**
 Add any other context about the problem here.

CONTRIBUTORS.md

@@ -8,5 +8,6 @@ Wails is what it is because of the time and effort given by these great people.
 * [Adrian Lanzafame](https://github.com/lanzafame)
 * [0xflotus](https://github.com/0xflotus)
 * [Michael D Henderson](https://github.com/mdhender)
-* [fred2104] (https://github.com/fishfishfish2104)
-* [intelwalk] (https://github.com/intelwalk)
+* [fred2104](https://github.com/fishfishfish2104)
+* [intelwalk](https://github.com/intelwalk)
+* [admin_3.exe](https://github.com/bh90210)

README.md

@@ -9,7 +9,7 @@
    <a href="https://www.codefactor.io/repository/github/wailsapp/wails"><img src="https://www.codefactor.io/repository/github/wailsapp/wails/badge" alt="CodeFactor" /></a>
    <a href="https://github.com/wailsapp/wails/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="CodeFactor" /></a>
    <a href="https://houndci.com"><img src="https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg"/></a>
-   <a href="https://github.com/sindresorhus/awesome" rel="nofollow"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome"></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>
 </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!
@@ -33,7 +33,7 @@ Wails is currently in Beta. Please make sure you read the [Project Status](https
 
 Wails uses cgo to bind to the native rendering engines so a number of platform dependent libraries are needed as well as an installation of Go. The basic requirements are:
 
-- Go 1.11 or above
+- Go 1.12
 - npm
 
 ### MacOS
@@ -64,6 +64,8 @@ Windows requires gcc and related tooling. The recommended download is from [http
 
 ## Installation
 
+**Ensure Go modules are enabled: GO111MODULE=on and go/bin is in your PATH variable.**
+
 Installation is as simple as running the following command:
 
 <pre style='color:white'>

cmd/cli.go

@@ -96,6 +96,7 @@ type Command struct {
 	flagCount         int
 	log               *Logger
 	helpFlag          bool
+	hidden            bool
 }
 
 // NewCommand creates a new Command
@@ -106,6 +107,7 @@ func NewCommand(name string, description string, app *Cli, parentCommandPath str
 		SubCommandsMap:   make(map[string]*Command),
 		App:              app,
 		log:              NewLogger(),
+		hidden:           false,
 	}
 
 	// Set up command path
@@ -212,6 +214,9 @@ func (c *Command) PrintHelp() {
 		c.log.White("Available commands:")
 		fmt.Println("")
 		for _, subcommand := range c.SubCommands {
+			if subcommand.isHidden() {
+				continue
+			}
 			spacer := strings.Repeat(" ", 3+c.longestSubcommand-len(subcommand.Name))
 			isDefault := ""
 			if subcommand.isDefaultCommand() {
@@ -237,6 +242,16 @@ func (c *Command) isDefaultCommand() bool {
 	return c.App.defaultCommand == c
 }
 
+// isHidden returns true if the command is a hidden command
+func (c *Command) isHidden() bool {
+	return c.hidden
+}
+
+// Hidden hides the command from the Help system
+func (c *Command) Hidden() {
+	c.hidden = true
+}
+
 // Command - Defines a subcommand
 func (c *Command) Command(name, description string) *Command {
 	result := NewCommand(name, description, c.App, c.CommandPath)

cmd/fs.go

@@ -1,7 +1,9 @@
 package cmd
 
 import (
+	"bytes"
 	"crypto/md5"
+	"encoding/json"
 	"fmt"
 	"io"
 	"io/ioutil"
@@ -108,16 +110,19 @@ func (fs *FSHelper) RemoveFiles(files []string) error {
 	return nil
 }
 
+// Dir holds information about a directory
 type Dir struct {
 	localPath string
 	fullPath  string
 }
 
-func (fs *FSHelper) Dir(dir string) (*Dir, error) {
+// Directory creates a new Dir struct with the given directory path
+func (fs *FSHelper) Directory(dir string) (*Dir, error) {
 	fullPath, err := filepath.Abs(dir)
 	return &Dir{fullPath: fullPath}, err
 }
 
+// LocalDir creates a new Dir struct based on a path relative to the caller
 func (fs *FSHelper) LocalDir(dir string) (*Dir, error) {
 	_, filename, _, _ := runtime.Caller(1)
 	fullPath, err := filepath.Abs(filepath.Join(path.Dir(filename), dir))
@@ -174,6 +179,22 @@ func (fs *FSHelper) MkDir(dir string) error {
 	return os.Mkdir(dir, 0700)
 }
 
+// SaveAsJSON saves the JSON representation of the given data to the given filename
+func (fs *FSHelper) SaveAsJSON(data interface{}, filename string) error {
+
+	var buf bytes.Buffer
+	e := json.NewEncoder(&buf)
+	e.SetEscapeHTML(false)
+	e.SetIndent("", "  ")
+	e.Encode(data)
+
+	err := ioutil.WriteFile(filename, buf.Bytes(), 0755)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
 // LoadAsString will attempt to load the given file and return
 // its contents as a string
 func (fs *FSHelper) LoadAsString(filename string) (string, error) {

cmd/prerequisites.go

@@ -52,7 +52,7 @@ func getRequiredProgramsLinux() *Prerequisites {
 	case Ubuntu:
 		result.Add(newPrerequisite("gcc", "Please install with `sudo apt install build-essentials` and try again"))
 		result.Add(newPrerequisite("pkg-config", "Please install with `sudo apt install pkg-config` and try again"))
-		result.Add(newPrerequisite("npm", "Please install with `sudo apt install npm` and try again"))
+		result.Add(newPrerequisite("npm", "Please install with `sudo snap install node --channel=12/stable --classic` and try again"))
 
 	default:
 		result.Add(newPrerequisite("gcc", "Please install with your system package manager and try again"))

cmd/project.go

@@ -84,8 +84,6 @@ func (ph *ProjectHelper) GenerateProject(projectOptions *ProjectOptions) error {
 	// 	ph.GenerateWindowsResourceConfig(projectOptions)
 	// }
 
-	ph.log.Yellow("Project '%s' generated in directory '%s'!", projectOptions.Name, projectOptions.OutputDirectory)
-	ph.log.Yellow("To compile the project, run 'wails build' in the project directory.")
 	return nil
 }
 

cmd/system.go

@@ -68,6 +68,17 @@ func (s *SystemHelper) ConfigFileIsValid() bool {
 	return err == nil
 }
 
+// GetAuthor returns a formatted string of the user's name and email
+func (s *SystemHelper) GetAuthor() (string, error) {
+	var config *SystemConfig
+	config, err := s.LoadConfig()
+	if err != nil {
+		return "", err
+	}
+
+	return fmt.Sprintf("%s <%s>", config.Name, config.Email), nil
+}
+
 // BackupConfig attempts to backup the system config file
 func (s *SystemHelper) BackupConfig() (string, error) {
 	now := strconv.FormatInt(time.Now().UTC().UnixNano(), 10)

cmd/templates.go

@@ -3,12 +3,14 @@ package cmd
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
 	"io/ioutil"
 	"log"
 	"path/filepath"
 	"strings"
 	"text/template"
 
+	"github.com/kennygrant/sanitize"
 	"github.com/leaanthony/slicer"
 )
 
@@ -57,6 +59,36 @@ func NewTemplateHelper() *TemplateHelper {
 	}
 }
 
+// IsValidTemplate returns true if the given tempalte name resides on disk
+func (t *TemplateHelper) IsValidTemplate(templateName string) bool {
+	pathToTemplate := filepath.Join(t.templateDir.fullPath, templateName)
+	return t.fs.DirExists(pathToTemplate)
+}
+
+// SanitizeFilename sanitizes the given string to make a valid filename
+func (t *TemplateHelper) SanitizeFilename(name string) string {
+	return sanitize.Name(name)
+}
+
+// CreateNewTemplate creates a new template based on the given directory name and string
+func (t *TemplateHelper) CreateNewTemplate(dirname string, details *TemplateMetadata) (string, error) {
+
+	// Check if this template has already been created
+	if t.IsValidTemplate(dirname) {
+		return "", fmt.Errorf("cannot create template in directory '%s' - already exists", dirname)
+	}
+
+	targetDir := filepath.Join(t.templateDir.fullPath, dirname)
+	err := t.fs.MkDir(targetDir)
+	if err != nil {
+		return "", err
+	}
+	targetMetadata := filepath.Join(targetDir, t.metadataFilename)
+	err = t.fs.SaveAsJSON(details, targetMetadata)
+
+	return targetDir, err
+}
+
 // LoadMetadata loads the template's 'metadata.json' file
 func (t *TemplateHelper) LoadMetadata(dir string) (*TemplateMetadata, error) {
 	templateFile := filepath.Join(dir, t.metadataFilename)
@@ -109,7 +141,7 @@ func (t *TemplateHelper) GetTemplateDetails() (map[string]*TemplateDetails, erro
 func (t *TemplateHelper) GetTemplateFilenames(template *TemplateDetails) (*slicer.StringSlicer, error) {
 
 	// Get the subdirectory details
-	templateDir, err := t.fs.Dir(template.Path)
+	templateDir, err := t.fs.Directory(template.Path)
 	if err != nil {
 		return nil, err
 	}

cmd/templates/vuebasic/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/vuetify-basic/.jshint

@@ -0,0 +1,3 @@
+{ 
+  "esversion": 6 
+}

cmd/templates/vuetify-basic/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/vuetify-basic/frontend/babel.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  presets: [
+    '@vue/app'
+  ]
+}

cmd/templates/vuetify-basic/frontend/package.json.template

@@ -0,0 +1,52 @@
+{
+  "name": "{{.NPMProjectName}}",
+  "author": "{{.Author.Name}}<{{.Author.Email}}>",
+  "private": true,
+  "scripts": {
+    "serve": "vue-cli-service serve",
+    "build": "vue-cli-service build",
+    "lint": "vue-cli-service lint"
+  },
+  "dependencies": {
+    "babel-polyfill": "^6.26.0",
+    "core-js": "^2.6.4",
+    "material-design-icons-iconfont": "^5.0.1",
+    "vue": "^2.5.22",
+    "vuetify": "^1.5.14"
+  },
+  "devDependencies": {
+    "@vue/cli-plugin-babel": "^3.4.0",
+    "@vue/cli-plugin-eslint": "^3.4.0",
+    "@vue/cli-service": "^3.4.0",
+    "babel-eslint": "^10.0.1",
+    "eslint": "^5.8.0",
+    "eslint-plugin-vue": "^5.0.0",
+    "eventsource-polyfill": "^0.9.6",
+    "vue-template-compiler": "^2.5.21",
+    "webpack-hot-middleware": "^2.24.3"
+  },
+  "eslintConfig": {
+    "root": true,
+    "env": {
+      "node": true
+    },
+    "extends": [
+      "plugin:vue/essential",
+      "eslint:recommended"
+    ],
+    "rules": {},
+    "parserOptions": {
+      "parser": "babel-eslint"
+    }
+  },
+  "postcss": {
+    "plugins": {
+      "autoprefixer": {}
+    }
+  },
+  "browserslist": [
+    "> 1%",
+    "last 2 versions",
+    "not ie <= 8"
+  ]
+}

cmd/templates/vuetify-basic/frontend/src/App.vue

@@ -0,0 +1,60 @@
+<template>
+  <v-app id="inspire" dark>
+    <v-navigation-drawer v-model="drawer" clipped fixed app>
+      <v-list dense>
+        <v-list-tile>
+          <v-list-tile-action>
+            <v-icon>dashboard</v-icon>
+          </v-list-tile-action>
+          <v-list-tile-content>
+            <v-list-tile-title>Dashboard</v-list-tile-title>
+          </v-list-tile-content>
+        </v-list-tile>
+        <v-list-tile>
+          <v-list-tile-action>
+            <v-icon>settings</v-icon>
+          </v-list-tile-action>
+          <v-list-tile-content>
+            <v-list-tile-title>Settings</v-list-tile-title>
+          </v-list-tile-content>
+        </v-list-tile>
+      </v-list>
+    </v-navigation-drawer>
+    <v-toolbar app fixed clipped-left>
+      <v-toolbar-side-icon @click.stop="drawer = !drawer"></v-toolbar-side-icon>
+      <v-toolbar-title>Application</v-toolbar-title>
+    </v-toolbar>
+    <v-content>
+      <v-container fluid class="px-0">
+        <v-layout justify-center align-center class="px-0">
+          <hello-world></hello-world>
+        </v-layout>
+      </v-container>
+    </v-content>
+    <v-footer app fixed>
+      <span style="margin-left:1em">&copy; You</span>
+    </v-footer>
+  </v-app>
+</template>
+
+<script>
+import HelloWorld from "./components/HelloWorld.vue";
+
+export default {
+  data: () => ({
+    drawer: false
+  }),
+  components: {
+    HelloWorld
+  },
+  props: {
+    source: String
+  }
+};
+</script>
+
+<style>
+.logo {
+  width: 16em;
+}
+</style>

cmd/templates/vuetify-basic/frontend/src/components/HelloWorld.vue

@@ -0,0 +1,83 @@
+<template>
+  <v-container fluid class="px-0">
+    <v-layout>
+      <v-flex xs12 sm6 offset-sm3>
+        <v-card raised="raised" class="pa-4 ma-4">
+          <v-layout justify-center align-center class="pa-4 ma-4">
+            <v-img :src="require('../assets/images/logo.png')"></v-img>
+          </v-layout>
+          <v-card-actions>
+            <v-layout justify-center align-center class="px-0">
+              <v-btn color="blue" dark @click="getMessage">Press Me</v-btn>
+            </v-layout>
+          </v-card-actions>
+        </v-card>
+      </v-flex>
+    </v-layout>
+    <div class="text-xs-center">
+      <v-dialog v-model="dialog" width="500">
+        <v-card>
+          <v-card-title class="headline" primary-title>Message from Go</v-card-title>
+          <v-card-text>{{message}}</v-card-text>
+          <v-divider></v-divider>
+          <v-card-actions>
+            <v-spacer></v-spacer>
+            <v-btn color="primary" flat @click="dialog = false">Awesome</v-btn>
+          </v-card-actions>
+        </v-card>
+      </v-dialog>
+    </div>
+  </v-container>
+</template>
+
+<script>
+export default {
+  data() {
+    return {
+      message: " ",
+      raised: true,
+      dialog: false
+    };
+  },
+  methods: {
+    getMessage: function() {
+      var self = this;
+      window.backend.basic().then(result => {
+        self.message = result;
+        self.dialog = true;
+      });
+    }
+  }
+};
+</script>
+
+<!-- Add "scoped" attribute to limit CSS to this component only -->
+<style scoped>
+h1 {
+  margin-top: 2em;
+  position: relative;
+  min-height: 5rem;
+  width: 100%;
+}
+a:hover {
+  font-size: 1.7em;
+  border-color: blue;
+  background-color: blue;
+  color: white;
+  border: 3px solid white;
+  border-radius: 10px;
+  padding: 9px;
+  cursor: pointer;
+  transition: 500ms;
+}
+a {
+  font-size: 1.7em;
+  border-color: white;
+  background-color: #121212;
+  color: white;
+  border: 3px solid white;
+  border-radius: 10px;
+  padding: 9px;
+  cursor: pointer;
+}
+</style>

cmd/templates/vuetify-basic/frontend/src/main.js

@@ -0,0 +1,21 @@
+import 'babel-polyfill';
+import Vue from "vue";
+
+// Setup Vuetify
+import Vuetify from 'vuetify';
+Vue.use(Vuetify);
+import 'vuetify/dist/vuetify.min.css';
+import 'material-design-icons-iconfont';
+
+import App from "./App.vue";
+
+Vue.config.productionTip = false;
+Vue.config.devtools = true;
+
+import Bridge from "./wailsbridge";
+
+Bridge.Start(() => {
+  new Vue({
+    render: h => h(App)
+  }).$mount("#app");
+});

cmd/templates/vuetify-basic/frontend/vue.config.js

@@ -0,0 +1,43 @@
+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,
+    host: "localhost"
+  }
+};