Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Codebase.Transcript

Description

The data model for Unison transcripts.

Synopsis

type ExpectingError = Bool
type HasBug = Bool
type ScratchFileName = Text
data Hidden
- = Shown
- | HideOutput
- | HideAll
data UcmLine
- = UcmCommand UcmContext Text
- | UcmComment Text
- | UcmOutputLine Text
data UcmContext
- = UcmContextEmpty
- | UcmContextProject (ProjectAndBranch ProjectName ProjectBranchName)
data APIRequest
- = GetRequest Text
- | PostRequest Text Text
- | APIComment Text
- | APIResponse Text
pattern CMarkCodeBlock :: Maybe PosInfo -> Text -> Text -> Node
type Stanza = Either Node ProcessedBlock
data InfoTags a = InfoTags {
- hidden :: Maybe Hidden
- expectingError :: ExpectingError
- hasBug :: HasBug
- generated :: Bool
- additionalTags :: a
}
getCommonInfoTags :: ProcessedBlock -> InfoTags ()
data Transcript = Transcript {
- frontmatter :: Value
- stanzas :: [Stanza]
}
settings :: Transcript -> Settings
data TranscriptType
- = Standard
- | Tutorial
data Behaviors f = Behaviors {
- autoupdate :: f Bool
- getHidden :: f (ProcessedBlock -> Hidden)
}
extractBehaviors :: Settings -> Behaviors Identity
data Settings = Settings {
- transcriptType :: Maybe TranscriptType
- behaviors :: Behaviors Maybe
}
defaultInfoTags :: a -> InfoTags a
data ProcessedBlock
- = Ucm (InfoTags ()) [UcmLine]
- | Unison (InfoTags (Maybe ScratchFileName)) Text
- | API (InfoTags ()) [APIRequest]
data Node

Documentation

type ExpectingError = Bool Source #

type HasBug = Bool Source #

type ScratchFileName = Text Source #

data Hidden Source #

Constructors

Shown
HideOutput
HideAll

Instances

Instances details

Read Hidden Source #
Instance details Defined in Unison.Codebase.Transcript Methods readsPrec :: Int -> ReadS Hidden # readList :: ReadS [Hidden] # readPrec :: ReadPrec Hidden # readListPrec :: ReadPrec [Hidden] #
Show Hidden Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> Hidden -> ShowS # show :: Hidden -> String # showList :: [Hidden] -> ShowS #
Eq Hidden Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: Hidden -> Hidden -> Bool # (/=) :: Hidden -> Hidden -> Bool #
Ord Hidden Source #
Instance details Defined in Unison.Codebase.Transcript Methods compare :: Hidden -> Hidden -> Ordering # (<) :: Hidden -> Hidden -> Bool # (<=) :: Hidden -> Hidden -> Bool # (>) :: Hidden -> Hidden -> Bool # (>=) :: Hidden -> Hidden -> Bool # max :: Hidden -> Hidden -> Hidden # min :: Hidden -> Hidden -> Hidden #

data UcmLine Source #

Constructors

UcmCommand UcmContext Text
UcmComment Text	Text does not include the '--' prefix.
UcmOutputLine Text

Instances

Instances details

Show UcmLine Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> UcmLine -> ShowS # show :: UcmLine -> String # showList :: [UcmLine] -> ShowS #
Eq UcmLine Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: UcmLine -> UcmLine -> Bool # (/=) :: UcmLine -> UcmLine -> Bool #

data UcmContext Source #

Where a command is run: a project branch (myproject/mybranch>).

Constructors

UcmContextEmpty	Use the current project & branch
UcmContextProject (ProjectAndBranch ProjectName ProjectBranchName)	Explicit project & branch

Instances

Instances details

Show UcmContext Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> UcmContext -> ShowS # show :: UcmContext -> String # showList :: [UcmContext] -> ShowS #
Eq UcmContext Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: UcmContext -> UcmContext -> Bool # (/=) :: UcmContext -> UcmContext -> Bool #

data APIRequest Source #

Constructors

GetRequest Text
PostRequest Text Text	URL, Body
APIComment Text
APIResponse Text

Instances

Instances details

Show APIRequest Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> APIRequest -> ShowS # show :: APIRequest -> String # showList :: [APIRequest] -> ShowS #
Eq APIRequest Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: APIRequest -> APIRequest -> Bool # (/=) :: APIRequest -> APIRequest -> Bool #

pattern CMarkCodeBlock :: Maybe PosInfo -> Text -> Text -> Node Source #

type Stanza = Either Node ProcessedBlock Source #

data InfoTags a Source #

Constructors

InfoTags
Fields hidden :: Maybe Hidden `Nothing` represents the default value, which differs depending on the `TranscriptType` and `ProcessedBlock` tag. expectingError :: ExpectingError hasBug :: HasBug generated :: Bool additionalTags :: a

Instances

Instances details

Foldable InfoTags Source #
Instance details Defined in Unison.Codebase.Transcript Methods fold :: Monoid m => InfoTags m -> m # foldMap :: Monoid m => (a -> m) -> InfoTags a -> m # foldMap' :: Monoid m => (a -> m) -> InfoTags a -> m # foldr :: (a -> b -> b) -> b -> InfoTags a -> b # foldr' :: (a -> b -> b) -> b -> InfoTags a -> b # foldl :: (b -> a -> b) -> b -> InfoTags a -> b # foldl' :: (b -> a -> b) -> b -> InfoTags a -> b # foldr1 :: (a -> a -> a) -> InfoTags a -> a # foldl1 :: (a -> a -> a) -> InfoTags a -> a # toList :: InfoTags a -> [a] # null :: InfoTags a -> Bool # length :: InfoTags a -> Int # elem :: Eq a => a -> InfoTags a -> Bool # maximum :: Ord a => InfoTags a -> a # minimum :: Ord a => InfoTags a -> a # sum :: Num a => InfoTags a -> a # product :: Num a => InfoTags a -> a #
Traversable InfoTags Source #
Instance details Defined in Unison.Codebase.Transcript Methods traverse :: Applicative f => (a -> f b) -> InfoTags a -> f (InfoTags b) # sequenceA :: Applicative f => InfoTags (f a) -> f (InfoTags a) # mapM :: Monad m => (a -> m b) -> InfoTags a -> m (InfoTags b) # sequence :: Monad m => InfoTags (m a) -> m (InfoTags a) #
Functor InfoTags Source #
Instance details Defined in Unison.Codebase.Transcript Methods fmap :: (a -> b) -> InfoTags a -> InfoTags b # (<$) :: a -> InfoTags b -> InfoTags a #
Read a => Read (InfoTags a) Source #
Instance details Defined in Unison.Codebase.Transcript Methods readsPrec :: Int -> ReadS (InfoTags a) # readList :: ReadS [InfoTags a] # readPrec :: ReadPrec (InfoTags a) # readListPrec :: ReadPrec [InfoTags a] #
Show a => Show (InfoTags a) Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> InfoTags a -> ShowS # show :: InfoTags a -> String # showList :: [InfoTags a] -> ShowS #
Eq a => Eq (InfoTags a) Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: InfoTags a -> InfoTags a -> Bool # (/=) :: InfoTags a -> InfoTags a -> Bool #
Ord a => Ord (InfoTags a) Source #
Instance details Defined in Unison.Codebase.Transcript Methods compare :: InfoTags a -> InfoTags a -> Ordering # (<) :: InfoTags a -> InfoTags a -> Bool # (<=) :: InfoTags a -> InfoTags a -> Bool # (>) :: InfoTags a -> InfoTags a -> Bool # (>=) :: InfoTags a -> InfoTags a -> Bool # max :: InfoTags a -> InfoTags a -> InfoTags a # min :: InfoTags a -> InfoTags a -> InfoTags a #

getCommonInfoTags :: ProcessedBlock -> InfoTags () Source #

data Transcript Source #

A transcript is executable Markdown, akin to a Jupyter Notebook.

NB: This is effectively the AST. It needs to preserve anything we want to be able to serialize into transcript output.

Constructors

Transcript
Fields frontmatter :: Value stanzas :: [Stanza]

Instances

Instances details

Show Transcript Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> Transcript -> ShowS # show :: Transcript -> String # showList :: [Transcript] -> ShowS #

settings :: Transcript -> Settings Source #

data TranscriptType Source #

Different types make various settingal changes.

Constructors

Standard	The default type, nothing changed from the default setting.
Tutorial	Enables auto-update and changes the default hidden value for `Unison` blocks to `HideOutput`.

Instances

Instances details

ToJSON TranscriptType Source #
Instance details Defined in Unison.Codebase.Transcript Methods toJSON :: TranscriptType -> Value # toEncoding :: TranscriptType -> Encoding # toJSONList :: [TranscriptType] -> Value # toEncodingList :: [TranscriptType] -> Encoding #
Read TranscriptType Source #
Instance details Defined in Unison.Codebase.Transcript Methods readsPrec :: Int -> ReadS TranscriptType # readList :: ReadS [TranscriptType] # readPrec :: ReadPrec TranscriptType # readListPrec :: ReadPrec [TranscriptType] #
Show TranscriptType Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> TranscriptType -> ShowS # show :: TranscriptType -> String # showList :: [TranscriptType] -> ShowS #
Eq TranscriptType Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: TranscriptType -> TranscriptType -> Bool # (/=) :: TranscriptType -> TranscriptType -> Bool #
Ord TranscriptType Source #
Instance details Defined in Unison.Codebase.Transcript Methods compare :: TranscriptType -> TranscriptType -> Ordering # (<) :: TranscriptType -> TranscriptType -> Bool # (<=) :: TranscriptType -> TranscriptType -> Bool # (>) :: TranscriptType -> TranscriptType -> Bool # (>=) :: TranscriptType -> TranscriptType -> Bool # max :: TranscriptType -> TranscriptType -> TranscriptType # min :: TranscriptType -> TranscriptType -> TranscriptType #

