Skip to main content

The minimumXpmRequired property

Purpose​

Identify the minimum required xpm version.

Syntax​

{
    ...
    "minimumXpmRequired": "<semver>"
    ...
}

The value of the minimumXpmRequired property is a string with a version in SemVer format.

Default value​

If missing, no checks are performed on the xpm version.

Descriptions​

This definition is a mechanism to identify the minimum required xpm version necessary for correctly interpreting the current definitions in package.json, thereby ensuring compatibility with future (potentially incompatible) xpm versions.

The minimumXpmRequired property has two primary purposes:

  • it prevents the use of an outdated xpm with a newer package.json
  • it allows a newer xpm to revert some functionality to match the older minimum required xpm.

The mechanism is similar to that used by CMake; the policies are documented on the separate Policies pages.

Example​

{
    ...
    "xpack": {
        "minimumXpmRequired": "0.19.4"
        ...
    }
}