# aio-lib-template-validation

**Repository Path**: mirrors_adobe/aio-lib-template-validation

## Basic Information

- **Project Name**: aio-lib-template-validation
- **Description**: NPM-based tool to validate App Builder templates during submission process to App Builder Template Registry
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-10
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# aio-lib-template-validation
NPM-based tool to validate App Builder templates during submission process to [App Builder Template Registry](https://github.com/adobe/aio-template-submission).

# Validation checks
## package.json file

| Field         | Description                                        | Required           |
| ------------- | -------------------------------------------------- | ------------------ |
| `description` | Template must have a description.                  | :heavy_check_mark: |
| `keywords`    | Must contain a keyword `aio-app-builder-template`. | :heavy_check_mark: |

## install.yml file

| Field        | Type            | Description                                                                                                                                                                                              | Required           |
| ------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `categories` | list of strings | Template must have categories defined. See [allowed values](https://github.com/adobe/aio-lib-console-project-installation/blob/main/schema/sub-schemas/categories.schema.json).                          | :heavy_check_mark: |
| `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
```bash
$ npm i -g @adobe/aio-lib-template-validation
$ tv
```

## Usage
To check a specific template run:
```bash
$ 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:
```bash
$ npm i @adobe/aio-lib-template-validation
```

## Contributing

Contributions are welcomed! Read the [Contributing Guide](CONTRIBUTING.md) for more information.

To get started:

1. Install [node.js](https://nodejs.org/).
3. Clone the repository.
4. 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](LICENSE) for more information.