NixFromNpm

Documentation

module ClassyPrelude

module Control.Applicative

module Control.Exception

module Control.Exception.ErrorList

module Control.Monad

module Control.Monad.Except

module Control.Monad.Identity

module Control.Monad.State.Strict

module Control.Monad.Reader

module Control.Monad.Trans

module Data.Char

module Data.Default

module Data.HashMap.Strict

module Data.Either

module Data.Maybe

module Data.List

module Data.String.Utils

module GHC.Exts

module Filesystem.Path.CurrentOS

module Network.URI

module GHC.IO.Exception

module System.Directory

module Text.Render

module System.FilePath.Posix

type Name = Text

Indicates that the text is some identifier.

type Record = HashMap Name

A record is a lookup table with string keys.

tuple :: Applicative f => f a -> f b -> f (a, b)

Takes two applicative actions and returns their result as a 2-tuple.

tuple3 :: Applicative f => f a -> f b -> f c -> f (a, b, c)

Takes three applicative actions and returns their result as a 3-tuple.

fromRight :: Either a b -> b

cerror :: [String] -> a

cerror' :: [Text] -> a

uriToText :: URI -> Text

uriToString :: URI -> String

slash :: URI -> Text -> URI infixl 6

Appends text to URI with a slash. Ex: foo.com slash bar == foo.com/bar.

putStrsLn :: MonadIO m => [Text] -> m ()

pathToText :: FilePath -> Text

putStrs :: MonadIO m => [Text] -> m ()

dropSuffix :: String -> String -> String

maybeIf :: Bool -> a -> Maybe a

grab :: (Hashable k, Eq k) => k -> HashMap k v -> v

withDir :: String -> IO a -> IO a

pathToString :: FilePath -> String

joinBy :: Text -> [Text] -> Text

mapJoinBy :: Text -> (a -> Text) -> [a] -> Text

type SemVer = (Int, Int, Int)

data Wildcard

A partially specified semantic version. Implicitly defines a range of acceptable versions, as seen in wildcardToRange.

Constructors

Any

One Int

Two Int Int

Three Int Int Int

Instances

Eq Wildcard

Show Wildcard

data SemVerRange

Constructors

Eq SemVer

Gt SemVer

Lt SemVer

Geq SemVer

Leq SemVer

And SemVerRange SemVerRange

Or SemVerRange SemVerRange

Instances

Eq SemVerRange

Show SemVerRange

renderSV :: SemVer -> Text

renderSV' :: SemVer -> String

matches :: SemVerRange -> SemVer -> Bool

Returns whether a given semantic version matches a range.

bestMatch :: SemVerRange -> [SemVer] -> Either String SemVer

Gets the highest-matching semver in a range.

wildcardToSemver :: Wildcard -> SemVer

Fills in zeros in a wildcard.

wildcardToRange :: Wildcard -> SemVerRange

Translates a wildcard (partially specified version) to a range. Ex: 2 := >=2.0.0 <3.0.0 Ex: 1.2.x := 1.2 := >=1.2.0 <1.3.0

tildeToRange :: Wildcard -> SemVerRange

Translates a ~wildcard to a range. Ex: ~1.2.3 := >=1.2.3 :==1.2.3 <1.3.0

caratToRange :: Wildcard -> SemVerRange

Translates a ^wildcard to a range. Ex: ^1.2.x := >=1.2.0 <2.0.0

hyphenatedRange :: Wildcard -> Wildcard -> SemVerRange

Translates two hyphenated wildcards to an actual range. Ex: 1.2.3 - 2.3.4 := >=1.2.3 <=2.3.4 Ex: 1.2 - 2.3.4 := >=1.2.0 <=2.3.4 Ex: 1.2.3 - 2 := >=1.2.3 <3.0.0

parseSemVer :: Text -> Either ParseError SemVer

Parse a string as an explicit version, or return an error.

parseSemVerRange :: Text -> Either ParseError SemVerRange

Parse a string as a version range, or return an error.

pSemVerRange :: Parser SemVerRange

Top-level parser. Parses a semantic version range.

pSemVer :: Parser SemVer

Parses a semantic version.

data GitSource

Constructors

Github

Bitbucket

Gist

GitLab

Instances

