Support EndeavourOS (#565)

* Fix custom HTML

* Update HTML escaping

* Added more docs around config

CONTRIBUTORS.md

@@ -39,3 +39,4 @@ Wails is what it is because of the time and effort given by these great people.
   * [Kyle](https://github.com/kmuchmore)
   * [Balakrishna Prasad Ganne](https://github.com/aayush420)
   * [Charaf Rezrazi](https://github.com/Rezrazi)
+  * [misitebao](https://github.com/misitebao)

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

@@ -574,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

@@ -165,6 +165,7 @@ type ProjectOptions struct {
 	Architecture           string
 	LdFlags                string
 	GoPath                 string
+	UseFirebug             bool
 
 	// Supported platforms
 	Platforms []string `json:"platforms,omitempty"`

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/version.go

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

cmd/wails/4_build.go

@@ -26,6 +26,7 @@ func init() {
 	var packageApp = false
 	var forceRebuild = false
 	var debugMode = false
+	var usefirebug = false
 	var gopath = ""
 	var typescriptFilename = ""
 	var verbose = false
@@ -42,6 +43,7 @@ func init() {
 		BoolFlag("p", "Package application on successful build", &packageApp).
 		BoolFlag("f", "Force rebuild of application components", &forceRebuild).
 		BoolFlag("d", "Build in Debug mode", &debugMode).
+		BoolFlag("firebug", "Enable firebug console for debug builds", &usefirebug).
 		BoolFlag("verbose", "Verbose output", &verbose).
 		StringFlag("t", "Generate Typescript definitions to given file (at runtime)", &typescriptFilename).
 		StringFlag("ldflags", "Extra options for -ldflags", &ldflags).
@@ -80,6 +82,9 @@ func init() {
 			return fmt.Errorf("Unable to find 'project.json'. Please check you are in a Wails project directory")
 		}
 
+		// Set firebug flag
+		projectOptions.UseFirebug = usefirebug
+
 		// 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, ", "))

config.go

@@ -1,20 +1,39 @@
 package wails
 
 import (
+	"fmt"
+	"net/url"
+	"strings"
+
 	"github.com/leaanthony/mewn"
 	"github.com/wailsapp/wails/runtime"
 )
 
 // AppConfig is the configuration structure used when creating a Wails App object
 type AppConfig struct {
-	Width, Height    int
+	// The width and height of your application in pixels
-	Title            string
+	Width, Height int
-	defaultHTML      string
+
-	HTML             string
+	// The title to put in the title bar
-	JS               string
+	Title string
-	CSS              string
+
-	Colour           string
+	// The HTML your app should use. If you leave it blank, a default will be used:
-	Resizable        bool
+	// <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="IE=edge" content="IE=edge"></head><body><div id="app"></div><script type="text/javascript"></script></body></html>
+	HTML string
+
+	// The Javascript your app should use. Normally this should be generated by a bundler.
+	JS string
+
+	// The CSS your app should use. Normally this should be generated by a bundler.
+	CSS string
+
+	// The colour of your window. Can take "#fff", "rgb(255,255,255)", "rgba(255,255,255,1)" formats
+	Colour string
+
+	// Indicates whether your app should be resizable
+	Resizable bool
+
+	// Indicated if the devtools should be disabled
 	DisableInspector bool
 }
 
@@ -33,9 +52,14 @@ func (a *AppConfig) GetTitle() string {
 	return a.Title
 }
 
-// GetDefaultHTML returns the default HTML
+// GetHTML returns the default HTML
-func (a *AppConfig) GetDefaultHTML() string {
+func (a *AppConfig) GetHTML() string {
-	return a.defaultHTML
+	if len(a.HTML) > 0 {
+		a.HTML = url.QueryEscape(a.HTML)
+		a.HTML = "data:text/html," + strings.ReplaceAll(a.HTML, "+", "%20")
+		a.HTML = strings.ReplaceAll(a.HTML, "%3D", "=")
+	}
+	return a.HTML
 }
 
 // GetResizable returns true if the window should be resizable
@@ -79,6 +103,10 @@ func (a *AppConfig) merge(in *AppConfig) error {
 		a.JS = in.JS
 	}
 
+	if in.HTML != "" {
+		a.HTML = in.HTML
+	}
+
 	if in.Width != 0 {
 		a.Width = in.Width
 	}
@@ -109,5 +137,9 @@ func newConfig(userConfig *AppConfig) (*AppConfig, error) {
 		}
 	}
 
+	println("****************************************************")
+	fmt.Printf("%+v\n", result)
+	println("****************************************************")
+
 	return result, nil
 }

lib/interfaces/appconfig.go

@@ -6,9 +6,9 @@ type AppConfig interface {
 	GetHeight() int
 	GetTitle() string
 	GetResizable() bool
-	GetDefaultHTML() string
+	GetHTML() string
 	GetDisableInspector() bool
 	GetColour() string
 	GetCSS() string
 	GetJS() string
-}
+}

lib/interfaces/renderer.go

@@ -8,7 +8,6 @@ import (
 type Renderer interface {
 	Initialise(AppConfig, IPCManager, EventManager) error
 	Run() error
-	EnableConsole()
 
 	// Binding
 	NewBinding(bindingName string) error

lib/renderer/bridge/bridge.go

@@ -56,10 +56,6 @@ func (h *Bridge) Initialise(appConfig interfaces.AppConfig, ipcManager interface
 	return nil
 }
 
-// EnableConsole not needed for bridge!
-func (h *Bridge) EnableConsole() {
-}
-
 func (h *Bridge) wsBridgeHandler(w http.ResponseWriter, r *http.Request) {
 	conn, err := websocket.Upgrade(w, r, w.Header(), 1024, 1024)
 	if err != nil {

lib/renderer/webview.go

@@ -18,14 +18,17 @@ import (
 
 // WebView defines the main webview application window
 // Default values in []
+
+// UseFirebug indicates whether to inject the firebug console
+var UseFirebug = ""
+
 type WebView struct {
-	window        wv.WebView // The webview object
+	window       wv.WebView // The webview object
-	ipc           interfaces.IPCManager
+	ipc          interfaces.IPCManager
-	log           *logger.CustomLogger
+	log          *logger.CustomLogger
-	config        interfaces.AppConfig
+	config       interfaces.AppConfig
-	eventManager  interfaces.EventManager
+	eventManager interfaces.EventManager
-	bindingCache  []string
+	bindingCache []string
-	enableConsole bool
 }
 
 // NewWebView returns a new WebView struct
@@ -55,7 +58,7 @@ func (w *WebView) Initialise(config interfaces.AppConfig, ipc interfaces.IPCMana
 		Height:    config.GetHeight(),
 		Title:     config.GetTitle(),
 		Resizable: config.GetResizable(),
-		URL:       config.GetDefaultHTML(),
+		URL:       config.GetHTML(),
 		Debug:     !config.GetDisableInspector(),
 		ExternalInvokeCallback: func(_ wv.WebView, message string) {
 			w.ipc.Dispatch(message, w.callback)
@@ -104,11 +107,6 @@ func (w *WebView) evalJS(js string) error {
 	return nil
 }
 
-// EnableConsole enables the console!
-func (w *WebView) EnableConsole() {
-	w.enableConsole = true
-}
-
 // Escape the Javascripts!
 func escapeJS(js string) (string, error) {
 	result := strings.Replace(js, "\\", "\\\\", -1)
@@ -179,10 +177,9 @@ func (w *WebView) Run() error {
 	w.log.Info("Running...")
 
 	// Inject firebug in debug mode on Windows
-	if w.enableConsole {
+	if UseFirebug != "" {
-		w.log.Debug("Enabling Wails console")
+		w.log.Debug("Injecting Firebug")
-		console := mewn.String("../../runtime/assets/console.js")
+		w.evalJS(`window.usefirebug=true;`)
-		w.evalJS(console)
 	}
 
 	// Runtime assets

runtime/js/core/main.js

@@ -13,7 +13,7 @@ import * as Browser from './browser';
 import { On, OnMultiple, Emit, Notify, Heartbeat, Acknowledge } from './events';
 import { NewBinding } from './bindings';
 import { Callback } from './calls';
-import { AddScript, InjectCSS } from './utils';
+import { AddScript, InjectCSS, InjectFirebug } from './utils';
 import { AddIPCListener } from './ipc';
 import * as Store from './store';
 
@@ -60,6 +60,11 @@ window.onerror = function (msg, url, lineNo, columnNo, error) {
 	window.wails.Log.Error('error: ' + error);
 };
 
+// Use firebug?
+if( window.usefirebug ) { 
+	InjectFirebug();
+}
+
 // Emit loaded event
 Emit('wails:loaded');
 

runtime/js/core/utils.js

@@ -20,6 +20,18 @@ export function AddScript(js, callbackID) {
 	}
 }
 
+export function InjectFirebug() {
+	// set the debug attribute on HTML
+	var html = document.getElementsByTagName('html')[0];
+	html.setAttribute('debug', 'true');
+	var firebugURL = 'https://wails.app/assets/js/firebug-lite.js#startOpened=true,disableWhenFirebugActive=false';
+	var script = document.createElement('script');
+	script.src = firebugURL;
+	script.type = 'application/javascript';
+	document.head.appendChild(script);
+	window.wails.Log.Info('Injected firebug');
+}
+
 // Adapted from webview - thanks zserge!
 export function InjectCSS(css) {
 	var elem = document.createElement('style');