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

chore: Update configurations details for projectRunner in docs #345

Merged
merged 3 commits into from
Sep 24, 2024
Merged

chore: Update configurations details for projectRunner in docs #345

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fd475f
chore: Update configurations details for projectRunner in docs
viralgupta Aug 17, 2024
0a97bbf
update projectRunner to hostProject
viralgupta Aug 21, 2024
dec4db9
Update neutralino.config.json.md
shalithasuranga Sep 24, 2024
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
22 changes: 21 additions & 1 deletion docs/configuration/neutralino.config.json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,29 @@ Use `|` character to set multiple regular expressions, as shown below.

### `cli.frontendLibrary: object`

Enables frontend development tools (HMR, etc) for the `neu run --frontend-lib-dev` command. Learn more about frontend
Enables frontend development tools (HMR, etc) for the `neu run` command. Learn more about frontend
framework integration from [here](../getting-started/using-frontend-libraries.md)

### `cli.hostProject.projectPath: string`

Sets the project path of the host project. This path will be used as the current directory while executing the host-project-related commands.

### `cli.hostProject.initCommand: string`

A command that gets executed after downloading an host app template with the `neu create` command.

### `cli.hostProject.devCommand: string`

This command will run with the `neu run` command to start the host project.

### `cli.hostProject.buildCommand: string`

The `neu build` command will execute this command before generating the app bundle, so you can generate bundled version of host project code.

### `cli.hostProject.buildPath: string`

Location where the final read-to-distribute host project files will be stored after the execution of `buildCommand`. Files in this folder are copied into the app bundle path after the execution of `neu build` command.

### `cli.distributionPath: string`

Sets the build path for neu CLI. For example, if you need to get the built binaries in `build` folder instead of `dist`, you can set the `distributionPath` as follows:
Expand Down