Eq GitSource

Show GitSource

data NpmVersionRange

Constructors

SemVerRange SemVerRange

Tag Name

NpmUri URI

GitId GitSource Name Name (Maybe Name)

LocalPath FilePath

Instances

Eq NpmVersionRange

Show NpmVersionRange

data PackageInfo

Constructors

PackageInfo

Fields

piVersions :: Record VersionInfo

piTags :: Record Name

Instances

Eq PackageInfo

Show PackageInfo

FromJSON PackageInfo

Monoid PackageInfo

Semigroup PackageInfo

data PackageMeta

Constructors

PackageMeta

Fields

pmDescription :: Maybe Text

Instances

Eq PackageMeta

Show PackageMeta

data VersionInfo

Constructors

VersionInfo

Fields

viDependencies :: Record NpmVersionRange

viDevDependencies :: Record NpmVersionRange

viDist :: Maybe DistInfo

viMain :: Maybe Text

viName :: Text

viHasTest :: Bool

viMeta :: PackageMeta

viVersion :: Text

Instances

Eq VersionInfo

Show VersionInfo

FromJSON VersionInfo

data DistInfo

Distribution info from NPM. Tells us the URL and hash of a tarball.

Constructors

DistInfo

Fields

diUrl :: Text

diShasum :: Text

Instances

Eq DistInfo

Show DistInfo

FromJSON DistInfo

data ResolvedPkg

Constructors

ResolvedPkg

Fields

rpName :: Name

rpVersion :: SemVer

rpDistInfo :: DistInfo

rpMeta :: PackageMeta

rpDependencies :: Record SemVer

rpDevDependencies :: Record SemVer

Instances

Eq ResolvedPkg

Show ResolvedPkg

getDict :: FromJSON a => Text -> Object -> Parser (HashMap Text a)

Gets a hashmap from an object, or otherwise returns an empty hashmap.

getObject :: String -> Value -> Parser (HashMap Text Value)

pUri :: Parser NpmVersionRange

pGitId :: Parser NpmVersionRange

pLocalPath :: Parser NpmVersionRange

pEmptyString :: Parser NpmVersionRange

pTag :: Parser NpmVersionRange

pNpmVersionRange :: Parser NpmVersionRange

parseNpmVersionRange :: Text -> Either ParseError NpmVersionRange

data NpmFetcherState

Constructors

NpmFetcherState

Fields

registries :: [URI]

githubAuthToken :: Maybe Text

resolved :: Record (HashMap SemVer (Either NExpr ResolvedPkg))

pkgInfos :: Record PackageInfo

currentlyResolving :: HashSet (Name, SemVer)

indentLevel :: Int

knownProblematicPackages :: HashSet Name

getDevDeps :: Bool

Instances

Eq NpmFetcherState

Show NpmFetcherState

type NpmFetcher = ExceptT EList (StateT NpmFetcherState IO)

indent :: Text -> NpmFetcher Text

putStrLnI :: Text -> NpmFetcher ()

putStrsLnI :: [Text] -> NpmFetcher ()

putStrI :: Text -> NpmFetcher ()

putStrsI :: [Text] -> NpmFetcher ()

addResolvedPkg :: Name -> SemVer -> ResolvedPkg -> NpmFetcher ()

_defaultCurlArgs :: [Text]

curl :: [Text] -> NpmFetcher Text

_getPackageInfo :: Name -> URI -> NpmFetcher PackageInfo

Queries NPM for package information.

getPackageInfo :: Name -> NpmFetcher PackageInfo

Same as _getPackageInfo, but caches results for speed.

storePackageInfo :: Name -> PackageInfo -> NpmFetcher ()

toSemVerList :: Record a -> NpmFetcher [(SemVer, a)]

bestMatchFromRecord :: SemVerRange -> Record a -> NpmFetcher a

shell :: Sh Text -> NpmFetcher Text

silentShell :: Sh Text -> NpmFetcher Text

nixPrefetchSha1 :: URI -> NpmFetcher (Text, FilePath)

Returns the SHA1 hash of the result of fetching the URI, and the path in which the tarball is stored.

extractVersionInfo :: FilePath -> Text -> NpmFetcher VersionInfo

fetchHttp

Arguments

