Shikensu.Internal.Types

Types and path helpers. This is re-exported in the main Shikensu module.

Documentation

data Definition

A file definition, along with some additional properties.

Constructors

Definition

Fields

• basename :: String
• dirname :: FilePath
• extname :: String
• pattern :: String
• rootDirname :: FilePath
• workingDirname :: FilePath
• content :: Maybe ByteString
• metadata :: Metadata
• parentPath :: Maybe FilePath
• pathToRoot :: FilePath

Instances

Eq Definition

Defined in Shikensu.Internal.Types

Methods

(==) :: Definition -> Definition -> Bool

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

Show Definition

Defined in Shikensu.Internal.Types

Methods

showsPrec :: Int -> Definition -> ShowS

show :: Definition -> String

showList :: [Definition] -> ShowS

ToJSON Definition

Defined in Shikensu.Internal.Types

Methods

toJSON :: Definition -> Value

toEncoding :: Definition -> Encoding

toJSONList :: [Definition] -> Value

toEncodingList :: [Definition] -> Encoding

type Dictionary = [Definition]

type Metadata = KeyMap Value

absolutePath :: Definition -> String

localPath :: Definition -> String

workspacePath :: Definition -> String