@adobe/reactor-validator

Experience Platform Tags Extension Validator

Experience Platform Tags, by Adobe, is a next-generation tag management solution enabling simplified deployment of marketing technologies. For more information regarding Experience Platform Tags, please visit our product website.

The extension validator helps extension developers validate that an extension package is well-structured. Namely, it verifies that:

1. The extension has a manifest (extension.json) matching the expected structure.
2. All referenced directories and files exist at the specified locations within the extension directory.

For more information about developing an extension for Experience Platform Tags, please visit our extension development guide.

Usage

This tool is currently integrated and automatically executed within other tools that extension developers typically use, namely the Extension Sandbox Tool and Extension Packager Tool. This is likely sufficient for most extension developers.

Running the Validator from the Command Line

Before running the validator, you must first have Node.js installed on your computer.

Once Node.js is installed, run the validator by executing the following command from the command line within your extension's directory:

npx @adobe/reactor-validator

Incorporating the Validator into Other Tools

If you would like to incorporate the validator into your own extension development tools, you may do so by first installing the validator as a dependency inside your tool's project:

npm i @adobe/reactor-validator

Once it has been installed as a dependency, import the validator and pass it an extension manifest object (this is the object exported from an extension.json file). If the value returned from the validator is undefined, then the extension appears to be well-formed; otherwise, the value will contain a description of the issue that was encountered.

const validate = require('@adobe/reactor-validator');
const error = validate(require('./extension.json'));

// Will be undefined if no error was found.
console.log(error);

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.

To manually test your changes, first run the following command from the sandbox tool directory:

npm link

Then, in a directory containing an extension (any extension you would like to use for testing), run the following command:

npx @adobe/reactor-validator

Npx will execute the sandbox tool using your locally linked code rather than the code published on the public npm repository.

Licensing

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