feat(website): init the website

without this removal a user would have to call `SetTitle("")` in order to
erase the default if they desire a title-less dialog.

.github/pull_request_template.md

@@ -0,0 +1,37 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+  
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+  
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using `wails doctor`.
+
+- [ ] Windows
+- [ ] macOS
+- [ ] Linux
+  
+## Test Configuration
+
+Please paste the output of `wails doctor`. If you are unable to run this command, please describe your environment in as much detail as possible.
+
+# Checklist:
+
+- [ ] I have updated `website/src/pages/changelog.mdx` with details of this PR
+- [ ] My code follows the general coding style of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

.github/workflows/format-markdown-files.yml

@@ -0,0 +1,37 @@
+name: Format Markdown Files
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+jobs:
+  format_markdown_files:
+    runs-on: ubuntu-latest
+    if: github.repository == 'wailsapp/wails'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+
+      - name: Install Task
+        uses: arduino/setup-task@v1
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Format All Markdown Files
+        run: task format-all-md
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: "docs: format document"
+          title: "docs: format document"
+          body: "- [x] Format all Markdown(x) documents"
+          branch: chore/format-markdown-files
+          delete-branch: true
+          draft: false

.github/workflows/sync-translated-documents.yml

@@ -2,6 +2,8 @@ name: Sync Translations
 
 on:
   workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
 
 jobs:
   sync-translated-documents:

.prettierignore

@@ -0,0 +1,3 @@
+website
+v2
+v3

.prettierrc.yml

@@ -0,0 +1,6 @@
+overrides:
+  - files:
+      - "**/*.md"
+    options:
+      printWidth: 80
+      proseWrap: always

Taskfile.yaml

@@ -2,8 +2,19 @@
 
 version: "3"
 
-vars:
-  GREETING: Hello, World!
+includes:
+  website:
+    taskfile: website
+    dir: website
+
+  v2:
+    taskfile: v2
+    dir: v2
+    optional: true
+  v3:
+    taskfile: v3
+    dir: v3
+    optional: true
 
 tasks:
   contributors:check:
@@ -18,7 +29,19 @@ tasks:
     cmds:
       - npx -y all-contributors-cli generate
 
-  release:
-    dir: v2/tools/release
+  format:md:
     cmds:
-      - go run release.go {{.CLI_ARGS}}
+      - npx prettier --write "**/*.md"
+
+  format:
+    cmds:
+      - task: format:md
+
+  format-all-md:
+    cmds:
+      - task: format:md
+      - task: website:format:md
+      - task: v2:format:md
+      # - task: v2:website:format
+      - task: v3:format:md
+      # - task: v3:website:format:md

v2/.prettierignore

@@ -0,0 +1 @@
+website

v2/.prettierrc.yml

@@ -0,0 +1,6 @@
+overrides:
+  - files:
+      - "**/*.md"
+    options:
+      printWidth: 80
+      proseWrap: always

v2/Taskfile.yaml

@@ -0,0 +1,17 @@
+# https://taskfile.dev
+
+version: "3"
+
+tasks:
+  release:
+    dir: tools/release
+    cmds:
+      - go run release.go {{.CLI_ARGS}}
+
+  format:md:
+    cmds:
+      - npx prettier --write "**/*.md"
+
+  format:
+    cmds:
+      - task: format:md

v2/cmd/wails/doctor.go

@@ -14,43 +14,33 @@ import (
 )
 
 func diagnoseEnvironment(f *flags.Doctor) error {
-
 	if f.NoColour {
 		pterm.DisableColor()
 		colour.ColourEnabled = false
 	}
 
-	app.PrintBanner()
+	pterm.DefaultSection = *pterm.DefaultSection.
+		WithBottomPadding(0).
+		WithStyle(pterm.NewStyle(pterm.FgBlue, pterm.Bold))
 
-	spinner, _ := pterm.DefaultSpinner.Start("Scanning system - Please wait (this may take a long time)...")
+	pterm.Println() // Spacer
+	pterm.DefaultHeader.WithBackgroundStyle(pterm.NewStyle(pterm.BgLightBlue)).WithMargin(10).Println("Wails Doctor")
+	pterm.Println() // Spacer
+
+	spinner, _ := pterm.DefaultSpinner.WithRemoveWhenDone().Start("Scanning system - Please wait (this may take a long time)...")
 
 	// Get system info
 	info, err := system.GetInfo()
 	if err != nil {
-		spinner.Fail("Failed.")
-		return err
-	}
-	spinner.Success("Done.")
-
-	pterm.DefaultSection.Println("System")
-
-	systemTabledata := [][]string{
-		{"OS", info.OS.Name},
-		{"Version", info.OS.Version},
-		{"ID", info.OS.ID},
-		{"Go Version", runtime.Version()},
-		{"Platform", runtime.GOOS},
-		{"Architecture", runtime.GOARCH},
-	}
-
-	err = pterm.DefaultTable.WithData(systemTabledata).Render()
-	if err != nil {
+		spinner.Fail()
+		pterm.Error.Println("Failed to get system information")
 		return err
 	}
+	spinner.Success()
 
 	pterm.DefaultSection.Println("Wails")
 
-	wailsTableData := [][]string{
+	wailsTableData := pterm.TableData{
 		{"Version", app.Version()},
 	}
 
@@ -78,41 +68,57 @@ func diagnoseEnvironment(f *flags.Doctor) error {
 		return err
 	}
 
+	pterm.DefaultSection.Println("System")
+
+	systemTabledata := pterm.TableData{
+		{pterm.Bold.Sprint("OS"), info.OS.Name},
+		{pterm.Bold.Sprint("Version"), info.OS.Version},
+		{pterm.Bold.Sprint("ID"), info.OS.ID},
+		{pterm.Bold.Sprint("Go Version"), runtime.Version()},
+		{pterm.Bold.Sprint("Platform"), runtime.GOOS},
+		{pterm.Bold.Sprint("Architecture"), runtime.GOARCH},
+	}
+
+	err = pterm.DefaultTable.WithBoxed().WithData(systemTabledata).Render()
+	if err != nil {
+		return err
+	}
+
 	pterm.DefaultSection.Println("Dependencies")
 
 	// Output Dependencies Status
-	var dependenciesMissing = []string{}
-	var externalPackages = []*packagemanager.Dependency{}
+	var dependenciesMissing []string
+	var externalPackages []*packagemanager.Dependency
 	var dependenciesAvailableRequired = 0
 	var dependenciesAvailableOptional = 0
 
-	dependenciesTableData := [][]string{
+	dependenciesTableData := pterm.TableData{
 		{"Dependency", "Package Name", "Status", "Version"},
 	}
 
 	hasOptionalDependencies := false
 	// Loop over dependencies
 	for _, dependency := range info.Dependencies {
-
 		name := dependency.Name
+
 		if dependency.Optional {
-			name = "*" + name
+			name = pterm.Gray("*") + name
 			hasOptionalDependencies = true
 		}
+
 		packageName := "Unknown"
-		status := "Not Found"
+		status := pterm.LightRed("Not Found")
 
 		// If we found the package
 		if dependency.PackageName != "" {
-
 			packageName = dependency.PackageName
 
 			// If it's installed, update the status
 			if dependency.Installed {
-				status = "Installed"
+				status = pterm.LightGreen("Installed")
 			} else {
 				// Generate meaningful status text
-				status = "Available"
+				status = pterm.LightMagenta("Available")
 
 				if dependency.Optional {
 					dependenciesAvailableOptional++
@@ -133,22 +139,19 @@ func diagnoseEnvironment(f *flags.Doctor) error {
 		dependenciesTableData = append(dependenciesTableData, []string{name, packageName, status, dependency.Version})
 	}
 
-	err = pterm.DefaultTable.WithHasHeader(true).WithData(dependenciesTableData).Render()
+	dependenciesTableString, _ := pterm.DefaultTable.WithHasHeader(true).WithData(dependenciesTableData).Srender()
+	dependenciesBox := pterm.DefaultBox.WithTitleBottomCenter()
 
 	if hasOptionalDependencies {
-		pterm.Println("* - Optional Dependency")
+		dependenciesBox = dependenciesBox.WithTitle(pterm.Gray("*") + " - Optional Dependency")
 	}
 
+	dependenciesBox.Println(dependenciesTableString)
+
 	pterm.DefaultSection.Println("Diagnosis")
 
 	// Generate an appropriate diagnosis
 
-	if len(dependenciesMissing) == 0 && dependenciesAvailableRequired == 0 {
-		pterm.Println("Your system is ready for Wails development!")
-	} else {
-		pterm.Println("Your system has missing dependencies!")
-	}
-
 	if dependenciesAvailableRequired != 0 {
 		pterm.Println("Required package(s) installation details: \n" + info.Dependencies.InstallAllRequiredCommand())
 	}
@@ -157,11 +160,18 @@ func diagnoseEnvironment(f *flags.Doctor) error {
 		pterm.Println("Optional package(s) installation details: \n" + info.Dependencies.InstallAllOptionalCommand())
 	}
 
+	if len(dependenciesMissing) == 0 && dependenciesAvailableRequired == 0 {
+		pterm.Success.Println("Your system is ready for Wails development!")
+	} else {
+		pterm.Warning.Println("Your system has missing dependencies!")
+	}
+
 	if len(dependenciesMissing) != 0 {
 		pterm.Println("Fatal:")
 		pterm.Println("Required dependencies missing: " + strings.Join(dependenciesMissing, " "))
 		pterm.Println("Please read this article on how to resolve this: https://wails.io/guides/resolving-missing-packages")
 	}
 
+	pterm.Println() // Spacer for sponsor message
 	return nil
 }

v2/cmd/wails/internal/dev/dev.go

@@ -318,9 +318,6 @@ func restartApp(buildOptions *build.Options, debugBinaryProcess *process.Process
 	os.Setenv("assetdir", f.AssetDir)
 	os.Setenv("devserver", f.DevServer)
 	os.Setenv("frontenddevserverurl", f.FrontendDevServerURL)
-	if legacyUseDevServerInsteadofCustomScheme {
-		os.Setenv("legacyusedevsererinsteadofcustomscheme", "true")
-	}
 
 	// Start up new binary with correct args
 	newProcess := process.NewProcess(appBinary, args...)

v2/cmd/wails/internal/version.txt

@@ -1 +1 @@
-v2.5.0
+v2.5.1

v2/internal/app/app_dev.go

@@ -106,15 +106,13 @@ func CreateApp(appoptions *options.App) (*App, error) {
 	}
 
 	if frontendDevServerURL != "" {
-		if os.Getenv("legacyusedevsererinsteadofcustomscheme") != "" {
-			startURL, err := url.Parse("http://" + devServer)
-			if err != nil {
-				return nil, err
-			}
-
-			ctx = context.WithValue(ctx, "starturl", startURL)
+		_, port, err := net.SplitHostPort(devServer)
+		if err != nil {
+			return nil, fmt.Errorf("unable to determine port of DevServer: %s", err)
 		}
 
+		ctx = context.WithValue(ctx, "assetserverport", port)
+
 		ctx = context.WithValue(ctx, "frontenddevserverurl", frontendDevServerURL)
 
 		externalURL, err := url.Parse(frontendDevServerURL)

v2/internal/frontend/desktop/darwin/frontend.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"html/template"
 	"log"
+	"net"
 	"net/url"
 	"unsafe"
 
@@ -78,6 +79,10 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger.
 	if _starturl, _ := ctx.Value("starturl").(*url.URL); _starturl != nil {
 		result.startURL = _starturl
 	} else {
+		if port, _ := ctx.Value("assetserverport").(string); port != "" {
+			result.startURL.Host = net.JoinHostPort(result.startURL.Host+".localhost", port)
+		}
+
 		var bindings string
 		var err error
 		if _obfuscated, _ := ctx.Value("obfuscated").(bool); !_obfuscated {

v2/internal/frontend/desktop/linux/frontend.go

@@ -78,6 +78,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"net"
 	"net/url"
 	"os"
 	"runtime"
@@ -149,6 +150,10 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger.
 	if _starturl, _ := ctx.Value("starturl").(*url.URL); _starturl != nil {
 		result.startURL = _starturl
 	} else {
+		if port, _ := ctx.Value("assetserverport").(string); port != "" {
+			result.startURL.Host = net.JoinHostPort(result.startURL.Host+".localhost", port)
+		}
+
 		var bindings string
 		var err error
 		if _obfuscated, _ := ctx.Value("obfuscated").(bool); !_obfuscated {

v2/internal/frontend/desktop/linux/keys.go

@@ -81,7 +81,8 @@ func parseKey(key string) C.guint {
 		return result
 	}
 	// Check for unknown namedkeys
-	if len(key) > 1 {
+	// Check if we only have a single character
+	if len(key) != 1 {
 		return C.guint(0)
 	}
 	keyval := rune(key[0])

v2/internal/frontend/desktop/windows/frontend.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"io"
 	"log"
+	"net"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
@@ -92,6 +93,10 @@ func NewFrontend(ctx context.Context, appoptions *options.App, myLogger *logger.
 		return result
 	}
 
+	if port, _ := ctx.Value("assetserverport").(string); port != "" {
+		result.startURL.Host = net.JoinHostPort(result.startURL.Host, port)
+	}
+
 	var bindings string
 	var err error
 	if _obfuscated, _ := ctx.Value("obfuscated").(bool); !_obfuscated {
@@ -589,8 +594,16 @@ func (f *Frontend) processRequest(req *edge.ICoreWebView2WebResourceRequest, arg
 		headers = append(headers, fmt.Sprintf("%s: %s", k, strings.Join(v, ",")))
 	}
 
+	code := rw.Code
+	if code == http.StatusNotModified {
+		// WebView2 has problems when a request returns a 304 status code and the WebView2 is going to hang for other
+		// requests including IPC calls.
+		f.logger.Error("%s: AssetServer returned 304 - StatusNotModified which are going to hang WebView2, changed code to 505 - StatusInternalServerError", uri)
+		code = http.StatusInternalServerError
+	}
+
 	env := f.chromium.Environment()
-	response, err := env.CreateWebResourceResponse(rw.Body.Bytes(), rw.Code, http.StatusText(rw.Code), strings.Join(headers, "\n"))
+	response, err := env.CreateWebResourceResponse(rw.Body.Bytes(), code, http.StatusText(code), strings.Join(headers, "\n"))
 	if err != nil {
 		f.logger.Error("CreateWebResourceResponse Error: %s", err)
 		return
@@ -829,6 +842,12 @@ func coreWebview2RequestToHttpRequest(coreReq *edge.ICoreWebView2WebResourceRequ
 			}
 		}
 
+		// WebView2 has problems when a request returns a 304 status code and the WebView2 is going to hang for other
+		// requests including IPC calls.
+		// So prevent 304 status codes by removing the headers that are used in combinationwith caching.
+		header.Del("If-Modified-Since")
+		header.Del("If-None-Match")
+
 		method, err := coreReq.GetMethod()
 		if err != nil {
 			return nil, fmt.Errorf("GetMethod Error: %s", err)

v2/internal/frontend/desktop/windows/go-webview2/webviewloader/env_create.go

@@ -4,6 +4,7 @@ package webviewloader
 
 import (
 	"fmt"
+	"os"
 	"path/filepath"
 	"syscall"
 	"unsafe"
@@ -14,6 +15,7 @@ import (
 
 func init() {
 	fmt.Println("DEB | Using go webview2loader")
+	preventEnvAndRegistryOverrides()
 }
 
 type webView2RunTimeType int32
@@ -104,6 +106,8 @@ func createWebViewEnvironmentWithClientDll(lpLibFileName string, runtimeType web
 	envCompletedCom := combridge.New[iCoreWebView2CreateCoreWebView2EnvironmentCompletedHandler](envCompletedHandler)
 	defer envCompletedCom.Close()
 
+	preventEnvAndRegistryOverrides()
+
 	const unknown = 1
 	hr, _, err := createProc.Call(
 		uintptr(unknown),
@@ -157,3 +161,16 @@ func (r *environmentCreatedHandler) EnvironmentCompleted(errorCode HRESULT, crea
 
 	return HRESULT(windows.S_OK)
 }
+
+func preventEnvAndRegistryOverrides() {
+	// Setting these env variables to empty string also prevents registry overrides because webview2
+	// checks for existence and not for empty value
+	os.Setenv("WEBVIEW2_PIPE_FOR_SCRIPT_DEBUGGER", "")
+	os.Setenv("WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS", "")
+	os.Setenv("WEBVIEW2_RELEASE_CHANNEL_PREFERENCE", "0")
+
+	// The following seems not be be required because those are only used by the webview2loader which
+	// in this case is implemented on our own. But nevertheless set them to empty to be consistent.
+	os.Setenv("WEBVIEW2_BROWSER_EXECUTABLE_FOLDER", "")
+	os.Setenv("WEBVIEW2_USER_DATA_FOLDER", "")
+}

v2/internal/frontend/devserver/devserver.go

@@ -97,13 +97,17 @@ func (d *DevWebServer) Run(ctx context.Context) error {
 		log.Fatal(err)
 	}
 
-	assetServer, err := assetserver.NewDevAssetServer(assetHandler, wsHandler, bindingsJSON, ctx.Value("assetdir") != nil, myLogger, runtime.RuntimeAssetsBundle)
+	assetServer, err := assetserver.NewDevAssetServer(assetHandler, bindingsJSON, ctx.Value("assetdir") != nil, myLogger, runtime.RuntimeAssetsBundle)
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	d.server.Any("/*", func(c echo.Context) error {
-		assetServer.ServeHTTP(c.Response(), c.Request())
+		if c.IsWebSocket() {
+			wsHandler.ServeHTTP(c.Response(), c.Request())
+		} else {
+			assetServer.ServeHTTP(c.Response(), c.Request())
+		}
 		return nil
 	})
 

v2/pkg/assetserver/assetserver.go

@@ -32,7 +32,6 @@ type RuntimeHandler interface {
 
 type AssetServer struct {
 	handler   http.Handler
-	wsHandler http.Handler
 	runtimeJS []byte
 	ipcJS     func(*http.Request) []byte
 
@@ -107,12 +106,8 @@ func (d *AssetServer) AddPluginScript(pluginName string, script string) {
 
 func (d *AssetServer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
 	if isWebSocket(req) {
-		// Forward WebSockets to the distinct websocket handler if it exists
-		if wsHandler := d.wsHandler; wsHandler != nil {
-			wsHandler.ServeHTTP(rw, req)
-		} else {
-			rw.WriteHeader(http.StatusNotImplemented)
-		}
+		// WebSockets are not supported by the AssetServer
+		rw.WriteHeader(http.StatusNotImplemented)
 		return
 	}