Skip to content

Commit

Permalink
website: metadata explain buildFolderRelativePath
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Dec 27, 2024
1 parent f1e8b66 commit afc5aaf
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions website/docs/metadata/properties/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,20 @@ When substitutions occur within a build configuration, the `properties`
defined in the build configuration take precedence over `properties`
with the same name defined at the project level.

## Reserved properties

The properties are generally under the user's full control.

However, **xpm** reserves certain names for variables with special usage.

### `buildFolderRelativePath`

The value of this variable is used by xpm as the folder where the build configuration-specific dependencies will be installed.

The folder is relative to the location of the `package.json` file.

If not explicitly defined, an warning is issued, and the default value of `build/<configurationName>` is used.

## Examples

Project properties:
Expand Down

0 comments on commit afc5aaf

Please sign in to comment.