Yarn.Lock.Types

Documentation

type Lockfile = MKMap PackageKey Package

Yarn lockfile.

It is a multi-keyed map (each value can be referenced by multiple keys). This is achieved by using an intermediate key ik.

Attention: Might be changed to a newtype in a future release.

lockfileIkProxy :: Proxy Int

Proxy type for our MKMap intermediate key

data PackageKey

Key that indexes package for a specific version.

Constructors

PackageKey

Fields

• name :: PackageKeyName

  package name

• npmVersionSpec :: Text

  tring that specifies the version of a package; sometimes a npm semver, sometimes an arbitrary string

Instances

Eq PackageKey

Defined in Yarn.Lock.Types

Methods

(==) :: PackageKey -> PackageKey -> Bool

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

Ord PackageKey

Defined in Yarn.Lock.Types

Methods

compare :: PackageKey -> PackageKey -> Ordering

(<) :: PackageKey -> PackageKey -> Bool

(<=) :: PackageKey -> PackageKey -> Bool

(>) :: PackageKey -> PackageKey -> Bool

(>=) :: PackageKey -> PackageKey -> Bool

max :: PackageKey -> PackageKey -> PackageKey

min :: PackageKey -> PackageKey -> PackageKey

Show PackageKey

Defined in Yarn.Lock.Types

Methods

showsPrec :: Int -> PackageKey -> ShowS

show :: PackageKey -> String

showList :: [PackageKey] -> ShowS

data PackageKeyName

The name of a package. They can be scoped, see | https://docs.npmjs.com/misc/scope for an explanation.

Constructors

SimplePackageKey Text

just a package name

ScopedPackageKey Text Text

a scope and a package name (e.g. @types/foobar)

Instances

Eq PackageKeyName

Defined in Yarn.Lock.Types

Methods

(==) :: PackageKeyName -> PackageKeyName -> Bool

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

Ord PackageKeyName

Defined in Yarn.Lock.Types

Methods

compare :: PackageKeyName -> PackageKeyName -> Ordering

(<) :: PackageKeyName -> PackageKeyName -> Bool

(<=) :: PackageKeyName -> PackageKeyName -> Bool

(>) :: PackageKeyName -> PackageKeyName -> Bool

(>=) :: PackageKeyName -> PackageKeyName -> Bool

max :: PackageKeyName -> PackageKeyName -> PackageKeyName

min :: PackageKeyName -> PackageKeyName -> PackageKeyName

Show PackageKeyName

Defined in Yarn.Lock.Types

Methods

showsPrec :: Int -> PackageKeyName -> ShowS

show :: PackageKeyName -> String

showList :: [PackageKeyName] -> ShowS

parsePackageKeyName :: Text -> Maybe PackageKeyName

Try to parse a string into a package key name (scoped or not).

data Keyed a

Something with a list of PackageKeys pointing to it.

Constructors

Keyed (NonEmpty PackageKey) a

Instances

Functor Keyed

Defined in Yarn.Lock.Types

Methods

fmap :: (a -> b) -> Keyed a -> Keyed b

(<$) :: a -> Keyed b -> Keyed a

Eq a => Eq (Keyed a)

Defined in Yarn.Lock.Types

Methods

(==) :: Keyed a -> Keyed a -> Bool

(/=) :: Keyed a -> Keyed a -> Bool

Ord a => Ord (Keyed a)

Defined in Yarn.Lock.Types

Methods

compare :: Keyed a -> Keyed a -> Ordering

(<) :: Keyed a -> Keyed a -> Bool

(<=) :: Keyed a -> Keyed a -> Bool

(>) :: Keyed a -> Keyed a -> Bool

(>=) :: Keyed a -> Keyed a -> Bool

max :: Keyed a -> Keyed a -> Keyed a

min :: Keyed a -> Keyed a -> Keyed a

Show a => Show (Keyed a)

Defined in Yarn.Lock.Types

Methods

showsPrec :: Int -> Keyed a -> ShowS

show :: Keyed a -> String

showList :: [Keyed a] -> ShowS

data Package

The actual npm package with dependencies and a way to download.

Constructors

Package

Fields

• version :: Text

  resolved, specific version

• remote :: Remote
• dependencies :: [PackageKey]

  list of dependencies

• optionalDependencies :: [PackageKey]

  list of optional dependencies

Instances

Eq Package

Defined in Yarn.Lock.Types

Methods

(==) :: Package -> Package -> Bool

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

Show Package

Defined in Yarn.Lock.Types

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

data Remote

Information on where to download the package.

Constructors

FileRemote

Fields

• fileUrl :: Text

  URL to a remote file

• fileSha1 :: Text

  sha1 hash of the file (attached to the link)

GitRemote

Fields

• gitRepoUrl :: Text

  valid git remote URL

• gitRev :: Text

  git tree-ish (commit, branch, &c.)

FileLocal

Fields

• fileLocalPath :: Text

  (relative) path to file on the local machine

• fileLocalSha1 :: Text

  sha1 hash of the file (attached to the link)

Instances

Eq Remote

Defined in Yarn.Lock.Types

Methods

(==) :: Remote -> Remote -> Bool

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

Show Remote

Defined in Yarn.Lock.Types

Methods

showsPrec :: Int -> Remote -> ShowS

show :: Remote -> String

showList :: [Remote] -> ShowS