[v2] Add wails generate template command

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

@@ -2,7 +2,8 @@ package generate
 
 import (
 	"io"
-	"time"
+
+	"github.com/wailsapp/wails/v2/cmd/wails/internal/commands/generate/template"
 
 	"github.com/leaanthony/clir"
 	"github.com/wailsapp/wails/v2/pkg/clilogger"
@@ -14,50 +15,9 @@ func AddSubcommand(app *clir.Cli, w io.Writer) error {
 
 	command := app.NewSubCommand("generate", "Code Generation Tools")
 
-	// Backend API
-	backendAPI := command.NewSubCommand("module", "Generates a JS module for the frontend to interface with the backend")
+	AddModuleCommand(app, command, w)
+	template.AddSubCommand(app, command, w)
 
-	// Quiet Init
-	quiet := false
-	backendAPI.BoolFlag("q", "Suppress output to console", &quiet)
-
-	backendAPI.Action(func() error {
-
-		// Create logger
-		logger := clilogger.New(w)
-		logger.Mute(quiet)
-
-		app.PrintBanner()
-
-		logger.Print("Generating Javascript module for Go code...")
-
-		// Start Time
-		start := time.Now()
-
-		p, err := parser.GenerateWailsFrontendPackage()
-		if err != nil {
-			return err
-		}
-
-		logger.Println("done.")
-		logger.Println("")
-
-		elapsed := time.Since(start)
-		packages := p.Packages
-
-		// Print report
-		for _, pkg := range p.Packages {
-			if pkg.ShouldGenerate() {
-				logPackage(pkg, logger)
-			}
-
-		}
-
-		logger.Println("%d packages parsed in %s.", len(packages), elapsed)
-
-		return nil
-
-	})
 	return nil
 }
 

v2/cmd/wails/internal/commands/generate/module.go

@@ -0,0 +1,58 @@
+package generate
+
+import (
+	"io"
+	"time"
+
+	"github.com/leaanthony/clir"
+	"github.com/wailsapp/wails/v2/pkg/clilogger"
+	"github.com/wailsapp/wails/v2/pkg/parser"
+)
+
+func AddModuleCommand(app *clir.Cli, parent *clir.Command, w io.Writer) {
+
+	// Backend API
+	backendAPI := parent.NewSubCommand("module", "Generates a JS module for the frontend to interface with the backend")
+
+	// Quiet Init
+	quiet := false
+	backendAPI.BoolFlag("q", "Suppress output to console", &quiet)
+
+	backendAPI.Action(func() error {
+
+		// Create logger
+		logger := clilogger.New(w)
+		logger.Mute(quiet)
+
+		app.PrintBanner()
+
+		logger.Print("Generating Javascript module for Go code...")
+
+		// Start Time
+		start := time.Now()
+
+		p, err := parser.GenerateWailsFrontendPackage()
+		if err != nil {
+			return err
+		}
+
+		logger.Println("done.")
+		logger.Println("")
+
+		elapsed := time.Since(start)
+		packages := p.Packages
+
+		// Print report
+		for _, pkg := range p.Packages {
+			if pkg.ShouldGenerate() {
+				logPackage(pkg, logger)
+			}
+
+		}
+
+		logger.Println("%d packages parsed in %s.", len(packages), elapsed)
+
+		return nil
+
+	})
+}

v2/cmd/wails/internal/commands/generate/template/base/NEXTSTEPS.md

@@ -0,0 +1,26 @@
+# Next Steps
+
+Congratulations on generating your template!
+
+## Completing your template
+
+The next steps to complete the template are:
+
+  1. Complete the fields in the `template.json` file. 
+  2. Update `README.md`.
+  3. Edit `wails.tmpl.json` and ensure all fields are correct, especially:
+     - `html` - path to your `index.html`
+     - `frontend:install` - The command to install your frontend dependencies
+     - `frontend:build` - The command to build your frontend
+  4. Delete this file.
+
+## Testing your template
+
+You can test your template by running this command:
+
+`wails init -name test -template /path/to/template`
+
+### Checklist 
+Once generated, do the following tests:
+  - Change into the new project directory and run `wails build`. A working binary should be generated in the `build/bin` project directory.
+  - Run `wails dev`. This will compile your backend and run it. You should be able to go into the frontend directory and run `npm run dev` (or whatever your dev command is) and this should run correctly. You should be able to then open a browser to your local dev server and the application should work.

v2/cmd/wails/internal/commands/generate/template/base/README.md

@@ -0,0 +1,16 @@
+# README
+
+## About
+
+About your template
+
+## Building 
+
+To build this project in debug mode, use `wails build`. For production, use `wails build -production`.
+To generate a platform native package, add the `-package` flag.
+
+## Live Development
+
+To run in live development mode, run `wails dev` in the project directory. In another terminal, go into the `frontend` 
+directory and run `npm run dev`. The frontend dev server will run on http://localhost:5000. Connect to this
+in your browser and connect to your application. 

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

@@ -0,0 +1,34 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/wailsapp/wails/v2"
+)
+
+// Basic application struct
+type Basic struct {
+	runtime *wails.Runtime
+}
+
+// NewBasic creates a new Basic application struct
+func NewBasic() *Basic {
+	return &Basic{}
+}
+
+// startup is called at application startup
+func (b *Basic) startup(runtime *wails.Runtime) {
+	// Perform your setup here
+	b.runtime = runtime
+	runtime.Window.SetTitle("{{.ProjectName}}")
+}
+
+// shutdown is called at application termination
+func (b *Basic) shutdown() {
+	// Perform your teardown here
+}
+
+// Greet returns a greeting for the given name
+func (b *Basic) Greet(name string) string {
+	return fmt.Sprintf("Hello %s!", name)
+}

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

