Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Cli.ProjectUtils

Contents

Project/path helpers
Name hydration
Loading local project info
Loading remote project info
Projecting out common things
Other helpers
Merge/upgrade branch utils
Export fields so we can use dot-notation

Description

Project-related utilities.

Synopsis

expectProjectBranchByName :: Project -> ProjectBranchName -> Cli ProjectBranch
resolveBranchRelativePath :: BranchRelativePath -> Cli ProjectPath
resolveProjectBranch :: ProjectAndBranch (Maybe ProjectName) (Maybe ProjectBranchName) -> Cli (ProjectAndBranch Project ProjectBranch)
resolveProjectBranchInProject :: Project -> ProjectAndBranch (Maybe ProjectName) (Maybe ProjectBranchName) -> Cli (ProjectAndBranch Project ProjectBranch)
hydrateNames :: These ProjectName ProjectBranchName -> Cli (ProjectAndBranch ProjectName ProjectBranchName)
expectProjectAndBranchByIds :: ProjectAndBranch ProjectId ProjectBranchId -> Transaction (ProjectAndBranch Project ProjectBranch)
getProjectAndBranchByTheseNames :: These ProjectName ProjectBranchName -> Cli (Maybe (ProjectAndBranch Project ProjectBranch))
getProjectAndBranchByNames :: ProjectAndBranch ProjectName ProjectBranchName -> Transaction (Maybe (ProjectAndBranch Project ProjectBranch))
getProjectByName :: ProjectName -> Cli (Maybe Project)
expectProjectAndBranchByTheseNames :: These ProjectName ProjectBranchName -> Cli (ProjectAndBranch Project ProjectBranch)
getProjectBranchCausalHash :: ProjectBranch -> Transaction CausalHash
expectRemoteProjectById :: RemoteProjectId -> ProjectName -> Cli RemoteProject
expectRemoteProjectByName :: ProjectName -> Cli RemoteProject
expectRemoteProjectBranchById :: IncludeSquashedHead -> ProjectAndBranch (RemoteProjectId, ProjectName) (RemoteProjectBranchId, ProjectBranchName) -> Cli RemoteProjectBranch
loadRemoteProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli (Maybe RemoteProjectBranch)
expectRemoteProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch (RemoteProjectId, ProjectName) ProjectBranchName -> Cli RemoteProjectBranch
loadRemoteProjectBranchByNames :: IncludeSquashedHead -> ProjectAndBranch ProjectName ProjectBranchName -> Cli (Maybe RemoteProjectBranch)
expectRemoteProjectBranchByNames :: IncludeSquashedHead -> ProjectAndBranch ProjectName ProjectBranchName -> Cli RemoteProjectBranch
expectRemoteProjectBranchByTheseNames :: IncludeSquashedHead -> These ProjectName ProjectBranchName -> Cli RemoteProjectBranch
justTheIds :: ProjectAndBranch Project ProjectBranch -> ProjectAndBranch ProjectId ProjectBranchId
justTheIds' :: ProjectBranch -> ProjectAndBranch ProjectId ProjectBranchId
justTheNames :: ProjectAndBranch Project ProjectBranch -> ProjectAndBranch ProjectName ProjectBranchName
findTemporaryBranchName :: ProjectId -> ProjectBranchName -> Transaction ProjectBranchName
expectLatestReleaseBranchName :: RemoteProject -> Cli ProjectBranchName
getMergeBranchParent :: ProjectBranch -> Maybe ProjectBranchId
getUpgradeBranchParent :: ProjectBranch -> Maybe ProjectBranchId
data ProjectBranch = ProjectBranch {
- projectId :: !ProjectId
- branchId :: !ProjectBranchId
- name :: !ProjectBranchName
- parentBranchId :: !(Maybe ProjectBranchId)
- isUpdate :: !Bool
- isUpgrade :: !Bool
}
data Project = Project {
- projectId :: !ProjectId
- name :: !ProjectName
}

Project/path helpers

expectProjectBranchByName :: Project -> ProjectBranchName -> Cli ProjectBranch Source #

resolveBranchRelativePath :: BranchRelativePath -> Cli ProjectPath Source #

resolveProjectBranch :: ProjectAndBranch (Maybe ProjectName) (Maybe ProjectBranchName) -> Cli (ProjectAndBranch Project ProjectBranch) Source #

Expect/resolve branch reference with the following rules:

If the project is missing, use the current project.
If we have an unambiguous `branch` or `projectbranch`, resolve it using the current project, defaulting to main if branch is unspecified.

