Yarn.Lock.Types

Description

Synopsis

Documentation

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.

Proxy type for our MKMap intermediate key

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 details

Eq PackageKey Source #
Instance details Defined in Yarn.Lock.Types Methods (==) :: PackageKey -> PackageKey -> Bool # (/=) :: PackageKey -> PackageKey -> Bool #
Ord PackageKey Source #
Instance details 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 Source #
Instance details Defined in Yarn.Lock.Types Methods showsPrec :: Int -> PackageKey -> ShowS # show :: PackageKey -> String # showList :: [PackageKey] -> ShowS #

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 details

Eq PackageKeyName Source #
Instance details Defined in Yarn.Lock.Types Methods (==) :: PackageKeyName -> PackageKeyName -> Bool # (/=) :: PackageKeyName -> PackageKeyName -> Bool #
Ord PackageKeyName Source #
Instance details 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 Source #
Instance details Defined in Yarn.Lock.Types Methods showsPrec :: Int -> PackageKeyName -> ShowS # show :: PackageKeyName -> String # showList :: [PackageKeyName] -> ShowS #

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

Something with a list of PackageKeys pointing to it.

Constructors

Instances details

Functor Keyed Source #
Instance details Defined in Yarn.Lock.Types Methods fmap :: (a -> b) -> Keyed a -> Keyed b # (<$) :: a -> Keyed b -> Keyed a #
Eq a => Eq (Keyed a) Source #
Instance details Defined in Yarn.Lock.Types Methods (==) :: Keyed a -> Keyed a -> Bool # (/=) :: Keyed a -> Keyed a -> Bool #
Ord a => Ord (Keyed a) Source #
Instance details 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) Source #
Instance details Defined in Yarn.Lock.Types Methods showsPrec :: Int -> Keyed a -> ShowS # show :: Keyed a -> String # showList :: [Keyed a] -> ShowS #

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 details

Eq Package Source #
Instance details Defined in Yarn.Lock.Types Methods (==) :: Package -> Package -> Bool # (/=) :: Package -> Package -> Bool #
Show Package Source #
Instance details Defined in Yarn.Lock.Types Methods showsPrec :: Int -> Package -> ShowS # show :: Package -> String # showList :: [Package] -> ShowS #

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)
FileRemoteNoIntegrity
Fields fileNoIntegrityUrl :: Text URL to a remote file
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)
FileLocalNoIntegrity
Fields fileLocalNoIntegrityPath :: Text (relative) path to file on the local machine

Instances details

Eq Remote Source #
Instance details Defined in Yarn.Lock.Types Methods (==) :: Remote -> Remote -> Bool # (/=) :: Remote -> Remote -> Bool #
Show Remote Source #
Instance details Defined in Yarn.Lock.Types Methods showsPrec :: Int -> Remote -> ShowS # show :: Remote -> String # showList :: [Remote] -> ShowS #