@@ -0,0 +1,27 @@
+{
+  "name": "vanilla",
+  "version": "1.0.0",
+  "description": "Vanilla Wails v2 template",
+  "main": "src/main.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "start": "sirv dist"
+  },
+  "author": "{{.AuthorName}}",
+  "license": "ISC",
+  "dependencies": {
+    "@rollup/plugin-commonjs": "^19.0.0",
+    "@rollup/plugin-image": "^2.0.6",
+    "@rollup/plugin-node-resolve": "^13.0.0",
+    "@rollup/plugin-url": "^6.0.0",
+    "@wails/runtime": "^1.3.20",
+    "rollup": "^2.50.4",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-livereload": "^2.0.0",
+    "rollup-plugin-postcss": "^4.0.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "sirv-cli": "^1.0.12"
+  }
+}

v2/cmd/wails/internal/commands/generate/template/base/frontend/rollup.config.js

@@ -0,0 +1,103 @@
+import resolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import livereload from 'rollup-plugin-livereload';
+import { terser } from 'rollup-plugin-terser';
+import postcss from 'rollup-plugin-postcss';
+import image from '@rollup/plugin-image';
+import url from '@rollup/plugin-url';
+import copy from 'rollup-plugin-copy';
+
+const production = !process.env.ROLLUP_WATCH;
+
+export default {
+    input: 'src/main.js',
+    output: {
+        sourcemap: true,
+        format: 'iife',
+        name: 'app',
+        file: 'dist/main.js'
+    },
+    onwarn: handleRollupWarning,
+    plugins: [
+
+        image(),
+
+        copy({
+            targets: [
+                { src: 'src/index.html', dest: 'dist' },
+                { src: 'src/main.css', dest: 'dist' },
+            ]
+        }),
+
+        // Embed binary files
+        url({
+            include: ['**/*.woff', '**/*.woff2'],
+            limit: Infinity,
+        }),
+
+        // If you have external dependencies installed from
+        // npm, you'll most likely need these plugins. In
+        // some cases you'll need additional configuration -
+        // consult the documentation for details:
+        // https://github.com/rollup/plugins/tree/master/packages/commonjs
+        resolve({
+            browser: true,
+        }),
+        commonjs(),
+
+        // PostCSS preprocessing
+        postcss({
+            extensions: ['.css', '.scss'],
+            extract: true,
+            minimize: false,
+            use: [
+                ['sass', {
+                    includePaths: [
+                        './src',
+                        './node_modules'
+                    ]
+                }]
+            ],
+        }),
+
+        // In dev mode, call `npm run start` once
+        // the bundle has been generated
+        !production && serve(),
+
+        // Watch the `public` directory and refresh the
+        // browser on changes when not in production
+        !production && livereload('dist'),
+
+        // If we're building for production (npm run build
+        // instead of npm run dev), minify
+        production && terser()
+    ],
+    watch: {
+        clearScreen: false
+    }
+};
+
+function handleRollupWarning(warning) {
+    console.error('ERROR: ' + warning.toString());
+}
+
+function serve() {
+    let server;
+
+    function toExit() {
+        if (server) server.kill(0);
+    }
+
+    return {
+        writeBundle() {
+            if (server) return;
+            server = require('child_process').spawn('npm', ['run', 'start', '--', '--dev'], {
+                stdio: ['ignore', 'inherit', 'inherit'],
+                shell: true
+            });
+
+            process.on('SIGTERM', toExit);
+            process.on('exit', toExit);
+        }
+    };
+}