resolveProjectBranchInProject :: Project -> ProjectAndBranch (Maybe ProjectName) (Maybe ProjectBranchName) -> Cli (ProjectAndBranch Project ProjectBranch) Source #

Expect/resolve branch reference with the following rules:

If the project is missing, use the provided project.
If we have an unambiguous `branch` or `projectbranch`, resolve it using the provided project, defaulting to main if branch is unspecified.

Name hydration

hydrateNames :: These ProjectName ProjectBranchName -> Cli (ProjectAndBranch ProjectName ProjectBranchName) Source #

Loading local project info

expectProjectAndBranchByIds :: ProjectAndBranch ProjectId ProjectBranchId -> Transaction (ProjectAndBranch Project ProjectBranch) Source #

getProjectAndBranchByTheseNames :: These ProjectName ProjectBranchName -> Cli (Maybe (ProjectAndBranch Project ProjectBranch)) Source #

getProjectAndBranchByNames :: ProjectAndBranch ProjectName ProjectBranchName -> Transaction (Maybe (ProjectAndBranch Project ProjectBranch)) Source #

getProjectByName :: ProjectName -> Cli (Maybe Project) Source #

expectProjectAndBranchByTheseNames :: These ProjectName ProjectBranchName -> Cli (ProjectAndBranch Project ProjectBranch) Source #

getProjectBranchCausalHash :: ProjectBranch -> Transaction CausalHash Source #

Get the causal hash of a project branch.

Loading remote project info

expectRemoteProjectById :: RemoteProjectId -> ProjectName -> Cli RemoteProject Source #

Expect a remote project by id. Its latest-known name is also provided, for error messages.

expectRemoteProjectByName :: ProjectName -> Cli RemoteProject Source #

expectRemoteProjectBranchById :: IncludeSquashedHead -> ProjectAndBranch (RemoteProjectId, ProjectName) (RemoteProjectBranchId, ProjectBranchName) -> Cli RemoteProjectBranch Source #

loadRemoteProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch RemoteProjectId ProjectBranchName -> Cli (Maybe RemoteProjectBranch) Source #

expectRemoteProjectBranchByName :: IncludeSquashedHead -> ProjectAndBranch (RemoteProjectId, ProjectName) ProjectBranchName -> Cli RemoteProjectBranch Source #

loadRemoteProjectBranchByNames :: IncludeSquashedHead -> ProjectAndBranch ProjectName ProjectBranchName -> Cli (Maybe RemoteProjectBranch) Source #

expectRemoteProjectBranchByNames :: IncludeSquashedHead -> ProjectAndBranch ProjectName ProjectBranchName -> Cli RemoteProjectBranch Source #

expectRemoteProjectBranchByTheseNames :: IncludeSquashedHead -> These ProjectName ProjectBranchName -> Cli RemoteProjectBranch Source #

Projecting out common things

justTheIds :: ProjectAndBranch Project ProjectBranch -> ProjectAndBranch ProjectId ProjectBranchId Source #

justTheIds' :: ProjectBranch -> ProjectAndBranch ProjectId ProjectBranchId Source #

justTheNames :: ProjectAndBranch Project ProjectBranch -> ProjectAndBranch ProjectName ProjectBranchName Source #

Other helpers

findTemporaryBranchName :: ProjectId -> ProjectBranchName -> Transaction ProjectBranchName Source #

expectLatestReleaseBranchName :: RemoteProject -> Cli ProjectBranchName Source #

Expect the given remote project to have a latest release, and return it as a valid branch name.

Merge/upgrade branch utils

getMergeBranchParent :: ProjectBranch -> Maybe ProjectBranchId Source #

getMergeBranchParent branch returns the parent branch of a "merge" branch.

When a merge fails, we put you on a branch called `merge-source-into-target`. That's a "merge" branch. It's not currently distinguished in the database, so we first just switch on whether its name begins with "merge-". If it does, then we get the branch's parent, which should exist, but perhaps wouldn't if the user had manually made a parentless branch called "merge-whatever" for whatever reason.

getUpgradeBranchParent :: ProjectBranch -> Maybe ProjectBranchId Source #

getUpgradeBranchParent branch returns the parent branch of an "upgrade" branch.

When an upgrade fails, we put you on a branch called `upgrade-old-to-new`. That's an "upgrade" branch. It's not currently distinguished in the database, so we first just switch on whether its name begins with "upgrade-". If it does, then we get the branch's parent, which should exist, but perhaps wouldn't if the user had manually made a parentless branch called "upgrade-whatever" for whatever reason.

Export fields so we can use dot-notation

data ProjectBranch #

A project branch.

Constructors

ProjectBranch
Fields projectId :: !ProjectId branchId :: !ProjectBranchId name :: !ProjectBranchName parentBranchId :: !(Maybe ProjectBranchId) isUpdate :: !Bool isUpgrade :: !Bool

Instances

Instances details

Generic ProjectBranch
Instance details Defined in U.Codebase.Sqlite.ProjectBranch Associated Types type Rep ProjectBranch :: Type -> Type # Methods from :: ProjectBranch -> Rep ProjectBranch x # to :: Rep ProjectBranch x -> ProjectBranch #
Show ProjectBranch
Instance details Defined in U.Codebase.Sqlite.ProjectBranch Methods showsPrec :: Int -> ProjectBranch -> ShowS # show :: ProjectBranch -> String # showList :: [ProjectBranch] -> ShowS #
Eq ProjectBranch
Instance details Defined in U.Codebase.Sqlite.ProjectBranch Methods (==) :: ProjectBranch -> ProjectBranch -> Bool # (/=) :: ProjectBranch -> ProjectBranch -> Bool #
Pathy ProjectPath
Instance details Defined in Unison.Codebase.ProjectPath Methods ascend :: ProjectPath -> Maybe ProjectPath # descend :: ProjectPath -> NameSegment -> ProjectPath # prefix :: ProjectPath -> Relative -> ProjectPath # split :: ProjectPath -> Maybe (Split ProjectPath) # unsplit :: Split ProjectPath -> ProjectPath # toText :: ProjectPath -> Text #
From ProjectPath Text
Instance details Defined in Unison.Codebase.ProjectPath Methods from :: ProjectPath -> Text #
type Rep ProjectBranch
Instance details Defined in U.Codebase.Sqlite.ProjectBranch type Rep ProjectBranch = D1 ('MetaData "ProjectBranch" "U.Codebase.Sqlite.ProjectBranch" "unison-codebase-sqlite-0.0.0-B6bSU9X4ngQLNkk2Du2PiW" 'False) (C1 ('MetaCons "ProjectBranch" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProjectId) :: (S1 ('MetaSel ('Just "branchId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProjectBranchId) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProjectBranchName))) :: (S1 ('MetaSel ('Just "parentBranchId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ProjectBranchId)) :: (S1 ('MetaSel ('Just "isUpdate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "isUpgrade") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))

data Project #

A project.

Constructors

Project
Fields projectId :: !ProjectId name :: !ProjectName

Instances

Instances details

Generic Project
Instance details Defined in U.Codebase.Sqlite.Project Associated Types type Rep Project :: Type -> Type # Methods from :: Project -> Rep Project x # to :: Rep Project x -> Project #
Show Project
Instance details Defined in U.Codebase.Sqlite.Project Methods showsPrec :: Int -> Project -> ShowS # show :: Project -> String # showList :: [Project] -> ShowS #
Eq Project
Instance details Defined in U.Codebase.Sqlite.Project Methods (==) :: Project -> Project -> Bool # (/=) :: Project -> Project -> Bool #
FromRow Project
Instance details Defined in U.Codebase.Sqlite.Project Methods fromRow :: RowParser Project #
ToRow Project
Instance details Defined in U.Codebase.Sqlite.Project Methods toRow :: Project -> [SQLData] #
Pathy ProjectPath
Instance details Defined in Unison.Codebase.ProjectPath Methods ascend :: ProjectPath -> Maybe ProjectPath # descend :: ProjectPath -> NameSegment -> ProjectPath # prefix :: ProjectPath -> Relative -> ProjectPath # split :: ProjectPath -> Maybe (Split ProjectPath) # unsplit :: Split ProjectPath -> ProjectPath # toText :: ProjectPath -> Text #
From ProjectPath Text
Instance details Defined in Unison.Codebase.ProjectPath Methods from :: ProjectPath -> Text #
type Rep Project
Instance details Defined in U.Codebase.Sqlite.Project type Rep Project = D1 ('MetaData "Project" "U.Codebase.Sqlite.Project" "unison-codebase-sqlite-0.0.0-B6bSU9X4ngQLNkk2Du2PiW" 'False) (C1 ('MetaCons "Project" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProjectId) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProjectName)))