Update docs and changelog

* docs: sync documents

* docs: fix document escape syntax

.github/workflows/build.yml

@@ -1,36 +0,0 @@
-name: Build
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-  workflow_dispatch:
-
-jobs:
-  build-v2:
-    name: v2 Build
-    if: github.repository == 'wailsapp/wails'
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: "master"
-          submodules: true
-          fetch-depth: 0
-
-      - name: Setup Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: ">=1.18.0"
-
-      - name: Build Wails CLI
-        run: |
-          cd ./v2/cmd/wails
-          go install
-          wails -help

.github/workflows/check_docs.yml

@@ -16,7 +16,8 @@ jobs:
         id: verify-changed-files
         with:
           files: |
-            v2/website/*.mdx
+            website/**/*.mdx
+            website/**/*.md
 
       - name: Run step only when files change.
         if: steps.verify-changed-files.outputs.files_changed != 'true'

.github/workflows/issue-translator.yml

@@ -1,16 +0,0 @@
-name: 'issue-translator'
-on:
-  issue_comment:
-    types: [ created ]
-  issues:
-    types: [ opened ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    if: github.repository == 'wailsapp/wails'
-    steps:
-      - uses: tomsun28/issues-translate-action@v2.6
-        with:
-          IS_MODIFY_TITLE: false
-          CUSTOM_BOT_NOTE: The issue body's language is not English, translating it automatically...

.github/workflows/push-to-crowdin.yml

@@ -0,0 +1,38 @@
+name: Push files to Crowdin
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  docs:
+    name: Push files to Crowdin
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Verify Changed files
+        uses: tj-actions/verify-changed-files@v11.1
+        id: verify-changed-files
+        with:
+          files: |
+            website/**/*.mdx
+            website/**/*.md
+            website/**/*.json
+
+      - name: Set node
+        if: steps.verify-changed-files.outputs.files_changed != 'true'
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+
+      - name: Push files
+        env:
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+        run: |
+          cd website
+          corepack enable
+          pnpm install
+          pnpm run crowdin push -b master

.github/workflows/test_js.yml

@@ -0,0 +1,32 @@
+name: Test JS
+
+on:
+  push:
+    branches: [ release/*, master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Run JS Tests
+    if: github.repository == 'wailsapp/wails'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: v2/internal/frontend/runtime
+
+      - name: Run tests
+        run: npm test
+        working-directory: v2/internal/frontend/runtime

v2/cmd/wails/internal/commands/build/build.go

@@ -77,9 +77,9 @@ func AddBuildSubcommand(app *clir.Cli, w io.Writer) {
 	outputFilename := ""
 	command.StringFlag("o", "Output filename", &outputFilename)
 
-	// Clean build directory
-	cleanBuildDirectory := false
-	command.BoolFlag("clean", "Clean the build directory before building", &cleanBuildDirectory)
+	// Clean bin directory
+	cleanBinDirectory := false
+	command.BoolFlag("clean", "Clean the bin directory before building", &cleanBinDirectory)
 
 	webview2 := "download"
 	command.StringFlag("webview2", "WebView2 installer strategy: download,embed,browser,error.", &webview2)
@@ -190,28 +190,29 @@ func AddBuildSubcommand(app *clir.Cli, w io.Writer) {
 
 		// Create BuildOptions
 		buildOptions := &build.Options{
-			Logger:              logger,
-			OutputType:          outputType,
-			OutputFile:          outputFilename,
-			CleanBuildDirectory: cleanBuildDirectory,
-			Mode:                mode,
-			Pack:                !noPackage,
-			LDFlags:             ldflags,
-			Compiler:            compilerCommand,
-			SkipModTidy:         skipModTidy,
-			Verbosity:           verbosity,
-			ForceBuild:          forceBuild,
-			IgnoreFrontend:      skipFrontend,
-			Compress:            compress,
-			CompressFlags:       compressFlags,
-			UserTags:            userTags,
-			WebView2Strategy:    wv2rtstrategy,
-			TrimPath:            trimpath,
-			RaceDetector:        raceDetector,
-			WindowsConsole:      windowsConsole,
-			Obfuscated:          obfuscated,
-			GarbleArgs:          garbleargs,
-			SkipBindings:        skipBindings,
+			Logger:            logger,
+			OutputType:        outputType,
+			OutputFile:        outputFilename,
+			CleanBinDirectory: cleanBinDirectory,
+			Mode:              mode,
+			Pack:              !noPackage,
+			LDFlags:           ldflags,
+			Compiler:          compilerCommand,
+			SkipModTidy:       skipModTidy,
+			Verbosity:         verbosity,
+			ForceBuild:        forceBuild,
+			IgnoreFrontend:    skipFrontend,
+			Compress:          compress,
+			CompressFlags:     compressFlags,
+			UserTags:          userTags,
+			WebView2Strategy:  wv2rtstrategy,
+			TrimPath:          trimpath,
+			RaceDetector:      raceDetector,
+			WindowsConsole:    windowsConsole,
+			Obfuscated:        obfuscated,
+			GarbleArgs:        garbleargs,
+			SkipBindings:      skipBindings,
+			ProjectData:       projectOptions,
 		}
 
 		// Start a new tabwriter
@@ -225,6 +226,7 @@ func AddBuildSubcommand(app *clir.Cli, w io.Writer) {
 			_, _ = fmt.Fprintf(w, "Compiler: \t%s\n", compilerPath)
 			_, _ = fmt.Fprintf(w, "Skip Bindings: \t%t\n", skipBindings)
 			_, _ = fmt.Fprintf(w, "Build Mode: \t%s\n", modeString)
+			_, _ = fmt.Fprintf(w, "Frontend Directory: \t%s\n", projectOptions.GetFrontendDir())
 			_, _ = fmt.Fprintf(w, "Obfuscated: \t%t\n", buildOptions.Obfuscated)
 			if buildOptions.Obfuscated {
 				_, _ = fmt.Fprintf(w, "Garble Args: \t%s\n", buildOptions.GarbleArgs)
@@ -232,7 +234,7 @@ func AddBuildSubcommand(app *clir.Cli, w io.Writer) {
 			_, _ = fmt.Fprintf(w, "Skip Frontend: \t%t\n", skipFrontend)
 			_, _ = fmt.Fprintf(w, "Compress: \t%t\n", buildOptions.Compress)
 			_, _ = fmt.Fprintf(w, "Package: \t%t\n", buildOptions.Pack)
-			_, _ = fmt.Fprintf(w, "Clean Build Dir: \t%t\n", buildOptions.CleanBuildDirectory)
+			_, _ = fmt.Fprintf(w, "Clean Bin Dir: \t%t\n", buildOptions.CleanBinDirectory)
 			_, _ = fmt.Fprintf(w, "LDFlags: \t\"%s\"\n", buildOptions.LDFlags)
 			_, _ = fmt.Fprintf(w, "Tags: \t[%s]\n", strings.Join(buildOptions.UserTags, ","))
 			_, _ = fmt.Fprintf(w, "Race Detector: \t%t\n", buildOptions.RaceDetector)
@@ -358,7 +360,7 @@ func AddBuildSubcommand(app *clir.Cli, w io.Writer) {
 				}
 
 				buildOptions.IgnoreFrontend = true
-				buildOptions.CleanBuildDirectory = false
+				buildOptions.CleanBinDirectory = false
 
 				// Output stats
 				buildOptions.Logger.Println(fmt.Sprintf("Built '%s' in %s.\n", compiledBinary, time.Since(start).Round(time.Millisecond).String()))

v2/cmd/wails/internal/commands/build/gomod.go

@@ -1,13 +1,13 @@
 package build
 
 import (
-	"os"
-	"path/filepath"
-
+	"fmt"
 	"github.com/wailsapp/wails/v2/cmd/wails/internal"
+	"github.com/wailsapp/wails/v2/internal/fs"
 	"github.com/wailsapp/wails/v2/internal/gomod"
 	"github.com/wailsapp/wails/v2/internal/goversion"
 	"github.com/wailsapp/wails/v2/pkg/clilogger"
+	"os"
 )
 
 func SyncGoMod(logger *clilogger.CLILogger, updateWailsVersion bool) error {
@@ -15,7 +15,10 @@ func SyncGoMod(logger *clilogger.CLILogger, updateWailsVersion bool) error {
 	if err != nil {
 		return err
 	}
-	gomodFilename := filepath.Join(cwd, "go.mod")
+	gomodFilename := fs.FindFileInParents(cwd, "go.mod")
+	if gomodFilename == "" {
+		return fmt.Errorf("no go.mod file found")
+	}
 	gomodData, err := os.ReadFile(gomodFilename)
 	if err != nil {
 		return err

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

@@ -93,6 +93,7 @@ type devFlags struct {
 
 	frontendDevServerURL string
 	skipFrontend         bool
+	noColour             bool
 }
 
 // AddSubcommand adds the `dev` command for the Wails application
@@ -108,6 +109,7 @@ func AddSubcommand(app *clir.Cli, w io.Writer) error {
 	command.StringFlag("reloaddirs", "Additional directories to trigger reloads (comma separated)", &flags.reloadDirs)
 	command.BoolFlag("browser", "Open application in browser", &flags.openBrowser)
 	command.BoolFlag("noreload", "Disable reload on asset change", &flags.noReload)
+	command.BoolFlag("nocolour", "Turn off colour cli output", &flags.noColour)
 	command.BoolFlag("skipbindings", "Skip bindings generation", &flags.skipBindings)
 	command.StringFlag("wailsjsdir", "Directory to generate the Wails JS modules", &flags.wailsjsdir)
 	command.StringFlag("tags", "Build tags to pass to Go compiler. Must be quoted. Space or comma (but not both) separated", &flags.tags)
@@ -123,6 +125,10 @@ func AddSubcommand(app *clir.Cli, w io.Writer) error {
 	command.BoolFlag("s", "Skips building the frontend", &flags.skipFrontend)
 
 	command.Action(func() error {
+		if flags.noColour {
+			colour.ColourEnabled = false
+		}
+
 		// Create logger
 		logger := clilogger.New(w)
 		app.PrintBanner()
@@ -160,6 +166,7 @@ func AddSubcommand(app *clir.Cli, w io.Writer) error {
 		}
 
 		buildOptions := generateBuildOptions(flags)
+		buildOptions.ProjectData = projectConfig
 		buildOptions.SkipBindings = flags.skipBindings
 		buildOptions.Logger = logger
 
@@ -208,7 +215,7 @@ func AddSubcommand(app *clir.Cli, w io.Writer) error {
 		// frontend:dev:watcher command.
 		frontendDevAutoDiscovery := projectConfig.IsFrontendDevServerURLAutoDiscovery()
 		if command := projectConfig.DevWatcherCommand; command != "" {
-			closer, devServerURL, err := runFrontendDevWatcherCommand(cwd, command, frontendDevAutoDiscovery)
+			closer, devServerURL, err := runFrontendDevWatcherCommand(projectConfig.GetFrontendDir(), command, frontendDevAutoDiscovery)
 			if err != nil {
 				return err
 			}
@@ -352,8 +359,8 @@ func generateBuildOptions(flags devFlags) *build.Options {
 
 // loadAndMergeProjectConfig reconciles flags passed to the CLI with project config settings and updates
 // the project config if necessary
-func loadAndMergeProjectConfig(cwd string, flags *devFlags) (*project.Project, error) {
-	projectConfig, err := project.Load(cwd)
+func loadAndMergeProjectConfig(projectFileDirectory string, flags *devFlags) (*project.Project, error) {
+	projectConfig, err := project.Load(projectFileDirectory)
 	if err != nil {
 		return nil, err
 	}
@@ -390,11 +397,11 @@ func loadAndMergeProjectConfig(cwd string, flags *devFlags) (*project.Project, e
 	}
 
 	if flags.wailsjsdir == "" && projectConfig.WailsJSDir != "" {
-		flags.wailsjsdir = projectConfig.WailsJSDir
+		flags.wailsjsdir = projectConfig.GetWailsJSDir()
 	}
 
 	if flags.wailsjsdir == "" {
-		flags.wailsjsdir = "./frontend"
+		flags.wailsjsdir = projectConfig.GetFrontendDir()
 	}
 
 	if flags.wailsjsdir != projectConfig.WailsJSDir {
@@ -427,15 +434,14 @@ func loadAndMergeProjectConfig(cwd string, flags *devFlags) (*project.Project, e
 }
 
 // runFrontendDevWatcherCommand will run the `frontend:dev:watcher` command if it was given, ex- `npm run dev`
-func runFrontendDevWatcherCommand(cwd string, devCommand string, discoverViteServerURL bool) (func(), string, error) {
+func runFrontendDevWatcherCommand(frontendDirectory string, devCommand string, discoverViteServerURL bool) (func(), string, error) {
 	ctx, cancel := context.WithCancel(context.Background())
 	scanner := NewStdoutScanner()
-	dir := filepath.Join(cwd, "frontend")
 	cmdSlice := strings.Split(devCommand, " ")
 	cmd := exec.CommandContext(ctx, cmdSlice[0], cmdSlice[1:]...)
 	cmd.Stderr = os.Stderr
 	cmd.Stdout = scanner
-	cmd.Dir = dir
+	cmd.Dir = frontendDirectory
 	setParentGID(cmd)
 
 	if err := cmd.Start(); err != nil {

v2/cmd/wails/internal/commands/generate/template/base/main.go.tmpl

@@ -7,6 +7,7 @@ import (
 	"github.com/wailsapp/wails/v2"
 	"github.com/wailsapp/wails/v2/pkg/logger"
 	"github.com/wailsapp/wails/v2/pkg/options"
+	"github.com/wailsapp/wails/v2/pkg/options/assetserver"
 	"github.com/wailsapp/wails/v2/pkg/options/mac"
 	"github.com/wailsapp/wails/v2/pkg/options/windows"
 )
@@ -36,7 +37,9 @@ func main() {
 		StartHidden:       false,
 		HideWindowOnClose: false,
 		BackgroundColour:  &options.RGBA{R: 255, G: 255, B: 255, A: 255},
-		Assets:            assets,
+		AssetServer:       &assetserver.Options{
+			Assets: assets,
+		},
 		Menu:              nil,
 		Logger:            nil,
 		LogLevel:          logger.DEBUG,

v2/cmd/wails/internal/commands/generate/template/base/wails.tmpl.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://wails.io/schemas/config.v2.json",
   "name": "{{.ProjectName}}",
   "outputfilename": "{{.BinaryName}}",
   "frontend:install": "npm install",

v2/cmd/wails/internal/commands/initialise/templates/generate/plain/main.go.tmpl

@@ -9,6 +9,7 @@ import (
 	"github.com/wailsapp/wails/v2"
 	"github.com/wailsapp/wails/v2/pkg/logger"
 	"github.com/wailsapp/wails/v2/pkg/options"
+	"github.com/wailsapp/wails/v2/pkg/options/assetserver"
 	"github.com/wailsapp/wails/v2/pkg/options/windows"
 )
 
@@ -37,7 +38,9 @@ func main() {
 		StartHidden:       false,
 		HideWindowOnClose: false,
 		BackgroundColour:  &options.RGBA{R: 27, G: 38, B: 54, A: 1},
-		Assets:            assets,
+		AssetServer:       &assetserver.Options{
+			Assets: assets,
+		},
 		Menu:              nil,
 		Logger:            nil,
 		LogLevel:          logger.DEBUG,

v2/cmd/wails/internal/commands/initialise/templates/templates/vue/main.tmpl.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/wailsapp/wails/v2"
 	"github.com/wailsapp/wails/v2/pkg/options"
+	"github.com/wailsapp/wails/v2/pkg/options/assetserver"
 )
 
 //go:embed all:frontend/dist
@@ -16,10 +17,12 @@ func main() {
 
 	// Create application with options
 	err := wails.Run(&options.App{
-		Title:            "{{.ProjectName}}",
-		Width:            1024,
-		Height:           768,
-		Assets:           assets,
+		Title:  "{{.ProjectName}}",
+		Width:  1024,
+		Height: 768,
+		AssetServer: &assetserver.Options{
+			Assets: assets,
+		},
 		BackgroundColour: &options.RGBA{R: 27, G: 38, B: 54, A: 1},
 		OnStartup:        app.startup,
 		Bind: []interface{}{

v2/cmd/wails/internal/version.txt

@@ -1 +1 @@
-v2.1.0
+v2.2.0

v2/examples/customlayout/.gitignore

@@ -0,0 +1,3 @@
+build/bin
+node_modules
+myfrontend/wailsjs

v2/examples/customlayout/README.md

@@ -0,0 +1,4 @@
+# README
+
+This is an example project that shows how to use a custom layout.
+Run `wails build` in the `cmd/customlayout` directory to build the project.

v2/examples/customlayout/build/README.md

@@ -0,0 +1,35 @@
+# Build Directory
+
+The build directory is used to house all the build files and assets for your application.
+
+The structure is:
+
+* bin - Output directory
+* darwin - macOS specific files
+* windows - Windows specific files
+
+## Mac
+
+The `darwin` directory holds files specific to Mac builds.
+These may be customised and used as part of the build. To return these files to the default state, simply delete them
+and
+build with `wails build`.
+
+The directory contains the following files:
+
+- `Info.plist` - the main plist file used for Mac builds. It is used when building using `wails build`.
+- `Info.dev.plist` - same as the main plist file but used when building using `wails dev`.
+
+## Windows
+
+The `windows` directory contains the manifest and rc files used when building with `wails build`.
+These may be customised for your application. To return these files to the default state, simply delete them and
+build with `wails build`.
+
+- `icon.ico` - The icon used for the application. This is used when building using `wails build`. If you wish to
+  use a different icon, simply replace this file with your own. If it is missing, a new `icon.ico` file
+  will be created using the `appicon.png` file in the build directory.
+- `installer/*` - The files used to create the Windows installer. These are used when building using `wails build`.
+- `info.json` - Application details used for Windows builds. The data here will be used by the Windows installer,
+  as well as the application itself (right click the exe -> properties -> details)
+- `wails.exe.manifest` - The main application manifest file.

v2/examples/customlayout/build/darwin/Info.dev.plist

@@ -0,0 +1,32 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundlePackageType</key>
+        <string>APPL</string>
+        <key>CFBundleName</key>
+        <string>{{.Info.ProductName}}</string>
+        <key>CFBundleExecutable</key>
+        <string>{{.Name}}</string>
+        <key>CFBundleIdentifier</key>
+        <string>com.wails.{{.Name}}</string>
+        <key>CFBundleVersion</key>
+        <string>{{.Info.ProductVersion}}</string>
+        <key>CFBundleGetInfoString</key>
+        <string>{{.Info.Comments}}</string>
+        <key>CFBundleShortVersionString</key>
+        <string>{{.Info.ProductVersion}}</string>
+        <key>CFBundleIconFile</key>
+        <string>iconfile</string>
+        <key>LSMinimumSystemVersion</key>
+        <string>10.13.0</string>
+        <key>NSHighResolutionCapable</key>
+        <string>true</string>
+        <key>NSHumanReadableCopyright</key>
+        <string>{{.Info.Copyright}}</string>
+        <key>NSAppTransportSecurity</key>
+        <dict>
+            <key>NSAllowsLocalNetworking</key>
+            <true/>
+        </dict>
+    </dict>
+</plist>

v2/examples/customlayout/build/darwin/Info.plist

@@ -0,0 +1,27 @@
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundlePackageType</key>
+        <string>APPL</string>
+        <key>CFBundleName</key>
+        <string>{{.Info.ProductName}}</string>
+        <key>CFBundleExecutable</key>
+        <string>{{.Name}}</string>
+        <key>CFBundleIdentifier</key>
+        <string>com.wails.{{.Name}}</string>
+        <key>CFBundleVersion</key>
+        <string>{{.Info.ProductVersion}}</string>
+        <key>CFBundleGetInfoString</key>
+        <string>{{.Info.Comments}}</string>
+        <key>CFBundleShortVersionString</key>
+        <string>{{.Info.ProductVersion}}</string>
+        <key>CFBundleIconFile</key>
+        <string>iconfile</string>
+        <key>LSMinimumSystemVersion</key>
+        <string>10.13.0</string>
+        <key>NSHighResolutionCapable</key>
+        <string>true</string>
+        <key>NSHumanReadableCopyright</key>
+        <string>{{.Info.Copyright}}</string>
+    </dict>
+</plist>