Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add possible options in terms of choosing the ide either vscode or goland #3415

Merged
merged 1 commit into from Apr 22, 2024
Merged

docs: add possible options in terms of choosing the ide either vscode or goland #3415

merged 1 commit into from Apr 22, 2024

Conversation

DiegPS
Copy link
Contributor

@DiegPS DiegPS commented Apr 21, 2024 •
edited by coderabbitai bot

Description

Add possible options in terms of choosing the "ide" either "visual studio code" or "goland", in CLI section.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

Summary by CodeRabbit

  • Documentation
    • Updated the CLI reference to include options for generating IDE project files specifically for vscode or goland.

@DiegPS
Update cli.mdx
1086cbf 
add possible options in terms of choosing the "ide" either "visual studio code" or "goland"
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 21, 2024 •
edited

Walkthrough

The recent update introduces enhanced customization for generating IDE project files. Users can now specify their preferred development environment, choosing between Visual Studio Code and GoLand, enhancing the flexibility and usability of the tool.

Changes

File Path Change Summary
.../version-v2.8.1/.../cli.mdx Added options to specify IDE (vscode or goland) for project files.

🌟🐇✨
In the land of code and bytes,
A small change shines so bright.
Choose thy tool, vscode or goland,
On fields of IDEs, take your stand!
🎉🐰💻

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2fe2007 and 1086cbf.
Files selected for processing (1)
  • website/versioned_docs/version-v2.8.1/reference/cli.mdx (1 hunks)
Additional Context Used
LanguageTool (329)
website/versioned_docs/version-v2.8.1/reference/cli.mdx (329)

Near line 11: Possible spelling mistake found.
Context: ...ing way: wails <command> <flags> ## init wails init is used for generating pr...

Near line 13: This sentence does not start with an uppercase letter.
Context: ...ommand> ## init wails init` is used for generating projects. | Flag ...

Near line 15: Possible typo: you repeated a whitespace
Context: ...is used for generating projects. | Flag | Description ...

Near line 15: Possible typo: you repeated a whitespace
Context: ...cts. | Flag | Description | Default | | :-------------...

Near line 15: Possible typo: you repeated a whitespace
Context: ... | Default | | :----------------- | :...

Near line 15: Possible typo: you repeated a whitespace
Context: ... | Default | | :----------------- | :--------------...

Near line 17: Possible typo: you repeated a whitespace
Context: ...-----------------: | | -n "project name" | Name of the project. Mandatory. ...

Near line 17: Possible typo: you repeated a whitespace
Context: ... | Name of the project. Mandatory. | | | -d "project di...

Near line 17: Possible typo: you repeated a whitespace
Context: ... | | | -d "project dir" | Project directo...

Near line 18: Possible spelling mistake found.
Context: ... | | | -d "project dir" | Project directory to create ...

Near line 18: Possible typo: you repeated a whitespace
Context: ... | | -d "project dir" | Project directory to create ...

Near line 18: Possible typo: you repeated a whitespace
Context: ...ect dir" | Project directory to create | Name of the project | | -g ...

Near line 19: Possible typo: you repeated a whitespace
Context: ... | Name of the project | | -g | Initialise git repository ...

Near line 19: Possible spelling mistake. ‘Initialise’ is British English.
Context: ...of the project | | -g | Initialise git repository ...

Near line 19: Possible typo: you repeated a whitespace
Context: ... | Initialise git repository | | | -l ...

Near line 19: Possible typo: you repeated a whitespace
Context: ... | | | -l | List available ...

Near line 20: Possible typo: you repeated a whitespace
Context: ... | | | -l | List available project templates ...

Near line 20: Possible typo: you repeated a whitespace
Context: ... | List available project templates | | | -q ...

Near line 20: Possible typo: you repeated a whitespace
Context: ... | | | -q | Suppress output...

Near line 21: Possible typo: you repeated a whitespace
Context: ... | | | -q | Suppress output to console ...

Near line 21: Possible typo: you repeated a whitespace
Context: ... | Suppress output to console | | | -t "template n...

Near line 21: Possible typo: you repeated a whitespace
Context: ... | | | -t "template name" | The project tem...

Near line 22: The official name of this software platform is spelled with a capital “H”.
Context: ...or a URL to a remote template hosted on github. | vanilla | | -ide ...

Near line 22: Possible typo: you repeated a whitespace
Context: ...to a remote template hosted on github. | vanilla | | -ide | G...

Near line 22: Possible typo: you repeated a whitespace
Context: ...mplate hosted on github. | vanilla | | -ide | Generate IDE pr...

Near line 23: Possible spelling mistake found.
Context: ...d on github. | vanilla | | -ide | Generate IDE project fi...

Near line 23: Possible typo: you repeated a whitespace
Context: ...n github. | vanilla | | -ide | Generate IDE project files vscode or...

Near line 23: Possible spelling mistake found.
Context: ... | Generate IDE project files vscode or goland ...

Near line 23: Possible spelling mistake found.
Context: ... Generate IDE project files vscode or goland ...

Near line 23: Possible typo: you repeated a whitespace
Context: ...e IDE project files vscode or goland | | | -f ...

Near line 23: Possible typo: you repeated a whitespace
Context: ... | | | -f | Force build app...

Near line 24: Possible typo: you repeated a whitespace
Context: ... | | | -f | Force build application ...

