wails/v3/internal/flags/bindings.go
Ian VanSchooten bbd5d99667
[v3] Typed Events, revisited (#4633)
* Add strong event typings

* Make `EmitEvent` take one data argument only

* Add event registration logic

* Report event cancellation to the emitter

* Prevent registration of system events

* Add support for typed event data initialisation

* Binding generation for events

* Tests for event bindings

* Add vite plugin for typed events

* Fix dev command execution order

Co-authored-by: Fabio Massaioli <fabio.massaioli@gmail.com>

* Propagate module path to templates

* Update templates

Co-authored-by: Ian VanSchooten <ian.vanschooten@gmail.com>

* Go mod tidy for examples

* Switch to tsconfig.json for jetbrains IDE support

* Replace jsconfig in example

* Convert vite plugin to typescript

* Downgrade vite for now

The templates all use 5.x

* Remove root plugins dir from npm files

It's now '/dist/plugins'

* Include types for Create

But keep out of the docs

* Assign a type for cancelAll results

* Restore variadic argument in EmitEvent methods

* Support registered events with void data

* Test cases for void alias support

* Support strict mode

* Support custom event hooks

* Update docs

* Update changelog

* Testdata for typed events

* Test data for void alias support

* fix webview_window emit event

* Update changelog.mdx

* Update events

* Fix generator test path normalization for cross-platform compatibility

The generator tests were failing on CI because they compared absolute file paths
in warning messages. These paths differ between development machines and CI environments.

Changes:
- Normalize file paths in warnings to be relative to testcases/ directory
- Handle both Unix and Windows path separators
- Use Unix line endings consistently in test output
- Update all test expectation files to use normalized paths

This ensures tests pass consistently across different environments including
Windows, macOS, Linux, and CI systems.

* Remove stale comment

* Handle errors returned from validation

* Restore variadic argument to Emit (fix bad rebase)

* Event emitters return a boolean

* Don't use `EmitEvent` in docs

Supposedly it's for internal use, according to comment

* Fix event docs (from rebase)

* Ensure all templates specify @wailsio/runtime: "latest"

* Fix Windows test failure due to CRLF line endings

The test was failing on Windows because:
1. Hardcoded "\n" was being used instead of render.Newline when writing
   warning logs, causing CRLF vs LF mismatch
2. The render package import was missing
3. .got.log files weren't being skipped when building expected file list

Changes:
- Add render package import
- Use render.Newline instead of hardcoded "\n" for cross-platform compatibility
- Skip .got.log files in test file walker

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Fix template tests by using local runtime package

The template tests were failing because they were installing @wailsio/runtime@latest from npm, which doesn't have the new vite plugin yet. This change packs the local runtime and uses it in template tests instead.

Changes:
- Pack the runtime to a tarball in test_js job
- Upload the runtime package as an artifact
- Download and install the local runtime in template tests before building
- Update cleanup job to delete the runtime package artifact

* Apply suggestion from @leaanthony

* Fix: Install local runtime in frontend directory with correct path

The previous fix wasn't working because:
1. npm install was run in the project root, not in frontend/
2. wails3 build runs npm install again, which would reinstall from npm

Fixed by:
- Using npm pkg set to modify package.json to use file:// protocol
- This ensures subsequent npm install calls use the local tarball

* Fix Vue template syntax conflicts with Go template delimiters

The Vue templates were converted to .tmpl files to support dynamic module
paths, but Vue's template syntax {{ }} conflicts with Go's template syntax.

Fixed by escaping Vue template braces:
- {{ becomes {{"{{"}}
- }} becomes {{"}}"}}

This allows the Go template engine to output the literal {{ }} for Vue to process.

* Fix Vue template escaping and Windows shell compatibility

Two issues fixed:

1. Vue template escaping: Changed from {{"{{"}} to {{ "{{" }}
   - The previous syntax caused "missing value for command" error
   - Correct Go template syntax uses spaces between delimiters and strings

2. Windows PowerShell compatibility: Added 'shell: bash' to template generation step
   - The bash syntax (ls, head, $()) doesn't work in PowerShell
   - Git Bash is available on all GitHub runners including Windows

* Fix: test_templates depends on test_js for runtime package artifact

The runtime-package artifact is created in test_js job, not test_go.
Added test_js to the needs array so the artifact is available for download.

* Fix Windows path compatibility for runtime package artifact

Changed from absolute Unix path '/tmp/wails-runtime' to relative path
'wails-runtime-temp' which works cross-platform. Using realpath to
convert to absolute path for file:// URL in npm pkg set command.

* Fix realpath issue on Windows for runtime package

realpath on Windows Git Bash was producing malformed paths with duplicate
drive letters (D:\d\a\...). Replaced with portable solution using pwd
that works correctly across all platforms.

* Use pwd -W on Windows to get native Windows paths

Git Bash's pwd returns Unix-style paths (/d/a/wails/wails) which npm
then incorrectly resolves as D:/d/a/wails/wails. Using pwd -W returns
native Windows paths (D:\a\wails\wails) that npm can handle correctly.

This is the root cause of all the Windows path issues.

* Improve typechecking for Events.Emit()

* [docs] Clarify where `Events` is imported from in each example

* Add docs for runtime Events.Emit()

* Revert to v2-style Events.Emit (name, data)

* Update changelog

---------

Co-authored-by: Fabio Massaioli <fabio.massaioli@gmail.com>
Co-authored-by: Atterpac <Capretta.Michael@gmail.com>
Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
2025-11-11 20:25:57 +11:00

97 lines
3.5 KiB
Go

package flags
import (
"errors"
"slices"
"strings"
"unicode/utf8"
)
type GenerateBindingsOptions struct {
BuildFlagsString string `name:"f" description:"A list of additional space-separated Go build flags. Flags (or parts of them) can be wrapped in single or double quotes to include spaces"`
OutputDirectory string `name:"d" description:"The output directory" default:"frontend/bindings"`
ModelsFilename string `name:"models" description:"File name for exported JS/TS models (excluding the extension)" default:"models"`
IndexFilename string `name:"index" description:"File name for JS/TS package indexes (excluding the extension)" default:"index"`
TS bool `name:"ts" description:"Generate Typescript bindings"`
UseInterfaces bool `name:"i" description:"Generate Typescript interfaces instead of classes"`
UseBundledRuntime bool `name:"b" description:"Use the bundled runtime instead of importing the npm package"`
UseNames bool `name:"names" description:"Use names instead of IDs for the binding calls"`
NoEvents bool `name:"noevents" description:"Do not generate types for registered custom events"`
NoIndex bool `name:"noindex" description:"Do not generate JS/TS index files"`
DryRun bool `name:"dry" description:"Do not write output files"`
Silent bool `name:"silent" description:"Silent mode"`
Verbose bool `name:"v" description:"Enable debug output"`
Clean bool `name:"clean" description:"Clean output directory before generation" default:"true"`
}
var ErrUnmatchedQuote = errors.New("build flags contain an unmatched quote")
func isWhitespace(r rune) bool {
// We use Go's definition of whitespace instead of the Unicode ones
return r == ' ' || r == '\t' || r == '\r' || r == '\n'
}
func isNonWhitespace(r rune) bool {
return !isWhitespace(r)
}
func isQuote(r rune) bool {
return r == '\'' || r == '"'
}
func isQuoteOrWhitespace(r rune) bool {
return isQuote(r) || isWhitespace(r)
}
func (options *GenerateBindingsOptions) BuildFlags() (flags []string, err error) {
str := options.BuildFlagsString
// temporary buffer for flag assembly
flag := make([]byte, 0, 32)
for start := strings.IndexFunc(str, isNonWhitespace); start >= 0; start = strings.IndexFunc(str, isNonWhitespace) {
// each iteration starts at the beginning of a flag
// skip initial whitespace
str = str[start:]
// iterate over all quoted and unquoted parts of the flag and join them
for {
breakpoint := strings.IndexFunc(str, isQuoteOrWhitespace)
if breakpoint < 0 {
breakpoint = len(str)
}
// append everything up to the breakpoint
flag = append(flag, str[:breakpoint]...)
str = str[breakpoint:]
quote, quoteSize := utf8.DecodeRuneInString(str)
if !isQuote(quote) {
// if the breakpoint is not a quote, we reached the end of the flag
break
}
// otherwise, look for the closing quote
str = str[quoteSize:]
closingQuote := strings.IndexRune(str, quote)
// closing quote not found, append everything to the last flag and raise an error
if closingQuote < 0 {
flag = append(flag, str...)
str = ""
err = ErrUnmatchedQuote
break
}
// closing quote found, append quoted content to the flag and restart after the quote
flag = append(flag, str[:closingQuote]...)
str = str[closingQuote+quoteSize:]
}
// append a clone of the flag to the result, then reuse buffer space
flags = append(flags, string(slices.Clone(flag)))
flag = flag[:0]
}
return
}