v2/cmd/wails/internal/commands/generate/template/base/frontend/src/index.html

@@ -0,0 +1,18 @@
+<html>
+
+<head>
+  <link rel="stylesheet" href="/main.css">
+</head>
+
+<body data-wails-drag>
+  <div id="logo"></div>
+  <div id="input" data-wails-no-drag>
+    <input id="name" type="text">
+    <button onclick="greet()">Greet</button>
+  </div>
+  <div id="result"></div>
+
+  <script src="/main.js"></script>
+</body>
+
+</html>

v2/cmd/wails/internal/commands/generate/template/base/frontend/src/main.js

@@ -0,0 +1,21 @@
+
+import {ready} from '@wails/runtime';
+
+ready( () => {
+  // Get input + focus
+  let nameElement = document.getElementById("name");
+  nameElement.focus();
+
+  // Setup the greet function
+  window.greet = function () {
+
+    // Get name
+    let name = nameElement.value;
+
+    // Call Basic.Greet(name)
+    window.backend.main.Basic.Greet(name).then((result) => {
+      // Update result with data back from Basic.Greet()
+      document.getElementById("result").innerText = result;
+    });
+  };
+});

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

@@ -0,0 +1,9 @@
+module test
+
+go 1.16
+
+require (
+	github.com/wailsapp/wails/v2 v2.0.0-alpha
+)
+
+replace github.com/wailsapp/wails/v2 v2.0.0-alpha => {{.WailsDirectory}}

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

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"log"
+
+	"github.com/wailsapp/wails/v2/pkg/options/windows"
+
+	"github.com/wailsapp/wails/v2"
+	"github.com/wailsapp/wails/v2/pkg/logger"
+	"github.com/wailsapp/wails/v2/pkg/menu"
+	"github.com/wailsapp/wails/v2/pkg/options"
+	"github.com/wailsapp/wails/v2/pkg/options/mac"
+)
+
+func main() {
+
+	// Create application with options
+	app := NewBasic()
+
+	err := wails.Run(&options.App{
+		Title:             "{{.ProjectName}}",
+		Width:             800,
+		Height:            600,
+		MinWidth:          400,
+		MinHeight:         400,
+		MaxWidth:          1280,
+		MaxHeight:         1024,
+		DisableResize:     false,
+		Fullscreen:        false,
+		Frameless:         false,
+		StartHidden:       false,
+		HideWindowOnClose: false,
+		DevTools:          false,
+		RGBA:              0x000000FF,
+		Windows: &windows.Options{
+			WebviewIsTransparent:          true,
+			WindowBackgroundIsTranslucent: true,
+			DisableWindowIcon:             true,
+		},
+		Mac: &mac.Options{
+			WebviewIsTransparent:          true,
+			WindowBackgroundIsTranslucent: true,
+			TitleBar:                      mac.TitleBarHiddenInset(),
+			Menu:                          menu.DefaultMacMenu(),
+		},
+		LogLevel: logger.DEBUG,
+		Startup:  app.startup,
+		Shutdown: app.shutdown,
+		Bind: []interface{}{
+			app,
+		},
+	})
+	if err != nil {
+		log.Fatal(err)
+	}
+}

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

