From 5fd475f2093ba709c558e1a8c5b6b57eff83e082 Mon Sep 17 00:00:00 2001 From: viralgupta Date: Sat, 17 Aug 2024 23:56:38 +0530 Subject: [PATCH 1/3] chore: Update configurations details for projectRunner in docs --- docs/configuration/neutralino.config.json.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/configuration/neutralino.config.json.md b/docs/configuration/neutralino.config.json.md index 5d40d824..44adea95 100644 --- a/docs/configuration/neutralino.config.json.md +++ b/docs/configuration/neutralino.config.json.md @@ -353,6 +353,26 @@ Use `|` character to set multiple regular expressions, as shown below. Enables frontend development tools (HMR, etc) for the `neu run --frontend-lib-dev` command. Learn more about frontend framework integration from [here](../getting-started/using-frontend-libraries.md) +### `cli.projectRunner.projectPath: string` + +Sets the project path of the Project Runner apps. This path will be used as the current directory while executing the projectRunner related commands ([initCommand](#cliprojectrunnerinitcommand-string), [devCommand](#cliprojectrunnerdevcommand-string), [buildCommand](#cliprojectrunnerbuildcommand-string)). + +### `cli.projectRunner.initCommand: string` + +A command that gets executed after downloading an app template with the `neu create` command. + +### `cli.projectRunner.devCommand: string` + +This command will run with the `neu run` command to start the Project Runner file. + +### `cli.projectRunner.buildCommand: string` + +The `neu build` command will execute this command before generating the app bundle, so you can generate bundled version of project Runner code. Note: Developers are responsible for creating the bundled code in [Project Runner buildPath](#cliprojectrunnerbuildpath) after executing this command. + +### `cli.projectRunner.buildPath: string` + +Location where built backend/projecRunner file(s) will be located after [buildCommand](#cliprojectrunnerbuildcommand-string). Files in these folders are copied into distributionPath after `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: From 0a97bbf1a160f0b03b63800af0be716c2e0e73e4 Mon Sep 17 00:00:00 2001 From: viralgupta Date: Wed, 21 Aug 2024 21:31:37 +0530 Subject: [PATCH 2/3] update projectRunner to hostProject --- docs/configuration/neutralino.config.json.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/neutralino.config.json.md b/docs/configuration/neutralino.config.json.md index 44adea95..28430eba 100644 --- a/docs/configuration/neutralino.config.json.md +++ b/docs/configuration/neutralino.config.json.md @@ -353,25 +353,25 @@ Use `|` character to set multiple regular expressions, as shown below. Enables frontend development tools (HMR, etc) for the `neu run --frontend-lib-dev` command. Learn more about frontend framework integration from [here](../getting-started/using-frontend-libraries.md) -### `cli.projectRunner.projectPath: string` +### `cli.hostProject.projectPath: string` -Sets the project path of the Project Runner apps. This path will be used as the current directory while executing the projectRunner related commands ([initCommand](#cliprojectrunnerinitcommand-string), [devCommand](#cliprojectrunnerdevcommand-string), [buildCommand](#cliprojectrunnerbuildcommand-string)). +Sets the project path of the Project Runner apps. This path will be used as the current directory while executing the hostProject related commands ([initCommand](#clihostprojectinitcommand-string), [devCommand](#clihostprojectdevcommand-string), [buildCommand](#clihostprojectbuildcommand-string)). -### `cli.projectRunner.initCommand: string` +### `cli.hostProject.initCommand: string` A command that gets executed after downloading an app template with the `neu create` command. -### `cli.projectRunner.devCommand: string` +### `cli.hostProject.devCommand: string` This command will run with the `neu run` command to start the Project Runner file. -### `cli.projectRunner.buildCommand: string` +### `cli.hostProject.buildCommand: string` -The `neu build` command will execute this command before generating the app bundle, so you can generate bundled version of project Runner code. Note: Developers are responsible for creating the bundled code in [Project Runner buildPath](#cliprojectrunnerbuildpath) after executing this command. +The `neu build` command will execute this command before generating the app bundle, so you can generate bundled version of Host Project code. Note: Developers are responsible for creating the bundled code in [Host Project buildPath](#clihostprojectbuildpath) after executing this command. -### `cli.projectRunner.buildPath: string` +### `cli.hostProject.buildPath: string` -Location where built backend/projecRunner file(s) will be located after [buildCommand](#cliprojectrunnerbuildcommand-string). Files in these folders are copied into distributionPath after `neu build` command. +Location where built hostProject/projectRunner file(s) will be located after [buildCommand](#clihostprojectbuildcommand-string). Files in these folders are copied into distributionPath after `neu build` command. ### `cli.distributionPath: string` From dec4db9987559e1ec3a17f3d0640287c507cede4 Mon Sep 17 00:00:00 2001 From: Shalitha Suranga Date: Tue, 24 Sep 2024 13:40:00 +0530 Subject: [PATCH 3/3] Update neutralino.config.json.md --- docs/configuration/neutralino.config.json.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/configuration/neutralino.config.json.md b/docs/configuration/neutralino.config.json.md index 28430eba..5834545c 100644 --- a/docs/configuration/neutralino.config.json.md +++ b/docs/configuration/neutralino.config.json.md @@ -350,28 +350,28 @@ 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 Project Runner apps. This path will be used as the current directory while executing the hostProject related commands ([initCommand](#clihostprojectinitcommand-string), [devCommand](#clihostprojectdevcommand-string), [buildCommand](#clihostprojectbuildcommand-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 app template with the `neu create` command. +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 Project Runner file. +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. Note: Developers are responsible for creating the bundled code in [Host Project buildPath](#clihostprojectbuildpath) after executing this command. +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 built hostProject/projectRunner file(s) will be located after [buildCommand](#clihostprojectbuildcommand-string). Files in these folders are copied into distributionPath after `neu build` command. +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`