:: Text

Subpath in which to find the package.json.

-> URI

The URI to fetch.

-> NpmFetcher SemVer

The version of the package at that URI.

Fetch a package over HTTP. Return the version of the fetched package, and store the hash.

githubCurl :: Text -> NpmFetcher Value

getDefaultBranch :: Name -> Name -> NpmFetcher Name

Queries NPM for package information.

getShaOfBranch

Arguments

:: Name

Repo owner

-> Name

Repo name

-> Name

Name of the branch to get

-> NpmFetcher Text

The hash of the branch

Given a github repo and a branch, gets the SHA of the head of that branch

fetchGithub :: URI -> NpmFetcher SemVer

Fetch a package from git.

resolveNpmVersionRange :: Name -> NpmVersionRange -> NpmFetcher SemVer

resolveDep :: Name -> SemVerRange -> NpmFetcher SemVer

Uses the set of downloaded packages as a cache to avoid unnecessary duplication.

startResolving :: Name -> SemVer -> NpmFetcher ()

finishResolving :: Name -> SemVer -> NpmFetcher ()

resolveVersionInfo :: VersionInfo -> NpmFetcher SemVer

_resolveDep :: Name -> SemVerRange -> NpmFetcher SemVer

Resolves a dependency given a name and version range.

resolveByTag :: Name -> Name -> NpmFetcher SemVer

parseURIs :: [Text] -> [URI]

startState :: Record (HashMap SemVer NExpr) -> [Text] -> Maybe Text -> NpmFetcherState

getRegistries :: IO [Text]

Read NPM registry from env or use default.

getToken :: IO (Maybe Text)

Read github auth token from env or use none.

runIt :: NpmFetcher a -> IO (a, NpmFetcherState)

runItWith :: NpmFetcherState -> NpmFetcher a -> IO (a, NpmFetcherState)

getPkg :: Name -> Record (HashMap SemVer NExpr) -> IO (Record (HashMap SemVer (Either NExpr ResolvedPkg)))

_startingSrc :: String

_startingExpr :: NExpr

callPackage :: NExpr -> NExpr

callPackageWith :: [Binding NExpr] -> NExpr -> NExpr

callPackageWithRec :: [Binding NExpr] -> NExpr -> NExpr

fixName :: Name -> Name

Turns a string into one that can be used as an identifier.

toDepName :: Name -> SemVer -> Name

Converts a package name and semver into an identifier.

toDotNix :: SemVer -> Text

Gets the .nix filename of a semver. E.g. (0, 1, 2) -> 0.1.2.nix

str :: Text -> NExpr

Creates a doublequoted string from some text.

distInfoToNix :: DistInfo -> NExpr

Converts distinfo into a nix fetchurl call.

metaNotEmpty :: PackageMeta -> Bool

Tests if there is information in the package meta.

metaToNix :: PackageMeta -> NExpr

Converts package meta to a nix expression.

resolvedPkgToNix :: ResolvedPkg -> NExpr

Converts a resolved package object into a nix expression. The expresion will be a function where the arguments are its dependencies, and its result is a call to buildNodePackage.

mkDefaultNix :: Record (HashMap SemVer a) -> NExpr

Creates the `default.nix` file that is the top-level expression we are generating.

dumpPkgs :: MonadIO m => String -> Record (HashMap SemVer (Either NExpr ResolvedPkg)) -> m ()

parseVersion :: String -> IO (Maybe (SemVer, NExpr))

findExisting :: String -> IO (Record (HashMap SemVer NExpr))

data NixFromNpmOptions

Various options we have available for nixfromnpm. As of right now, most of these are unimplemented.

Constructors

NixFromNpmOptions

Fields

nfnoPkgName :: Name

nfnoOutputPath :: Text

nfnoNoCache :: Bool

nfnoExtendPaths :: [Text]

nfnoTest :: Bool

nfnoRegistries :: [Text]

nfnoTimeout :: Int

Instances

Eq NixFromNpmOptions

Show NixFromNpmOptions

defaultOptions :: Name -> Text -> NixFromNpmOptions

dumpPkgNamed :: Bool -> Text -> Text -> IO ()

dumpPkgFromOptions :: NixFromNpmOptions -> IO ()