Validate App Manifest in Vega Studio

App manifest validation catches configuration errors early in the development process by identifying missing required fields, incorrect data types, invalid URLs, and compatibility problems before deploying your React Native or native apps. The Vega SDK provides built-in manifest validation through Vega Studio, a Visual Studio Code (VS Code) extension. With Vega Studio, you can get manifest validation in the editor during these development stages:

Development - Get immediate feedback as you edit your manifest.toml file
Code commits - Prevent validation errors in new changes
Build process - Catch issues before deployment
App submission - Confirm compliance with platform requirements

Prerequisites

Install the Vega SDK.
A valid manifest.toml file in your project root.
(Optional) Install the TOML Language Support.

Verify validation

Vega Studio enables manifest validation by default. Validation starts automatically. To verify it’s working:

Open VS Code.
Select the Vega extension icon from the activity bar to open the Vega Studio panel.
Open your project from the Projects section.

Validation fails to start automatically

If validation fails to start automatically, right-click on the manifest.toml and select “Validate Manifest”.

Screenshot that shows the location of the Validate Manifest menu option from right-clicking on the manifest.toml file.

View validation results

To view validation results, check the Problems panel: Mac: Cmd+Shift+M Linux: Ctrl+Shift+M

Screenshot of the problems tab in the VS Code terminal, listing the validation results.

Example validation error

When the validation detects an issue, you see clear, actionable error messages like:

Error: Missing required property 'package.id'
Location: Line 3, manifest.toml
Fix: Add a unique identifier for your package, e.g., package.id = "com.example.myapp"

Example OS version error

Starting with SDK 0.24, the [os.version] section is required. If it’s missing, the build fails with the following error:

Missing [os.version].target. A Vega application must declare its OS version. Add to manifest.toml: [os.version] target = "<version>" min = "<version>" Or run: vega project update-manifest --os-version <version> --os-min <version>
Missing [os.version].min. Declare both min and target in [os.version].
Vega operation FAILED due to an irrecoverable error: vega build refused: 2 OS-version compliance error(s) in manifest.toml. See above.

To fix this, run the following command from your project root:

vega project update-manifest --os-min 1.2 --os-version 1.2

For the fields, validation rules, and all three ways to add the section, see Manifest [os.version] Section. For more details about this error, see Build fails with “Missing [os.version]” error. To validate your OS version configuration from the command line rather than in the editor, run vega project doctor.

​Prerequisites

​Verify validation

​Validation fails to start automatically

​View validation results

​Example validation error

​Example OS version error

​Related topics