-
Notifications
You must be signed in to change notification settings - Fork 0
Debugging and Troubleshooting
Joshua Ivoe edited this page Apr 13, 2026
·
1 revision
Use this guide when a plugin or integration fails to load, does not render settings, or breaks command/menu behavior.
- Confirm build succeeded
- Run host tests
- Check plugin manifest compatibility range
- Verify plugin id uniqueness
- Validate command id registration matches menu contribution
- Verify settings page ids and field definitions
If configuration fails after path changes:
- remove build/CMakeCache.txt
- remove build/CMakeFiles
- remove build/_deps
- reconfigure and rebuild
Check:
- manifest id, displayName, version are non-empty
- minHostApiVersion and maxHostApiVersion include current host API
- plugin id does not collide with existing plugin
Reference:
Check:
- plugin declares settings_pages capability
- RegisterPage is called during Initialize
- pageId is unique
- field keys are non-empty and valid
- Enum fields include options
Schema reference:
Check:
- command registered in commandDispatcher
- menu contribution command id exactly matches
- invocation context exists for space-specific commands
Check:
- values are written to settings store path
- expected key names were not changed accidentally
- migration fallback keys still resolve
Persistence references:
Check:
- key observer wiring for theme/app appearance keys
- fallback behavior still applies when new keys missing
- conflicts with alternate appearance plugins are logged and isolated
cmake --build build --config Debug
.\build\Debug\HostCoreTests.exeIf issue is unclear after triage:
- collect reproducible steps
- capture relevant logs and settings keys
- identify whether issue belongs to Spaces, Spaces-Plugins, or Themes
- open issue with scope and reproduction details