Skip to content

BUG: Change Trame.json to SlicerTrame.json #2193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2025

Conversation

jcfr
Copy link
Member

@jcfr jcfr commented Aug 8, 2025

Renames the extension catalog entry file from Trame.json to SlicerTrame.json for consistency with the extension's advertised1 purpose and name. This avoids confusion with the broader trame project.

This change also addresses the CI packaging failure reported on CDash:

Package and upload extension
CPack log: /.../Trame-build/inner-build/packageupload_cpack_output.txt
CMake Error at C:/D/P/S-0/Extensions/CMake/SlicerFunctionExtractExtensionDescription.cmake:135 (message):
CUSTOMBUILD : error : EXTENSION_FILE CMake variable points to a inexistent file or [C:\D\P\S-0-E-b\Trame-build\inner-build\packageupload.vcxproj]
    directory: /.../Trame-build/inner-build/SlicerTrame.json
Call Stack (most recent call first):
  C:/D/P/S-0/Extensions/CMake/SlicerExtensionPackageAndUploadTarget.cmake:210 (slicerFunctionExtractExtensionDescriptionFromJson)

By aligning the file name with the actual extension name, the build process can correctly locate the JSON descriptor, unblocking packaging.

Important

Consider reverting 86ef52b in the SlicerTrame repository for consistent naming. A force-push may be appropriate.

Related pull requests:

@Thibault-Pelletier

Footnotes

  1. https://github.com/KitwareMedical/SlicerTrame?tab=readme-ov-file#slicertrame

Renames the extension catalog entry file from `Trame.json` to `SlicerTrame.json`
for consistency with the extension's advertised purpose and name. This avoids
confusion with the broader Trame project.

This aligns the file name with the actual extension name and
prevents ambiguity with the upstream `trame` framework.
@jcfr jcfr force-pushed the rename-Trame-to-SlicerTrame branch from f9ea835 to 3d62a9a Compare August 8, 2025 04:28
@Thibault-Pelletier Thibault-Pelletier requested review from Thibault-Pelletier and removed request for Thibault-Pelletier August 8, 2025 05:43
@Thibault-Pelletier
Copy link
Contributor

Thanks for the push!
This looks good to me. I removed the renaming from the SlicerTrame repo and kept the CMake rework to make the different CMake variables follow the EXTENSION_NAME instead of the raw SlicerTrame string.

@Thibault-Pelletier Thibault-Pelletier merged commit 86803a9 into Slicer:main Aug 8, 2025
3 of 4 checks passed
@lassoan
Copy link
Contributor

lassoan commented Aug 8, 2025

In general, using "Slicer" as a prefix in a Slicer extension name is redundant and makes it harder to find extensions (as your need to look for Abc and SlicerAbc in the extensions list). But this might be a rare case where it makes sense - if we expect to have various trame applications in the extensions index (SlicerTrame, SimpleSegmenterTrame, CardioViewTrame, ...), or if we intend to provide a new general-purpose trame extension in the future where the user can choose between several applications.

If we anticipate to only offer Slicer as a trame application in the extension manager then it is better to keep the simple "Trame" name. Or maybe it would be even better for users (easier to discove, easier to remember) to choose a name that reflects what the extension is used for (WebUI, RemoteAccess, etc) instead of naming it based on some of the underlying technology that the user has never heard of. It could also make sense to convince the two, such as TrameWebUI to advertise the trame brand while also allow users to guess what the extension could be about.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants