The name of a project.

Get the user slug at the beginning of a project name, if there is one.

>>> projectNameUserSlug "@arya/lens"
Just "arya"

>>> projectNameUserSlug "lens"
Nothing

Parse a "@arya/lens" into the "arya" and "lens" parts.

If there's no "arya" part, returns the empty string there.

>>> projectNameToUserProjectSlugs (UnsafeProjectName "@arya/lens")
("arya","lens")

>>> projectNameToUserProjectSlugs (UnsafeProjectName "lens")
("","lens")

Prepend a user slug to a project name, if it doesn't already have one.

>>> prependUserSlugToProjectName "arya" "lens"
"@arya/lens"

>>> prependUserSlugToProjectName "runar" "@unison/base"
"@unison/base"

>>> prependUserSlugToProjectName "???invalid???" "@unison/base"
"@unison/base"

The name of a branch of a project.

Get the user slug at the beginning of a project branch name, if there is one.

>>> projectBranchNameUserSlug "@arya/topic"
Just "arya"

>>> projectBranchNameUserSlug "topic"
Nothing

Mangle a project branch name into a text fragment that is itself a valid project branch name.

>>> TextBuilder.toText (projectBranchNameToValidProjectBranchNameText (UnsafeProjectBranchName "@arya/topic"))
"arya-topic"

>>> TextBuilder.toText (projectBranchNameToValidProjectBranchNameText (UnsafeProjectBranchName "releases/drafts/1.2.3"))
"releases-drafts-1-2-3"

>>> TextBuilder.toText (projectBranchNameToValidProjectBranchNameText (UnsafeProjectBranchName "releases/1.2.3"))
"releases-1-2-3"

>>> TextBuilder.toText (projectBranchNameToValidProjectBranchNameText (UnsafeProjectBranchName "topic"))
"topic"

Though a branch name is just a flat string, we have logic that handles certain strings specially.

A branch's name indicates it is exactly one of the following:

• A contributor branch like "@arya/topic"
• A draft release branch like "releasesdrafts1.2.3"
• A release branch like "releases/1.2.3"
• None of the above, like "topic"

Note these classifications are only tied to the branch's (mutable) name, and are not really otherwise indicative of much.

For instance,

• The existence of a local "releases/1.2.3" branch does not necessarily imply the existence of some remote release version "1.2.3".
• The existence of a local "arya/topic branch does not necessarily imply the existence of some remote "arya" user made some "topic" branch at some point.

That said, we do try to make the system mostly make sense by rejecting certain inputs (e.g. you should not be able to easily create a local branch called "releases/1.2.3" out of thin air; you should have to clone it from somewhere). But ultimately, again, branch names are best thought of as opaque, flat strings.

Classify a project branch name.

>>> classifyProjectBranchName "@arya/topic"
Contributor "arya" "topic"

>>> classifyProjectBranchName "releases/drafts/1.2.3"
DraftRelease (Semver 1 2 3)

>>> classifyProjectBranchName "releases/1.2.3"
Release (Semver 1 2 3)

>>> classifyProjectBranchName "topic"
NothingSpecial

A project branch name, or the latest release of its project.

How a project branch can be specified.

A generic data structure that contains information about a project and a branch in that project.

Parse a fully specified myproject/mybranch name.

>>> import Text.Megaparsec (parseMaybe)
>>> parseMaybe fullyQualifiedProjectAndBranchNamesParser ("myproject/mybranch" :: Text)
Just (ProjectAndBranch {project = UnsafeProjectName "myproject", branch = UnsafeProjectBranchName "mybranch"})

Sometimes, it's convenient (to users) if we defer interpreting certain names (like "foo") as a project name or branch name, instead leaving it up to a command handler to handle the ambiguity.

For example, we might want "switch foo" to switch to either the project "foo", or the branch "foo", or complain if both exist.

This type is useful for those situtations.