AdobeXD/plugin-docs

Starter project from XD console does not run

3phase opened this issue · 4 comments

3phase commented

Submit an issue

Topic

This is an issue regarding:

  • The tutorials contained within this repo.
  • The samples contained within this repo.

Versions

  • XD version(s): 44.1.12
  • UXP Developer Tool version: 1.4.0.3

Description of the issue

The starter project that's generated in Adobe Developer Console does not open in XD version 44.1.12 w/ UXP Developer Tool v1.4.0.3. The prompted error is Failed to Add Plugin to Workspace.

Proposed solution or attempted solutions that failed

My assumption is that the developer console generates a starter project with a manifest file that is compliant with version 3, which apparently is not supported in the specified version.

pklaschka commented

Thanks for reporting this, I'm looking into it.

pklaschka commented

I was able to verify this. The error message says that the name entry in the manifest.json is missing.

In the downloaded plugin, it's specified as "".

I'm forwarding this to the relevant teams internally 🙂

Temporary workaround

For now, you can just edit the manifest.json file and enter some arbitrary name and then, you'll be able to add the plugin to the UXP Developer Tool.

Alternatively, I would recommend creating a plugin directly from the UXP Developer Tool using the Create plugin... button (as the template is much more up to date).

Thanks again for reporting this 👍🙂!

  • 👍1
3phase commented

@pklaschka, thanks for the quick reply man 👍

In case anyone else comes across that same problem before Adobe have it fixed, another thing I had to edit in the manifest.json in order to use the template was the uiEntryPoints object. In v4 it's renamed to entrypoints, there's no commandId property anymore and the types have been slightly modified. Refer to the snippets below.

Manifest v3:

"uiEntryPoints" : [ 
	  {
		"type" : "menu",
		"commandId" : "createRectangle"
	  }
  ]

whereas the same functionality in v4 would be obtained with the following:

"entrypoints": [
    {
      "type": "command",
      "id": "createRectangle"
    }
  ]
  • 👍1