[manuelleduc]

Jira URL

https://jira.xwiki.org/browse/XCOMMONS-3862

Changes

Description

• Declare the macros of the box, comment, content, footnotes, html, id, message, raw and toc macro modules (12 macros) in xwiki.extension.components, so that the Extension Manager can suggest installing them.
• Exclude the internal ctsdata (rendering compatibility test suite) and putFootnotes (inserted by the footnote macro) macros with the xwiki.extension.components.macros.check.excluded Maven property, so that the editor doesn't suggest installing them.

Clarifications

• Depends on XCOMMONS-3862: Add a build check verifying that the provided macros are declared in xwiki.extension.components xwiki-commons#2104, which adds the check. This PR must be merged right after it, since the build fails without these declarations.
• Each module's list comes from the errors of the new check on a full build. Each entry is the hint of a macro the module provides.

Screenshots & Video

N/A, build-only change.

Executed Tests

• Full mvn -B -ntp install -DskipTests against the commons branch of XCOMMONS-3862: Add a build check verifying that the provided macros are declared in xwiki.extension.components xwiki-commons#2104: it fails without this change, with one error per missing macro, and passes with it.
• mvn -B -ntp verify -Pquality -DskipTests on the ctsreport and footnotes modules after adding the exclusions. Emptying the exclusions with -Dxwiki.extension.components.macros.check.excluded= makes the footnotes build fail on putFootnotes.

Expected merging strategy

• Prefers squash: Yes
• Backport on branches:
  • None

🤖 Generated with Claude Code

[tmortagne]

I'm surprised to not see any mention of xwiki-platform-rendering-wikimacro-store (which contain java macros). Note that I don't think we should expose those macros in the index as they don't really make sense on their own.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[manuelleduc]

I'm surprised to not see any mention of xwiki-platform-rendering-wikimacro-store (which contain java macros). Note that I don't think we should expose those macros in the index as they don't really make sense on their own.

Good catch, thanks.

This module is in xwiki-platform, so it's probably a comment for xwiki/xwiki-platform#7232 ;)

The check never reported it because it crashed on this module: DefaultWikiMacro has its own class as component role, making Spoon crash.

I updated xwiki/xwiki-commons#2104 accordingly, and excluded wikimacrocontent and wikimacroparameter in xwiki/xwiki-platform#7232

[tmortagne]

This module is in xwiki-platform, so it's probably a comment for xwiki/xwiki-platform#7232 ;)

I could not find the comment anymore on xwiki-platform and finally noticed I had put it on the wrong PR...

[tmortagne]

Not that it's allowed to use this macro (when you want the footnotes to be inserted in a specific location). But it would probably be noise from macro index point of view, so I would suggest keeping the exclusion.