Skip to content

Conversation

rdswift
Copy link
Collaborator

@rdswift rdswift commented May 4, 2025

Summary

  • This is a…
    • Bug fix
    • Feature addition
    • Refactoring
    • Minor / simple change (like a typo)
    • Other
  • Describe this change in 1-2 sentences: Adds provision to register plugin created tags & variables

Problem

Tags and variables created by plugins do not appear in the autocomplete list or scripting documentation.

  • JIRA ticket (optional): PICARD-XXX

Solution

This PR provides the ability to register plugin-related tags and variables (when a plugin is enabled), and automatically removes (de-registers) the tags & variables when a plugin is no longer enabled.

Action

Additional actions required:

  • Update Picard documentation (please include a reference to this PR)
  • Other (please specify below)

@rdswift rdswift requested review from phw and zas May 4, 2025 20:34
@rdswift
Copy link
Collaborator Author

rdswift commented May 4, 2025

Need some input as to when to register the tags & variables (when a plugin is loaded or enabled), and whether they should be removed from ALL_TAGS when the plugin is disabled or when the plugin is removed. If not removed from ALL_TAGS until the plugin is removed, then there will need to be some filtering so that tags from installed but not enabled plugins do not appear in the autocomplete list or documentation.

I didn't want to go any further until we are sure that this conceptually fits in with the pending changes to the plugin management system.

@rdswift
Copy link
Collaborator Author

rdswift commented May 4, 2025

I also envision adding the name (or at least the ID) of the plugin to the full documentation display, and possibly to the tooltip display.

@zas
Copy link
Collaborator

zas commented May 4, 2025

I like it. Not sure if it should be merged yet though (we can merge and modify).
New plugin system is the thing we need to work on now, the idea of having a proper way to register variables is definitively the way to go.

@phw
Copy link
Member

phw commented May 5, 2025

Yes, we should integrate this once the new plugin system is in place. I'll get the current PR into a shape were we can continue from there.

@rdswift rdswift force-pushed the plugin_variables branch from 4bb7af2 to 94e9b86 Compare May 5, 2025 18:49
@rdswift rdswift mentioned this pull request May 11, 2025
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants