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

Add frontend:dev:install configuration #1666

Merged
merged 4 commits into from
Aug 3, 2022
Merged

Add frontend:dev:install configuration #1666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6efc38
Add frontend:dev:install configuration
LGiki Jul 27, 2022
5e759b0
Merge branch 'master' into feat/add-project-config-item
leaanthony Jul 30, 2022
4429ff9
When building the frontend in dev mode, use `frontend:dev:install` (i…
LGiki Aug 2, 2022
e7d6726
Simplified logic for determining installation command
LGiki Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions v2/internal/project/project.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ type Project struct {

// Commands used in `wails dev`
DevCommand string `json:"frontend:dev"`
DevInstallCommand string `json:"frontend:dev:install"`
DevWatcherCommand string `json:"frontend:dev:watcher"`
// The url of the external wails dev server. If this is set, this server is used for the frontend. Default ""
FrontendDevServerURL string `json:"frontend:dev:serverUrl"`
Expand Down Expand Up @@ -85,8 +86,8 @@ type Project struct {
}

func (p *Project) GetDevInstallerCommand() string {
if p.DevCommand != "" {
return p.DevCommand
if p.DevInstallCommand != "" {
return p.DevInstallCommand
}
return p.InstallCommand
}
Expand Down
10 changes: 7 additions & 3 deletions v2/pkg/commands/build/base.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,17 +513,21 @@ func (b *BaseBuilder) BuildFrontend(outputLogger *clilogger.CLILogger) error {
frontendDir := filepath.Join(b.projectData.Path, "frontend")

// Check there is an 'InstallCommand' provided in wails.json
if b.projectData.InstallCommand == "" {
installCommand := b.projectData.InstallCommand
if b.projectData.OutputType == "dev" {
installCommand = b.projectData.GetDevInstallerCommand()
}
if installCommand == "" {
// No - don't install
outputLogger.Println(" - No Install command. Skipping.")
} else {
// Do install if needed
outputLogger.Print(" - Installing frontend dependencies: ")
if verbose {
outputLogger.Println("")
outputLogger.Println(" Install command: '" + b.projectData.InstallCommand + "'")
outputLogger.Println(" Install command: '" + installCommand + "'")
}
if err := b.NpmInstallUsingCommand(frontendDir, b.projectData.InstallCommand, verbose); err != nil {
if err := b.NpmInstallUsingCommand(frontendDir, installCommand, verbose); err != nil {
return err
}
outputLogger.Println("Done.")
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/project-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The project config resides in the `wails.json` file in the project directory. Th
"frontend:install": "[The command to install node dependencies, run in the frontend directory - often `npm install`]",
"frontend:build": "[The command to build the assets, run in the frontend directory - often `npm run build`]",
"frontend:dev": "[This command is the dev equivalent of frontend:build. If not specified falls back to frontend:build]",
"frontend:dev:install": "[This command is the dev equivalent of frontend:install. If not specified falls back to frontend:install]",
"frontend:dev:watcher": "[This command is run in a separate process on `wails dev`. Useful for 3rd party watchers or starting 3d party dev servers]",
"frontend:dev:serverUrl": "[URL to a 3rd party dev server to be used to serve assets, EG Vite. If this is set to 'auto' then the devServerUrl will be inferred from the Vite output]",
"wailsjsdir": "[Relative path to the directory that the auto-generated JS modules will be created]",
Expand Down
1 change: 1 addition & 0 deletions ...18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/project-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ sidebar_position: 5
"frontend:install": "[安装 node 依赖的命令，在 frontend 目录下运行 - 通常是 `npm install`]",
"frontend:build": "[构建资源的命令，在 frontend 目录下运行 - 通常是 `npm run build`]",
"frontend:dev": "[此命令等效于开发模式中的 frontend:build，如果没有指定则只有 frontend:build]",
"frontend:dev:install": "[此命令等效于开发模式中的 frontend:install，如果没有指定则只有 frontend:install]",
"frontend:dev:watcher": "[此命令在 `wails dev` 上的单独进程中运行。对第 3 方观察者有用]",
"frontend:dev:serverUrl": "[使用第三方开发服务器提供资源，比如 Vite",
"wailsjsdir": "[自动生成的JS模块将被创建的目录的相对路径]",
Expand Down