Skip to content

Conversation

prasanta352
Copy link

Description

Add schema support for Adobe Express Add-on Manifest

  • Added express-add-on-manifest.schema.json for validating & autocomplete add-on manifest files.
  • Introduced copy-schema script to copy schema files to template directories.
  • Updated package.json to include the new script.
  • Created .vscode/settings.json files in various templates to link the schema for VSCode integration.

This update enhances the development experience by providing schema validation & autocomplete for add-on manifests across multiple templates.

Motivation and Context

Developers working on Adobe Express add-ons need better development experience when editing manifest.json files. This sample provides:

  • JSON schema validation for manifest.json files
  • Autocomplete suggestions for valid manifest properties
  • Real-time validation to catch configuration errors early
  • Better IDE integration for add-on development

How Has This Been Tested?

  • Verified autocomplete works in VS Code with the provided schema configuration
  • Tested with Cursor editor for compatibility
  • Validated that the JSON schema correctly matches Adobe Express add-on manifest structure

Screenshots (if appropriate):

demo

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

- Added `express-add-on-manifest.schema.json` for validating & autocomplete add-on manifest files.
- Introduced `copy-schema` script to copy schema files to template directories.
- Updated `package.json` to include the new script.
- Created `.vscode/settings.json` files in various templates to link the schema for VSCode integration.

This update enhances the development experience by providing schema validation for add-on manifests across multiple templates.
"clean": "rimraf coverage dist src/generated",
"test": "c8 mocha && c8 check-coverage"
"test": "c8 mocha && c8 check-coverage",
"copy-schema": "node scripts/copy-schema.js"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This creates a logical cycle. The @adobe/ccweb-add-on-manifest package sits at the very bottom of the dependency graph, where the other packages like @adobe/create-ccweb-add-on depend on it.
So, the copy-schema.js script from add-on-manifest writing to create-ccweb-add-on creates this cycle.
Please remove the changes made in the add-on-manifest package, skipping the copy-schema step.
It would be great, though if we could automatically generate express-add-on-manifest.schema.json. Could be a follow-up.

Copy link
Author

@prasanta352 prasanta352 Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks @xerxovksi As you mentioned, I have reverted the changes in @adobe/ccweb-add-on-manifest and skip the copy-schema step to avoid the cycle.

I also agree it would be good to auto-generate express-add-on-manifest.schema.json. Updating the docs to include optional types would be the prerequisite, otherwise the schema wouldn’t be accurate.

On which step do you think the auto-generation should happen once the docs are updated?

…t package. Updated `package.json` to remove the `copy-schema` script. This cleanup reduces unnecessary code and simplifies the project structure.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants