adobe / aio-lib-template-validation

NPM-based tool to validate App Builder templates during submission process to App Builder Template Registry

aio-lib-template-validation

NPM-based tool to validate App Builder templates during submission process to App Builder Template Registry.

Validation checks

package.json file

Field	Description	Required
description	Template must have a description.	✔️
keywords	Must contain a keyword aio-app-builder-template.	✔️

install.yml file

Field	Type	Description	Required
categories	list of strings	Template must have categories defined. See allowed values.	✔️
extensions	list of objects	List extension points that a template implements. Each extension point must have the string property extensionPointId.
apis	list of objects	List the APIs required to be added to all Workspaces in the App Builder Project, if they don't exist. Each API object must contain code as one of its properties, this is the sdk code of the service.
event	object	This will list the event configuration for the template. The event template code that contains this specification may read this to configure itself.
runtime	boolean	Whether to add Runtime to App Builder application or not. Defaults to false.

Getting started

Installation

$ npm i -g @adobe/aio-lib-template-validation
$ tv

Usage

To check a specific template run:

$ tv run-checks <path>

This will execute all checks on App Builder template given path to the template code and output the results. You can add --json or -j option to output results in JSON format.

Installation as a library

If you want to use this package as a library within your project, run:

$ npm i @adobe/aio-lib-template-validation

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

To get started:

1. Install node.js.
2. Clone the repository.
3. After navigating into the project directory, install project dependencies by running npm install.

Scripts

To run tests a single time, run the following command:

npm test

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

aio-lib-template-validation's Issues

complete README to standardized version, with badges, etc

See https://github.com/adobe/aio-lib-env example

invalid key in install.yml was not caught in template review

I submitted v0.1.1 of this package: adobe/aio-template-submission#354 and it had an incorrect services key (which should be apis) and the validation passed.

v0.1.1 code: https://github.com/adobe/generator-add-action-target/tree/v0.1.1

I have since published v0.1.2 with the fix in install.yml and re-submitted.

Submitting to this repo since I can't file an issue on https://github.com/adobe/aio-template-submission

checks should use the json schema validation

See https://github.com/adobe/aio-lib-console-project-installation/tree/main/schema