Yarn.Lock

The Yarn package manager improves on npm in that it writes yarn.lock files that contain a complete version resolution of all dependencies. This way a deterministic deployment can be guaranteed.

This module provides a parser for yarn.lock files.

Documentation

type Lockfile = Map PackageKey Package

Yarn lockfile.

data PackageKey

Key that indexes package for a specific version.

Constructors

PackageKey

Fields

• name :: Text

  package name

• npmSemver :: Text

  semver string

Instances

Eq PackageKey

Methods

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

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

Ord PackageKey

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

Methods

showsPrec :: Int -> PackageKey -> ShowS

show :: PackageKey -> String

showList :: [PackageKey] -> ShowS

data Package

The actual package with dependencies and download link.

Constructors

Package

Fields

• version :: Text

  resolved, specific version

• resolved :: RemoteFile

  download link w/ hash

• dependencies :: [PackageKey]

  list of dependencies

• optionalDependencies :: [PackageKey]

  list of optional dependencies

Instances

Eq Package

Methods

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

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

Show Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

data RemoteFile

A package download link.

Constructors

RemoteFile

Fields

• url :: Text
• sha1sum :: Text

Instances

Eq RemoteFile

Methods

(==) :: RemoteFile -> RemoteFile -> Bool

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

Show RemoteFile

Methods

showsPrec :: Int -> RemoteFile -> ShowS

show :: RemoteFile -> String

showList :: [RemoteFile] -> ShowS

type PackageEntry = ([PackageKey], Package)

A entry as it appears in the yarn.lock representation.

type PackageList = [PackageEntry]

Convenience alias.

parse

Arguments

:: Text

name of source file

-> Text

input for parser

-> Either Text Lockfile

Convenience function that converts errors to Text.

The actual parsers are below.

Parsers

lockfile :: Parser Lockfile

Convenience function that applies packageListToLockfile.

packageListToLockfile :: PackageList -> Lockfile

The yarn.lock file is basically a hashmap with multi-keyed entries.

This should press it into our Lockfile Map.

packageList :: Parser PackageList

Parse a complete yarn.lock into exaclty the same representation.

You can apply packageListToLockfile to make it usable.

packageEntry :: Parser PackageEntry

A single PackageEntry.

handlebars@^4.0.4:
  version "4.0.6"
  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.6.tgz#2ce4484850537f9c97a8026d5399b935c4ed4ed7"
  dependencies:
    async "^1.4.0"
    optimist "^0.6.1"
    source-map "^0.4.4"
  optionalDependencies:
    uglify-js "^2.6"

packageKeys :: Parser [PackageKey]

The list of PackageKeys that index the same Package

align-text^0.1.1, align-text^0.1.3:\n

packageKey :: Parser PackageKey

A packageKey is <package-name>@<semver>;

If the semver contains spaces, it is also quoted with ".

package :: Parser Package

Parses the content fields of a package.