Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Add user visible info to PluginDescriptor #98

Closed
alanz opened this issue Nov 24, 2015 · 0 comments · Fixed by #111
Closed

Add user visible info to PluginDescriptor #98

alanz opened this issue Nov 24, 2015 · 0 comments · Fixed by #111
Labels
type: enhancement Well Defined Task - Awaiting PR
Milestone
prehistory

Comments

@alanz
Copy link
Collaborator

alanz commented Nov 24, 2015

At the moment a PluginDescriptor is defined as

data PluginDescriptor = PluginDescriptor
  { pdCommands        :: ![Command]
  , pdExposedServices :: ![Service]
  , pdUsedServices    :: ![Service]
  }

Add some fields to be used in the IDE UI as follows

data PluginDescriptor = PluginDescriptor
  { pdUIShortName     :: !T.Text
  , pdUIOverview      :: !T.Text
  , pdCommands        :: ![Command]
  , pdExposedServices :: ![Service]
  , pdUsedServices    :: ![Service]
  }

The pdUIShortName should be displayed in menus and the like, rather than the PluginId.
The pdUIOverview can be displayed in any kind of "more information" scenario about the plugin.
bergey added a commit to bergey/haskell-ide-engine that referenced this issue Nov 28, 2015
@bergey
add ShortName and Overview to PluginDescriptor
579b612 
Text descriptions intended for the editor user, rather than for
messages between the editor and HIE.

closes haskell#98
@bergey bergey mentioned this issue Nov 28, 2015
Merged
@alanz alanz added this to the prehistory milestone Feb 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
type: enhancement Well Defined Task - Awaiting PR
Projects
None yet
Milestone
prehistory
Development

Successfully merging a pull request may close this issue.

add ShortName and Overview to PluginDescriptor bergey/haskell-ide-engine
1 participant
@alanz