Near line 24: Possible typo: you repeated a whitespace
Context: ... | Force build application | false | Example: `wails...

Near line 24: Possible typo: you repeated a whitespace
Context: ... | false | Example: `wails init -n ...

Near line 24: Possible typo: you repeated a whitespace
Context: ... | false | Example: `wails init -n test -d mytes...

Near line 29: Possible typo: you repeated a word
Context: ... -g -ide vscode -q` This will generate a a project called "test" in the "mytestpro...

Near line 29: Possible spelling mistake found.
Context: ...erate a a project called "test" in the "mytestproject" directory, initialise git, generate vs...

Near line 29: Possible spelling mistake. ‘initialise’ is British English.
Context: ...test" in the "mytestproject" directory, initialise git, generate vscode project files and ...

Near line 30: Possible spelling mistake found.
Context: ...ct" directory, initialise git, generate vscode project files and do so silently. More...

Near line 32: Possible spelling mistake found.
Context: ...using IDEs with Wails can be found here. ### Remote Templates Remote templat...

Near line 41: Unpaired symbol: ‘]’ seems to be missing
Context: ...unity maintained templates can be found here :::wa...

Near line 47: Possible spelling mistake found.
Context: ...ou are unsure about a template, inspect package.json and wails.json for what scripts are ...

Near line 47: Possible spelling mistake found.
Context: ... a template, inspect package.json and wails.json for what scripts are run and what pack...

Near line 53: This sentence does not start with an uppercase letter.
Context: ...nstalled. ::: ## build wails build is used for compiling your project to a pr...

Near line 55: Possible typo: you repeated a whitespace
Context: ...ct to a production-ready binary. | Flag | Description ...

Near line 55: Possible typo: you repeated a whitespace
Context: ...y. | Flag | Description | Default ...

Near line 55: Possible typo: you repeated a whitespace
Context: ... | Default | |:---------------------|:-------------...

Near line 57: Possible typo: you repeated a whitespace
Context: ...------------------------------| | -clean | Cleans the build/bin directory ...

Near line 57: Possible typo: you repeated a whitespace
Context: ... | Cleans the build/bin directory | ...

Near line 57: Possible typo: you repeated a whitespace
Context: ... | | | -compiler "compiler" | Use a differe...

Near line 58: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...| Use a different go compiler to build, eg go1.15beta1 ...

Near line 58: Possible typo: you repeated a whitespace
Context: ...ent go compiler to build, eg go1.15beta1 | go ...

Near line 58: Possible typo: you repeated a whitespace
Context: ... | go | | -debug | Retains debug...

Near line 59: Possible typo: you repeated a whitespace
Context: ... | | -debug | Retains debug information in the appli...

Near line 59: Possible spelling mistake found.
Context: ...he debug console. Allows the use of the devtools in the application window ...

Near line 59: Possible typo: you repeated a whitespace
Context: ...f the devtools in the application window | ...

Near line 59: Possible typo: you repeated a whitespace
Context: ... | | | -devtools | Allows the us...

Near line 60: Possible spelling mistake found.
Context: ... | | -devtools | Allows the use of the devt...

Near line 60: Possible typo: you repeated a whitespace
Context: ... | | -devtools | Allows the use of the devtools in the ...

Near line 60: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ... | | -devtools | Allows the use of the devtools in the applicat...

Near line 60: Possible spelling mistake found.
Context: ...ools | Allows the use of the devtools in the application window in production...

Near line 60: Possible spelling mistake found.
Context: ...l/Cmd+Shift+F12 may be used to open the devtools window. NOTE: This option will make y...

Near line 60: If you mean the Apple digital distribution platform, use “App Store”. For Amazon, use “Amazon Appstore”.
Context: ...ion will make your application FAIL Mac appstore guidelines. Use for debugging only. | ...

Near line 60: Possible typo: you repeated a whitespace
Context: ...re guidelines. Use for debugging only. | | | -dryrun | Prints the bu...

Near line 61: Possible spelling mistake found.
Context: ... | | -dryrun | Prints the build command...

Near line 61: Possible typo: you repeated a whitespace
Context: ... | | -dryrun | Prints the build command without execu...

Near line 61: Possible typo: you repeated a whitespace
Context: ...s the build command without executing it | ...

Near line 61: Possible typo: you repeated a whitespace
Context: ... | | | -f | Force build a...

Near line 62: Possible typo: you repeated a whitespace
Context: ... | | -f | Force build application ...

Near line 62: Possible typo: you repeated a whitespace
Context: ... | Force build application | ...

Near line 62: Possible typo: you repeated a whitespace
Context: ... | | | -garbleargs | Arguments to ...

Near line 63: Possible spelling mistake found.
Context: ... | | -garbleargs | Arguments to pass to garble ...

Near line 63: Possible typo: you repeated a whitespace
Context: ... | | -garbleargs | Arguments to pass to garble ...

Near line 63: Possible typo: you repeated a whitespace
Context: ...s | Arguments to pass to garble | -literals -tiny -seed=random ...

Near line 63: Possible typo: you repeated a whitespace
Context: ... | -literals -tiny -seed=random | | -ldflags "flags" | Additional ld...

Near line 64: Possible spelling mistake found.
Context: ... | | -ldflags "flags" | Additional ldflags to pas...

Near line 64: Possible typo: you repeated a whitespace
Context: ... | | -ldflags "flags" | Additional ldflags to pass to the comp...

Near line 64: Possible spelling mistake found.
Context: ... | | -ldflags "flags" | Additional ldflags to pass to the compiler ...