data Behaviors f Source #

The atomic behaviors that can be controlled by settings. They may be set individually, or implied by some aggregate setting.

Constructors

Behaviors
Fields autoupdate :: f Bool getHidden :: f (ProcessedBlock -> Hidden)

Instances

Instances details

Monoid (Behaviors Maybe) Source #
Instance details Defined in Unison.Codebase.Transcript Methods mempty :: Behaviors Maybe # mappend :: Behaviors Maybe -> Behaviors Maybe -> Behaviors Maybe # mconcat :: [Behaviors Maybe] -> Behaviors Maybe #
Semigroup (Behaviors Maybe) Source #
Instance details Defined in Unison.Codebase.Transcript Methods (<>) :: Behaviors Maybe -> Behaviors Maybe -> Behaviors Maybe # sconcat :: NonEmpty (Behaviors Maybe) -> Behaviors Maybe # stimes :: Integral b => b -> Behaviors Maybe -> Behaviors Maybe #
Show1 f => Show (Behaviors f) Source #	`Behaviors` _may_ contain functions, so this instance outputs “_” in place of any functions.
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> Behaviors f -> ShowS # show :: Behaviors f -> String # showList :: [Behaviors f] -> ShowS #

extractBehaviors :: Settings -> Behaviors Identity Source #

data Settings Source #

A set of customizable settings for a transcript.

Constructors

Settings
Fields transcriptType :: Maybe TranscriptType behaviors :: Behaviors Maybe

Instances

Instances details

FromJSON Settings Source #
Instance details Defined in Unison.Codebase.Transcript Methods parseJSON :: Value -> Parser Settings # parseJSONList :: Value -> Parser [Settings] #
ToJSON Settings Source #
Instance details Defined in Unison.Codebase.Transcript Methods toJSON :: Settings -> Value # toEncoding :: Settings -> Encoding # toJSONList :: [Settings] -> Value # toEncodingList :: [Settings] -> Encoding #
Monoid Settings Source #
Instance details Defined in Unison.Codebase.Transcript Methods mempty :: Settings # mappend :: Settings -> Settings -> Settings # mconcat :: [Settings] -> Settings #
Semigroup Settings Source #
Instance details Defined in Unison.Codebase.Transcript Methods (<>) :: Settings -> Settings -> Settings # sconcat :: NonEmpty Settings -> Settings # stimes :: Integral b => b -> Settings -> Settings #
Show Settings Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> Settings -> ShowS # show :: Settings -> String # showList :: [Settings] -> ShowS #

defaultInfoTags :: a -> InfoTags a Source #

data ProcessedBlock Source #

Constructors

Ucm (InfoTags ()) [UcmLine]
Unison (InfoTags (Maybe ScratchFileName)) Text
API (InfoTags ()) [APIRequest]

Instances

Instances details

Show ProcessedBlock Source #
Instance details Defined in Unison.Codebase.Transcript Methods showsPrec :: Int -> ProcessedBlock -> ShowS # show :: ProcessedBlock -> String # showList :: [ProcessedBlock] -> ShowS #
Eq ProcessedBlock Source #
Instance details Defined in Unison.Codebase.Transcript Methods (==) :: ProcessedBlock -> ProcessedBlock -> Bool # (/=) :: ProcessedBlock -> ProcessedBlock -> Bool #

data Node #

Instances

Instances details

Data Node
Instance details Defined in CMark Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Node -> c Node # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Node # toConstr :: Node -> Constr # dataTypeOf :: Node -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Node) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Node) # gmapT :: (forall b. Data b => b -> b) -> Node -> Node # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r # gmapQ :: (forall d. Data d => d -> u) -> Node -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Node -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Node -> m Node # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #
Generic Node
Instance details Defined in CMark Associated Types type Rep Node :: Type -> Type # Methods from :: Node -> Rep Node x # to :: Rep Node x -> Node #
Read Node
Instance details Defined in CMark Methods readsPrec :: Int -> ReadS Node # readList :: ReadS [Node] # readPrec :: ReadPrec Node # readListPrec :: ReadPrec [Node] #
Show Node
Instance details Defined in CMark Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
Eq Node
Instance details Defined in CMark Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Ord Node
Instance details Defined in CMark Methods compare :: Node -> Node -> Ordering # (<) :: Node -> Node -> Bool # (<=) :: Node -> Node -> Bool # (>) :: Node -> Node -> Bool # (>=) :: Node -> Node -> Bool # max :: Node -> Node -> Node # min :: Node -> Node -> Node #
type Rep Node
Instance details Defined in CMark type Rep Node = D1 ('MetaData "Node" "CMark" "cmark-0.6.1-Ll0dX5qpF6PEeRr1RSJhdm" 'False) (C1 ('MetaCons "Node" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PosInfo)) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeType) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Node]))))