Skip to content

Fix package metadata format#16911

Open
matdave wants to merge 1 commit intomodxcms:3.xfrom
matdave:3.x_package_desciption
Open

Fix package metadata format#16911
matdave wants to merge 1 commit intomodxcms:3.xfrom
matdave:3.x_package_desciption

Conversation

@matdave
Copy link
Copy Markdown
Contributor

@matdave matdave commented Feb 26, 2026

What does it do?

Adjust Processors\Workspace\Packages\GetList class's function getPackageMeta

Why is it needed?

At some point in the last 14-17 years, the provider started responding with a different model than what was expected. Rather than changing the provider and potentially breaking a lot more areas that work with the metadata field, I propose to change the processor.

How to test

Open your package management page /manager/?a=workspaces and try to expand an extra that was installed with the provider. It will expose an empty field.

Related issue(s)/PR(s)

This was pointed out in Community Slack

@matdave
Copy link
Copy Markdown
Contributor Author

matdave commented Feb 26, 2026

@Mark-H I don't know if you are responding from your provider differently. I noticed at least one extra that was empty, so I assume it's not using the weird method the GetList processor is expecting.

@opengeek opengeek changed the title fix(3.x): adjust package description check to match model in metadata Fix package metadata format Feb 27, 2026
Copy link
Copy Markdown
Collaborator

@smg6511 smg6511 left a comment

Choose a reason for hiding this comment

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

This fix works as expected and will be good to go with the requested change.

Another couple of changes to clean up the display within the grid would be nice too:
In index.scss L2335, change def to:

.package-readme {
  padding: 0 11px 8px 11px;
  font-style: italic;
}

And in package.grid.js L12, change XTemplate def to:

'<div class="package-readme">{readme}</div>'

On the last item, the original parent tag was <p>, which causes malformed html when a readme contains <p> tags as well.

Comment on lines +173 to +175
foreach ($metadata as $k => $v) {
if ($k === 'description') {
$packageArray['readme'] = nl2br($v);
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Basically like Joshua and Ivan suggested:

Suggested change
foreach ($metadata as $k => $v) {
if ($k === 'description') {
$packageArray['readme'] = nl2br($v);
foreach ($metadata as $key => $value) {
if ($key === 'description') {
$packageArray['readme'] = nl2br($value);

Copy link
Copy Markdown
Collaborator

@Ibochkarev Ibochkarev left a comment

Choose a reason for hiding this comment

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

👍

@smg6511
Copy link
Copy Markdown
Collaborator

smg6511 commented Mar 25, 2026

@matdave - Nudge ;-)

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.

4 participants