Ide.Plugin.Config

Documentation

getConfigFromNotification :: IdePlugins s -> Config -> Value -> Either Text Config

Given a DidChangeConfigurationNotification message, this function returns the parsed Config object if possible.

data Config

We (initially anyway) mirror the hie configuration, so that existing clients can simply switch executable and not have any nasty surprises. There will be surprises relating to config options being ignored, initially though.

Constructors

Config

Fields

• checkParents :: CheckParents
• checkProject :: !Bool
• formattingProvider :: !Text
• cabalFormattingProvider :: !Text
• maxCompletions :: !Int
• plugins :: !(Map PluginId PluginConfig)

Instances

ToJSON Config

Defined in Ide.Types

Methods

toJSON :: Config -> Value

toEncoding :: Config -> Encoding

toJSONList :: [Config] -> Value

toEncodingList :: [Config] -> Encoding

Show Config

Defined in Ide.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Default Config

Defined in Ide.Types

Methods

def :: Config

Eq Config

Defined in Ide.Types

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

parseConfig :: IdePlugins s -> Config -> Value -> Parser Config

data PluginConfig

A PluginConfig is a generic configuration for a given HLS plugin. It provides a "big switch" to turn it on or off as a whole, as well as small switches per feature, and a slot for custom config. This provides a regular naming scheme for all plugin config.

Constructors

PluginConfig

Fields

• plcGlobalOn :: !Bool
• plcCallHierarchyOn :: !Bool
• plcCodeActionsOn :: !Bool
• plcCodeLensOn :: !Bool
• plcDiagnosticsOn :: !Bool
• plcHoverOn :: !Bool
• plcSymbolsOn :: !Bool
• plcCompletionOn :: !Bool
• plcRenameOn :: !Bool
• plcSelectionRangeOn :: !Bool
• plcFoldingRangeOn :: !Bool
• plcConfig :: !Object

Instances

ToJSON PluginConfig

Defined in Ide.Types

Methods

toJSON :: PluginConfig -> Value

toEncoding :: PluginConfig -> Encoding

toJSONList :: [PluginConfig] -> Value

toEncodingList :: [PluginConfig] -> Encoding

Show PluginConfig

Defined in Ide.Types

Methods

showsPrec :: Int -> PluginConfig -> ShowS

show :: PluginConfig -> String

showList :: [PluginConfig] -> ShowS

Default PluginConfig

Defined in Ide.Types

Methods

def :: PluginConfig

Eq PluginConfig

Defined in Ide.Types

Methods

(==) :: PluginConfig -> PluginConfig -> Bool

(/=) :: PluginConfig -> PluginConfig -> Bool

data CheckParents

Constructors

NeverCheck

CheckOnSave

AlwaysCheck

Instances

FromJSON CheckParents

Defined in Ide.Types

Methods

parseJSON :: Value -> Parser CheckParents

parseJSONList :: Value -> Parser [CheckParents]

ToJSON CheckParents

Defined in Ide.Types

Methods

toJSON :: CheckParents -> Value

toEncoding :: CheckParents -> Encoding

toJSONList :: [CheckParents] -> Value

toEncodingList :: [CheckParents] -> Encoding

Generic CheckParents

Defined in Ide.Types

Associated Types

type Rep CheckParents :: Type -> Type

Methods

from :: CheckParents -> Rep CheckParents x

to :: Rep CheckParents x -> CheckParents

Show CheckParents

Defined in Ide.Types

Methods

showsPrec :: Int -> CheckParents -> ShowS

show :: CheckParents -> String

showList :: [CheckParents] -> ShowS

Eq CheckParents

Defined in Ide.Types

Methods

(==) :: CheckParents -> CheckParents -> Bool

(/=) :: CheckParents -> CheckParents -> Bool

Ord CheckParents

Defined in Ide.Types

Methods

compare :: CheckParents -> CheckParents -> Ordering

(<) :: CheckParents -> CheckParents -> Bool

(<=) :: CheckParents -> CheckParents -> Bool

(>) :: CheckParents -> CheckParents -> Bool

(>=) :: CheckParents -> CheckParents -> Bool

max :: CheckParents -> CheckParents -> CheckParents

min :: CheckParents -> CheckParents -> CheckParents

type Rep CheckParents

Defined in Ide.Types

type Rep CheckParents = D1 ('MetaData "CheckParents" "Ide.Types" "hls-plugin-api-2.0.0.1-F0MLp1kxDa252ShnvMF0d5" 'False) (C1 ('MetaCons "NeverCheck" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CheckOnSave" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AlwaysCheck" 'PrefixI 'False) (U1 :: Type -> Type)))