HsDev.Commands

Commands

findDeclaration :: Database -> String -> ExceptT String IO [ModuleDeclaration]

Find declaration by name

findModule :: Database -> String -> ExceptT String IO [Module]

Find module by name

fileModule :: Database -> FilePath -> ExceptT String IO Module

Find module in file

lookupSymbol :: Database -> Cabal -> FilePath -> String -> ExceptT String IO [ModuleDeclaration]

Lookup visible within project/cabal symbol

whois :: Database -> Cabal -> FilePath -> String -> ExceptT String IO [Declaration]

Whois symbol in scope

scopeModules :: Database -> Cabal -> FilePath -> ExceptT String IO [Module]

Accessible modules

scope :: Database -> Cabal -> FilePath -> Bool -> ExceptT String IO [Declaration]

Symbols in scope

completions :: Database -> Cabal -> FilePath -> String -> Bool -> ExceptT String IO [Declaration]

Completions

moduleCompletions :: Database -> [Module] -> String -> ExceptT String IO [String]

Module completions

Filters

checkModule :: (ModuleId -> Bool) -> ModuleDeclaration -> Bool

Check module

checkDeclaration :: (Declaration -> Bool) -> ModuleDeclaration -> Bool

Check declaration

restrictCabal :: Cabal -> ModuleId -> Bool

Allow only selected cabal sandbox

visibleFrom :: Maybe Project -> Module -> ModuleId -> Bool

Check whether module is visible from source file

splitIdentifier :: String -> (Maybe String, String)

Split identifier into module name and identifier itself

Helpers

fileCtx :: Database -> FilePath -> ExceptT String IO (FilePath, Module, Maybe Project)

Get context file and project

fileCtxMaybe :: Database -> FilePath -> ExceptT String IO (FilePath, Maybe Module, Maybe Project)

Try get context file

Reexports

module HsDev.Database

module HsDev.Symbols.Types

module Control.Monad.Except