@forge/manifest
v6.3.1
Published
Definitions and validations of the Forge manifest
Downloads
26,858
Readme
Forge manifest validation
Package used to parse and validate the
manifest.yml
file of Forge apps.
How to use the library
Use it as follows:
import { ProcessorBuilder, ValidationTypes } from '@forge/manifest';
const results = ProcessorBuilder.instance()
.withValidation(ValidationTypes.FULL)
.build()
.process();
console.log(`Valid manifest ? ${results.success}`);
How to check the errors
In case of an invalid manifest.yml
, the following information will be populated:
export interface ValidationError {
message: string;
reference: string;
level: 'error' | 'warning';
line?: number;
column?: number;
}
export interface ManifestValidationResult {
success: boolean;
errors?: ValidationError[];
}