Near line 64: Possible typo: you repeated a whitespace
Context: ...ditional ldflags to pass to the compiler | ...

Near line 64: Possible typo: you repeated a whitespace
Context: ... | | | -m | Skip mod tidy...

Near line 65: Possible typo: you repeated a whitespace
Context: ... | | -m | Skip mod tidy before compile ...

Near line 65: Possible typo: you repeated a whitespace
Context: ... | Skip mod tidy before compile | ...

Near line 65: Possible typo: you repeated a whitespace
Context: ... | | | -nopackage | Do not packag...

Near line 66: Possible spelling mistake found.
Context: ... | | -nopackage | Do not package application ...

Near line 66: Possible typo: you repeated a whitespace
Context: ... | | -nopackage | Do not package application ...

Near line 66: Possible typo: you repeated a whitespace
Context: ...e | Do not package application | ...

Near line 66: Possible typo: you repeated a whitespace
Context: ... | | | -nocolour | Disable colou...

Near line 67: Possible spelling mistake found.
Context: ... | | -nocolour | Disable colour in output ...

Near line 67: Possible typo: you repeated a whitespace
Context: ... | | -nocolour | Disable colour in output ...

Near line 67: Possible spelling mistake. ‘colour’ is British English.
Context: ... | | -nocolour | Disable colour in output ...

Near line 67: Possible typo: you repeated a whitespace
Context: ...ur | Disable colour in output | ...

Near line 67: Possible typo: you repeated a whitespace
Context: ... | | | -nosyncgomod | Do not sync g...

Near line 68: Possible spelling mistake found.
Context: ... | | -nosyncgomod | Do not sync go.mod with the W...

Near line 68: Possible typo: you repeated a whitespace
Context: ... | | -nosyncgomod | Do not sync go.mod with the Wails vers...

Near line 68: If a new sentence starts here, add a space and start with an uppercase letter.
Context: ...| -nosyncgomod | Do not sync go.mod with the Wails version ...

Near line 68: Possible typo: you repeated a whitespace
Context: ...o not sync go.mod with the Wails version | ...

Near line 68: Possible typo: you repeated a whitespace
Context: ... | | | -nsis | Generate NSIS...

Near line 69: Possible spelling mistake found.
Context: ... | | -nsis | Generate NSIS installe...

Near line 69: Possible typo: you repeated a whitespace
Context: ... | | -nsis | Generate NSIS installer for Windows ...

Near line 69: Possible typo: you repeated a whitespace
Context: ... | Generate NSIS installer for Windows | ...

Near line 69: Possible typo: you repeated a whitespace
Context: ... | | | -o filename | Output filena...

Near line 70: Possible typo: you repeated a whitespace
Context: ... | | -o filename | Output filename ...

Near line 70: Possible typo: you repeated a whitespace
Context: ...| -o filename | Output filename | ...

Near line 70: Possible typo: you repeated a whitespace
Context: ... | | | -obfuscated | Obfuscate the...

Near line 71: Possible typo: you repeated a whitespace
Context: ... | | -obfuscated | Obfuscate the application using [garbl...

Near line 71: Possible typo: you repeated a whitespace
Context: ...le](https://github.com/burrowers/garble) | ...

Near line 71: Possible typo: you repeated a whitespace
Context: ... | | | -platform | Build for the...

Near line 72: Possible typo: you repeated a whitespace
Context: ... | | -platform | Build for the given (comma delimited) ...

Near line 72: This word is normally spelled with a hyphen.
Context: ...tform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platf...

Near line 72: Possible spelling mistake found.
Context: ...r the given (comma delimited) platforms eg. windows/arm64. Not...

Near line 72: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tforms](../reference/cli.mdx#platforms) eg. windows/arm64. Note, if you do not gi...

Near line 72: Possible spelling mistake found.
Context: ...e, if you do not give the architecture, runtime.GOARCH is used. ...

Near line 72: Possible typo: you repeated a whitespace
Context: ...architecture, runtime.GOARCH is used. | platform = GOOS environment variable...

Near line 72: Possible spelling mistake found.
Context: ... | platform = GOOS environment variable if given else `ru...

Near line 72: Possible spelling mistake found.
Context: ...OOSenvironment variable if given elseruntime.GOOS.<br/>arch = GOARCH` envrionment varia...

Near line 72: Possible spelling mistake found.
Context: ...t variable if given else runtime.GOOS.
arch = GOARCH envrionment variable i...

Near line 72: Possible spelling mistake found.
Context: ...f given else runtime.GOOS.
arch = GOARCH envrionment variable if given else `ru...

Near line 72: Possible spelling mistake found.
Context: ...lse runtime.GOOS.
arch = GOARCH envrionment variable if given else runtime.GOARCH...

Near line 72: Possible spelling mistake found.
Context: ...RCHenvrionment variable if given elseruntime.GOARCH`. | | -race | Build with...

Near line 73: Possible typo: you repeated a whitespace
Context: ...f given else runtime.GOARCH. | | -race | Build with Go's race detector ...

Near line 73: Possible typo: you repeated a whitespace
Context: ... | Build with Go's race detector | ...

Near line 73: Possible typo: you repeated a whitespace
Context: ... | | | -s | Skip building...

Near line 74: Possible typo: you repeated a whitespace
Context: ... | | -s | Skip building the frontend ...

Near line 74: Possible typo: you repeated a whitespace
Context: ... | Skip building the frontend | ...

Near line 74: Possible typo: you repeated a whitespace
Context: ... | | | -skipbindings | Skip bindings...

Near line 75: Possible spelling mistake found.
Context: ... | | -skipbindings | Skip bindings generation ...

Near line 75: Possible typo: you repeated a whitespace
Context: ... | | -skipbindings | Skip bindings generation ...

Near line 75: Possible typo: you repeated a whitespace
Context: ...ndings | Skip bindings generation | ...

Near line 75: Possible typo: you repeated a whitespace
Context: ... | | | -tags "extra tags" | Build tags to...

Near line 76: Possible typo: you repeated a whitespace
Context: ... | | -tags "extra tags" | Build tags to pass to Go compiler. Mus...

Near line 76: Possible typo: you repeated a whitespace
Context: ... Space or comma (but not both) separated | ...

Near line 76: Possible typo: you repeated a whitespace
Context: ... | | | -trimpath | Remove all fi...

Near line 77: Possible spelling mistake found.
Context: ... | | -trimpath | Remove all file system pat...

Near line 77: Possible typo: you repeated a whitespace
Context: ... | | -trimpath | Remove all file system paths from the ...

Near line 77: Possible typo: you repeated a whitespace
Context: ...em paths from the resulting executable. | ...

Near line 77: Possible typo: you repeated a whitespace
Context: ... | | | -u | Updates your ...

Near line 78: Possible typo: you repeated a whitespace
Context: ... | | -u | Updates your project's go.mod to use...

Near line 78: Possible typo: you repeated a whitespace
Context: ...use the same version of Wails as the CLI | ...

Near line 78: Possible typo: you repeated a whitespace
Context: ... | | | -upx | Compress fina...

Near line 79: Possible spelling mistake found.
Context: ... | | -upx | Compress final binary...

Near line 79: Possible typo: you repeated a whitespace
Context: ... | | -upx | Compress final binary using "upx" ...

Near line 79: Possible spelling mistake found.
Context: ... | Compress final binary using "upx" ...

Near line 79: Possible typo: you repeated a whitespace
Context: ... | Compress final binary using "upx" | ...

Near line 79: Possible typo: you repeated a whitespace
Context: ... | | | -upxflags | Flags to pass...

Near line 80: Possible spelling mistake found.
Context: ... | | -upxflags | Flags to pass to upx ...

Near line 80: Possible typo: you repeated a whitespace
Context: ... | | -upxflags | Flags to pass to upx ...

Near line 80: Possible spelling mistake found.
Context: ...-upxflags | Flags to pass to upx ...

Near line 80: Possible typo: you repeated a whitespace
Context: ...xflags | Flags to pass to upx | ...

Near line 80: Possible typo: you repeated a whitespace
Context: ... | | | -v int | Verbosity lev...

Near line 81: Possible typo: you repeated a whitespace
Context: ... | | -v int | Verbosity level (0 - silent, 1 - defau...

Near line 81: Possible typo: you repeated a whitespace
Context: ...l (0 - silent, 1 - default, 2 - verbose) | 1 ...

Near line 81: Possible typo: you repeated a whitespace
Context: ... | 1 | | -webview2 | WebView2 inst...

Near line 82: Possible typo: you repeated a whitespace
Context: ... | | -webview2 | WebView2 installer strategy: download,...

Near line 82: Put a space after the comma.
Context: ... | WebView2 installer strategy: download,embed,browser,error ...

Near line 82: Put a space after the comma.
Context: ...staller strategy: download,embed,browser,error ...

Near line 82: Possible typo: you repeated a whitespace
Context: ...r strategy: download,embed,browser,error | download ...

Near line 82: Possible typo: you repeated a whitespace
Context: ... | download | | -windowsconsole | Keep the cons...

Near line 83: Possible spelling mistake found.
Context: ... | | -windowsconsole | Keep the console window for Wind...

Near line 83: Possible typo: you repeated a whitespace
Context: ... | | -windowsconsole | Keep the console window for Windows bu...

Near line 83: Possible typo: you repeated a whitespace
Context: ...ep the console window for Windows builds | ...

Near line 83: Possible typo: you repeated a whitespace
Context: ... | | For a detailed description of the `we...

Near line 85: Possible spelling mistake found.
Context: ...iew2` flag, please refer to the Windows Guide. If you prefer to build using s...

Near line 87: Possible spelling mistake found.
Context: ...oling, please consult the Manual Builds guide. Example: `wails build -clean ...

Near line 96: Possible spelling mistake found.
Context: ...c, the application will be bundled with Info.plist, not Info.dev.plist. ::: :::info U...

Near line 96: Possible spelling mistake found.
Context: ... will be bundled with Info.plist, not Info.dev.plist. ::: :::info UPX on Apple Silicon T...

Near line 100: Possible spelling mistake found.
Context: ...t, not Info.dev.plist`. ::: :::info UPX on Apple Silicon There are [issues](ht...

Near line 102: Possible spelling mistake found.
Context: ...thub.com/upx/upx/issues/446) with using UPX with Apple Silicon. ::: :::info UPX o...

Near line 106: Possible spelling mistake found.
Context: ...g UPX with Apple Silicon. ::: :::info UPX on Windows Some Antivirus vendors fals...

Near line 108: Possible spelling mistake found.
Context: ...Antivirus vendors false positively mark upx compressed binaries as virus, see [iss...

Near line 116: Possible typo: you repeated a whitespace
Context: ...ms Supported platforms are: | Platform | Description ...

Near line 116: Possible typo: you repeated a whitespace
Context: ...s are: | Platform | Description | | :--------------- | :----------------...

Near line 118: Possible spelling mistake found.
Context: ...----------------------------------- | | darwin | MacOS + architecture of bui...

Near line 118: Possible typo: you repeated a whitespace
Context: ...----------------------------- | | darwin | MacOS + architecture of build machine ...

Near line 118: The operating system from Apple is written “macOS”.
Context: ...---------------- | | darwin | MacOS + architecture of build machine ...

Near line 118: Possible typo: you repeated a whitespace
Context: ... | MacOS + architecture of build machine | | darwin/amd64 | MacOS 10.13+ AMD6...

Near line 119: Possible spelling mistake found.
Context: ...chitecture of build machine | | darwin/amd64 | MacOS 10.13+ AMD64 ...

Near line 119: Possible typo: you repeated a whitespace
Context: ...f build machine | | darwin/amd64 | MacOS 10.13+ AMD64 ...

Near line 119: The operating system from Apple is written “macOS”.
Context: ... machine | | darwin/amd64 | MacOS 10.13+ AMD64 ...

Near line 119: Possible typo: you repeated a whitespace
Context: ... | darwin/amd64 | MacOS 10.13+ AMD64 | | darwin/arm64 | MacOS 11.0+ ARM64...

Near line 120: Possible spelling mistake found.
Context: ...3+ AMD64 | | darwin/arm64 | MacOS 11.0+ ARM64 ...

Near line 120: Possible typo: you repeated a whitespace
Context: ... | | darwin/arm64 | MacOS 11.0+ ARM64 ...

Near line 120: The operating system from Apple is written “macOS”.
Context: ... | | darwin/arm64 | MacOS 11.0+ ARM64 ...

Near line 120: Possible typo: you repeated a whitespace
Context: ...| | darwin/arm64 | MacOS 11.0+ ARM64 | | darwin/universal | MacOS AMD64+ARM64...

Near line 121: Possible spelling mistake found.
Context: ...+ ARM64 | | darwin/universal | MacOS AMD64+ARM64 universal...

Near line 121: The operating system from Apple is written “macOS”.
Context: ... | | darwin/universal | MacOS AMD64+ARM64 universal application ...

Near line 121: Possible typo: you repeated a whitespace
Context: ... MacOS AMD64+ARM64 universal application | | windows | Windows 10/11 + a...

Near line 122: Possible typo: you repeated a whitespace
Context: ... universal application | | windows | Windows 10/11 + architecture of build ...

Near line 123: Possible typo: you repeated a whitespace
Context: ...cture of build machine | | windows/amd64 | Windows 10/11 AMD64 ...

Near line 123: Possible typo: you repeated a whitespace
Context: ...| windows/amd64 | Windows 10/11 AMD64 | | windows/arm64 | Windows 10/11 ARM...

Near line 124: Possible typo: you repeated a whitespace
Context: ... | | windows/arm64 | Windows 10/11 ARM64 ...

Near line 124: Possible typo: you repeated a whitespace
Context: ...| windows/arm64 | Windows 10/11 ARM64 | | linux | Linux + architect...

Near line 125: Possible spelling mistake found.
Context: .../11 ARM64 | | linux | Linux + architecture of bu...

Near line 125: Possible typo: you repeated a whitespace
Context: ...RM64 | | linux | Linux + architecture of build machine ...

Near line 125: Possible typo: you repeated a whitespace
Context: ... | Linux + architecture of build machine | | linux/amd64 | Linux AMD64 ...

Near line 126: Possible spelling mistake found.
Context: ...chitecture of build machine | | linux/amd64 | Linux AMD64 ...

Near line 126: Possible typo: you repeated a whitespace
Context: ...of build machine | | linux/amd64 | Linux AMD64 ...

Near line 126: Possible typo: you repeated a whitespace
Context: ... | | linux/amd64 | Linux AMD64 | | linux/arm64 | Linux ARM64 ...

Near line 127: Possible spelling mistake found.
Context: ...4 | | linux/arm64 | Linux ARM64 ...

Near line 127: Possible typo: you repeated a whitespace
Context: ... | | linux/arm64 | Linux ARM64 ...

Near line 127: Possible typo: you repeated a whitespace
Context: ... | | linux/arm64 | Linux ARM64 | ## doctor wails doctor will run di...

Near line 131: This sentence does not start with an uppercase letter.
Context: ... | ## doctor wails doctor will run diagnostics to ensure that your sys...

Near line 165: This sentence does not start with an uppercase letter.
Context: ... development! ``` ## dev wails dev is used to run your application in a "live...

Near line 170: Possible spelling mistake found.
Context: ...it detects changes to your go files - A webserver is started on http://localhost:34115 ...

Near line 170: Possible spelling mistake found.
Context: ...ur application (not just frontend) over http. This allows you to use your favourite ...

Near line 170: Possible spelling mistake. ‘favourite’ is British English.
Context: ... over http. This allows you to use your favourite browser development extensions - All ap...

Near line 173: Possible spelling mistake found.
Context: ...s of your Go methods with autogenerated JSDoc, providing code hinting - TypeScript ve...

Near line 176: Possible spelling mistake found.
Context: ...a .app file and run it. It will use a build/darwin/Info.dev.plist for development. | Fla...

Near line 178: Possible typo: you repeated a whitespace
Context: ...Info.dev.plist` for development. | Flag | Description ...

Near line 178: Possible typo: you repeated a whitespace
Context: ...ag | Description | Default | |:------------...

Near line 178: Possible typo: you repeated a whitespace
Context: ... | Default | |:-----------------------------|:-----...

Near line 180: Possible spelling mistake found.
Context: ...-----------|:----------------------| | -appargs "args" | Arguments passed ...

Near line 180: Possible spelling mistake found.
Context: ...--|:----------------------| | -appargs "args" | Arguments passed to the...

Near line 180: Possible typo: you repeated a whitespace
Context: ...---------------------| | -appargs "args" | Arguments passed to the application in...

Near line 180: Possible typo: you repeated a whitespace
Context: ...passed to the application in shell style | | | -assetdir "....

Near line 180: Possible typo: you repeated a whitespace
Context: ... | | | -assetdir "./path/to/assets" | Serve...

Near line 181: Possible spelling mistake found.
Context: ... | | | -assetdir "./path/to/assets" | Serve assets from ...

Near line 181: Possible typo: you repeated a whitespace
Context: ...y instead of using the provided asset FS | Value in wails.json | | -browser ...

Near line 181: Possible spelling mistake found.
Context: ... | Value in wails.json | | -browser | Ope...

Near line 182: Possible typo: you repeated a whitespace
Context: ... | Value in wails.json | | -browser | Opens a browser to `http://localhost:3...

Near line 182: Possible typo: you repeated a whitespace
Context: ...r to http://localhost:34115 on startup | | | -compiler "c...

Near line 182: Possible typo: you repeated a whitespace
Context: ... | | | -compiler "compiler" | Use a...

Near line 183: Possible typo: you repeated a whitespace
Context: ... | | -compiler "compiler" | Use a different go compiler to build, ...

Near line 183: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...| Use a different go compiler to build, eg go1.15beta1 ...

Near line 183: Possible typo: you repeated a whitespace
Context: ...ent go compiler to build, eg go1.15beta1 | go | | -debounce ...

Near line 183: Possible typo: you repeated a whitespace
Context: ... | go | | -debounce | The t...

Near line 184: Possible typo: you repeated a whitespace
Context: ... | go | | -debounce | The time to wait for reload after an a...

Near line 184: Possible typo: you repeated a whitespace
Context: ...reload after an asset change is detected | 100 (milliseconds) | | -devserver "...

Near line 184: Possible typo: you repeated a whitespace
Context: ... | 100 (milliseconds) | | -devserver "host:port" | The a...

Near line 185: Possible spelling mistake found.
Context: ... | 100 (milliseconds) | | -devserver "host:port" | The address to bind...

Near line 185: Possible typo: you repeated a whitespace
Context: ...liseconds) | | -devserver "host:port" | The address to bind the wails dev serv...

Near line 185: Possible typo: you repeated a whitespace
Context: ... address to bind the wails dev server to | "localhost:34115" | | -extensions ...

Near line 185: Possible typo: you repeated a whitespace
Context: ... | "localhost:34115" | | -extensions | Exten...

Near line 186: Possible typo: you repeated a whitespace
Context: ... | "localhost:34115" | | -extensions | Extensions to trigger rebuilds (comma ...

Near line 186: Possible typo: you repeated a whitespace
Context: ...ns to trigger rebuilds (comma separated) | go | | -forcebuild ...

Near line 186: Possible typo: you repeated a whitespace
Context: ... | go | | -forcebuild | Force...

Near line 187: Possible spelling mistake found.
Context: ... | go | | -forcebuild | Force build of appli...

Near line 187: Possible typo: you repeated a whitespace
Context: ... | go | | -forcebuild | Force build of application ...

Near line 187: Possible typo: you repeated a whitespace
Context: ... | Force build of application | | | -frontenddev...

Near line 187: Possible typo: you repeated a whitespace
Context: ... | | | -frontenddevserverurl "url" | Use 3...

Near line 188: Possible spelling mistake found.
Context: ... | | | -frontenddevserverurl "url" | Use 3rd party dev server url t...

Near line 188: Possible spelling mistake found.
Context: ... | | -frontenddevserverurl "url" | Use 3rd party dev server url to ser...

Near line 188: Possible typo: you repeated a whitespace
Context: ... | | -frontenddevserverurl "url" | Use 3rd party dev server url to serve ...

Near line 188: Possible spelling mistake found.
Context: ...erurl "url" | Use 3rd party dev server url to serve assets, EG Vite ...

Near line 188: Possible spelling mistake found.
Context: ...arty dev server url to serve assets, EG Vite ...

Near line 188: Possible typo: you repeated a whitespace
Context: ... dev server url to serve assets, EG Vite | "" | | -ldflags "fl...

Near line 188: Possible typo: you repeated a whitespace
Context: ... | "" | | -ldflags "flags" | Addit...

Near line 189: Possible spelling mistake found.
Context: ... | "" | | -ldflags "flags" | Additional ldflag...

Near line 189: Possible typo: you repeated a whitespace
Context: ... | | -ldflags "flags" | Additional ldflags to pass to the comp...

Near line 189: Possible spelling mistake found.
Context: ...dflags "flags" | Additional ldflags to pass to the compiler ...

Near line 189: Possible typo: you repeated a whitespace
Context: ...ditional ldflags to pass to the compiler | | | -loglevel "l...

Near line 189: Possible typo: you repeated a whitespace
Context: ... | | | -loglevel "loglevel" | Logle...

Near line 190: Possible spelling mistake found.
Context: ... | | | -loglevel "loglevel" | Loglevel to use - ...

Near line 190: Possible spelling mistake found.
Context: ... | | | -loglevel "loglevel" | Loglevel to use - Trace, Deb...

Near line 190: Possible typo: you repeated a whitespace
Context: ... | | -loglevel "loglevel" | Loglevel to use - Trace, Debug, Info, ...

Near line 190: Possible spelling mistake found.
Context: ... | | -loglevel "loglevel" | Loglevel to use - Trace, Debug, Info, Warning, E...

Near line 190: Possible typo: you repeated a whitespace
Context: ...use - Trace, Debug, Info, Warning, Error | Debug | | -nocolour ...

Near line 190: Possible typo: you repeated a whitespace
Context: ... | Debug | | -nocolour | Turn ...

Near line 191: Possible spelling mistake found.
Context: ... | Debug | | -nocolour | Turn off colour cl...

Near line 191: Possible typo: you repeated a whitespace
Context: ... | Debug | | -nocolour | Turn off colour cli output ...

Near line 191: Possible spelling mistake. ‘colour’ is British English.
Context: ...-nocolour | Turn off colour cli output ...

Near line 191: Possible spelling mistake found.
Context: ...ur | Turn off colour cli output ...

Near line 191: Possible typo: you repeated a whitespace
Context: ... | Turn off colour cli output | false | | -noreload ...

Near line 191: Possible typo: you repeated a whitespace
Context: ... | false | | -noreload | Disab...

Near line 192: Possible spelling mistake found.
Context: ... | false | | -noreload | Disable automatic ...

Near line 192: Possible typo: you repeated a whitespace
Context: ... | false | | -noreload | Disable automatic reload when assets c...

Near line 192: Possible typo: you repeated a whitespace
Context: ...able automatic reload when assets change | | | -nosyncgomod...

Near line 192: Possible typo: you repeated a whitespace
Context: ... | | | -nosyncgomod | Do no...

Near line 193: Possible spelling mistake found.
Context: ... | | | -nosyncgomod | Do not sync go.mod wi...

Near line 193: Possible typo: you repeated a whitespace
Context: ...| | | -nosyncgomod | Do not sync go.mod with the Wails vers...

Near line 193: If a new sentence starts here, add a space and start with an uppercase letter.
Context: ...cgomod | Do not sync go.mod with the Wails version ...

Near line 193: Possible typo: you repeated a whitespace
Context: ...o not sync go.mod with the Wails version | false | | -race ...

Near line 193: Possible typo: you repeated a whitespace
Context: ... | false | | -race | Build...

Near line 194: Possible typo: you repeated a whitespace
Context: ... | false | | -race | Build with Go's race detector ...

Near line 194: Possible typo: you repeated a whitespace
Context: ... | Build with Go's race detector | false | | -reloaddirs ...

Near line 194: Possible typo: you repeated a whitespace
Context: ... | false | | -reloaddirs | Addit...

Near line 195: Possible spelling mistake found.
Context: ... | false | | -reloaddirs | Additional directori...

Near line 195: Possible typo: you repeated a whitespace
Context: ... | false | | -reloaddirs | Additional directories to trigger relo...

Near line 195: Possible typo: you repeated a whitespace
Context: ...ies to trigger reloads (comma separated) | Value in wails.json | | -s ...

Near line 195: Possible spelling mistake found.
Context: ... | Value in wails.json | | -s | Ski...

Near line 196: Possible typo: you repeated a whitespace
Context: ... | Value in wails.json | | -s | Skip building the frontend ...

Near line 196: Possible typo: you repeated a whitespace
Context: ... | Skip building the frontend | false | | -save ...

Near line 196: Possible typo: you repeated a whitespace
Context: ... | false | | -save | Saves...

Near line 197: Possible typo: you repeated a whitespace
Context: ... | false | | -save | Saves the given assetdir, `reloaddir...

Near line 197: Possible spelling mistake found.
Context: ... | Saves the given assetdir, reloaddirs, wailsjsdir, `debounce...

Near line 197: Possible spelling mistake found.
Context: ... | Saves the given assetdir, reloaddirs, wailsjsdir, debounce, devserver...

Near line 197: Possible spelling mistake found.
Context: ...ves the given assetdir, reloaddirs, wailsjsdir, debounce, devserver and `frontend...

Near line 197: Possible spelling mistake found.
Context: ...reloaddirs, wailsjsdir, debounce, devserver and frontenddevserverurl flags in `w...

Near line 197: Possible spelling mistake found.
Context: ...ailsjsdir, debounce, devserverandfrontenddevserverurlflags inwails.json` to become the de...

Near line 197: Possible spelling mistake found.
Context: ...erandfrontenddevserverurlflags inwails.json` to become the defaults for subsequent ...

Near line 197: Possible typo: you repeated a whitespace
Context: ...e defaults for subsequent invocations. | | | -skipbindings | Skip ...

Near line 198: Possible spelling mistake found.
Context: ...vocations. | | | -skipbindings | Skip bindings generati...

Near line 198: Possible typo: you repeated a whitespace
Context: ... | | -skipbindings | Skip bindings generation ...

Near line 198: Possible typo: you repeated a whitespace
Context: ... | Skip bindings generation | | | -tags "extra...

Near line 198: Possible typo: you repeated a whitespace
Context: ... | | | -tags "extra tags" | Build...

Near line 199: Possible typo: you repeated a whitespace
Context: ... | | -tags "extra tags" | Build tags to pass to compiler (quoted...

Near line 199: Possible typo: you repeated a whitespace
Context: ...to compiler (quoted and space separated) | | | -v ...

Near line 199: Possible typo: you repeated a whitespace
Context: ... | | | -v | Verbo...

Near line 200: Possible typo: you repeated a whitespace
Context: ... | | | -v | Verbosity level (0 - silent, 1 - stand...

Near line 200: Possible typo: you repeated a whitespace
Context: ... (0 - silent, 1 - standard, 2 - verbose) | 1 | | -wailsjsdir ...

Near line 200: Possible typo: you repeated a whitespace
Context: ... | 1 | | -wailsjsdir | The d...

Near line 201: Possible spelling mistake found.
Context: ... | 1 | | -wailsjsdir | The directory to gen...

Near line 201: Possible typo: you repeated a whitespace
Context: ... | 1 | | -wailsjsdir | The directory to generate the generate...

Near line 201: Possible typo: you repeated a whitespace
Context: ... generate the generated Wails JS modules | Value in wails.json | Example: `wa...

Near line 201: Possible spelling mistake found.
Context: ... | Value in wails.json | Example: `wails dev -assetdir ./fr...

Near line 209: Unpaired symbol: ‘)’ seems to be missing
Context: ...ng: - Build the application and run it (more details [here](../guides/manual-bui...

Near line 209: Unpaired symbol: ‘]’ seems to be missing
Context: ...he application and run it (more details here - Gen...

Near line 210: The preposition ‘to’ seems more likely in this position.
Context: ...ds.mdx) - Generate the Wails JS modules in ./frontend/src - Watch for updates to...

Near line 214: Possible spelling mistake found.
Context: ...re with existing framework scripts here. ## generate ### temp...

Near line 216: This sentence does not start with an uppercase letter.
Context: ...on-development.mdx#live-reloading). ## generate ### template Wails uses templates for...

Near line 223: Possible typo: you repeated a whitespace
Context: ...be used for generating projects. | Flag | Description ...

Near line 223: Possible typo: you repeated a whitespace
Context: ...jects. | Flag | Description | |:-----------------|:-----------------...

Near line 225: Possible typo: you repeated a whitespace
Context: ...-------------------------------| | -name | The template name (Mandatory) ...

Near line 225: Possible typo: you repeated a whitespace
Context: ... | The template name (Mandatory) | | -frontend "path" | Path to frontend ...

Near line 228: Possible spelling mistake found.
Context: ... templates, consult the Templates guide. ### module The `wails generate modu...

Near line 230: This sentence does not start with an uppercase letter.
Context: ...s guide](../guides/templates.mdx). ### module The wails generate module command al...

Near line 232: Possible spelling mistake found.
Context: ...and allows you to manually generate the wailsjs directory for your application. | Fla...

Near line 234: Possible typo: you repeated a whitespace
Context: ... directory for your application. | Flag | Description ...

Near line 234: Possible typo: you repeated a whitespace
Context: ...n. | Flag | Description | Default | |:---------------------|:---...

Near line 236: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...| Use a different go compiler to build, eg go1.15beta1 | go | | -tags ...

Near line 236: Possible typo: you repeated a whitespace
Context: ...ent go compiler to build, eg go1.15beta1 | go | | -tags "extra tags" | Bui...

Near line 236: Possible typo: you repeated a whitespace
Context: ...ler to build, eg go1.15beta1 | go | | -tags "extra tags" | Build tags to...

Near line 237: Possible typo: you repeated a whitespace
Context: ... | go | | -tags "extra tags" | Build tags to pass to compiler (quoted...

Near line 237: Possible typo: you repeated a whitespace
Context: ... compiler (quoted and space separated) | | ## update wails update will update...

Near line 241: This sentence does not start with an uppercase letter.
Context: ... | | ## update wails update will update the version of the Wails CLI. |...

Near line 243: Possible typo: you repeated a whitespace
Context: ...te the version of the Wails CLI. | Flag | Description ...

Near line 243: Possible typo: you repeated a whitespace
Context: ...CLI. | Flag | Description | |:-------------------|:---------------...

Near line 245: Possible typo: you repeated a whitespace
Context: ...--------------------------------| | -pre | Update to latest pre-release version ...

Near line 245: Possible typo: you repeated a whitespace
Context: ... | Update to latest pre-release version | | -version "version" | Install a speci...

Near line 250: This sentence does not start with an uppercase letter.
Context: ... the CLI | ## version wails version will simply output the current CLI version. ...

Additional comments not posted (1)
website/versioned_docs/version-v2.8.1/reference/cli.mdx (1)

23-23: Specify the IDE options more clearly in the documentation.

Consider providing a brief explanation or a link to further documentation on how to use the -ide flag with vscode and goland. This will help users understand how to apply these options effectively.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

leaanthony
leaanthony approved these changes Apr 22, 2024
View reviewed changes
Copy link
Member

@leaanthony leaanthony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! 🙏

@leaanthony leaanthony merged commit a7c10a1 into wailsapp:master Apr 22, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leaanthony leaanthony leaanthony approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@DiegPS @leaanthony