@@ -0,0 +1,7 @@
+{
+  "name": "Long name",
+  "shortname": "{{.Name}}",
+  "author": "",
+  "description": "Description of the template",
+  "helpurl": "URL for help with the template, eg homepage"
+}

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

@@ -0,0 +1,11 @@
+{
+    "name": "{{.ProjectName}}",
+    "outputfilename": "{{.BinaryName}}",
+    "html": "frontend/dist/index.html",
+    "frontend:build": "npm run build",
+    "frontend:install": "npm ci",
+    "author": {
+        "name": "{{.AuthorName}}",
+        "email": "{{.AuthorEmail}}"
+    }
+}

v2/cmd/wails/internal/commands/generate/template/template.go

@@ -0,0 +1,131 @@
+package template
+
+import (
+	"embed"
+	"io"
+	"os"
+	"path/filepath"
+
+	"github.com/leaanthony/debme"
+
+	"github.com/leaanthony/gosod"
+	"github.com/wailsapp/wails/v2/internal/fs"
+
+	"github.com/leaanthony/clir"
+)
+
+//go:embed base
+var base embed.FS
+
+func AddSubCommand(app *clir.Cli, parent *clir.Command, w io.Writer) {
+
+	// command
+	command := parent.NewSubCommand("template", "Generates a wails template")
+
+	name := ""
+	command.StringFlag("name", "The name of the template", &name)
+
+	useLocalFilesAsFrontend := false
+	command.BoolFlag("frontend", "This indicates that the current directory is a frontend project and should be used by the template", &useLocalFilesAsFrontend)
+
+	// Quiet Init
+	quiet := false
+	command.BoolFlag("q", "Suppress output to console", &quiet)
+
+	command.Action(func() error {
+
+		// If the current directory is not empty, we create a new directory
+		cwd, err := os.Getwd()
+		if err != nil {
+			return err
+		}
+		templateDir := cwd
+		empty, err := fs.DirIsEmpty(templateDir)
+		if err != nil {
+			return err
+		}
+		if !empty {
+			templateDir = filepath.Join(cwd, name)
+			err = fs.Mkdir(templateDir)
+			if err != nil {
+				return err
+			}
+		}
+
+		// Create base template
+		baseTemplate, err := debme.FS(base, "base")
+		if err != nil {
+			return err
+		}
+		g := gosod.New(baseTemplate)
+		g.SetTemplateFilters([]string{".template"})
+
+		err = os.Chdir(templateDir)
+		if err != nil {
+			return err
+		}
+
+		type templateData struct {
+			Name        string
+			Description string
+		}
+
+		err = g.Extract(templateDir, &templateData{
+			Name: name,
+		})
+		if err != nil {
+			return err
+		}
+
+		if useLocalFilesAsFrontend == false {
+			return nil
+		}
+
+		// Remove frontend directory
+		frontendDir := filepath.Join(templateDir, "frontend")
+		err = os.RemoveAll(frontendDir)
+		if err != nil {
+			return err
+		}
+
+		err = fs.CopyDirExtended(cwd, frontendDir, []string{name})
+		if err != nil {
+			return err
+		}
+
+		//// Create logger
+		//logger := clilogger.New(w)
+		//logger.Mute(quiet)
+		//
+		//app.PrintBanner()
+		//
+		//logger.Print("Generating Javascript module for Go code...")
+		//
+		//// Start Time
+		//start := time.Now()
+		//
+		//p, err := parser.GenerateWailsFrontendPackage()
+		//if err != nil {
+		//	return err
+		//}
+		//
+		//logger.Println("done.")
+		//logger.Println("")
+		//
+		//elapsed := time.Since(start)
+		//packages := p.Packages
+		//
+		//// Print report
+		//for _, pkg := range p.Packages {
+		//	if pkg.ShouldGenerate() {
+		//		generate.logPackage(pkg, logger)
+		//	}
+		//
+		//}
+		//
+		//logger.Println("%d packages parsed in %s.", len(packages), elapsed)
+
+		return nil
+
+	})
+}