Safe Haskell	None
Language	Haskell2010

Distribution.Nodejs.Package

Contents

Parsing package.json
package.json data

Description

They are documented on https://docs.npmjs.com/files/package.json and have a few gotchas. Luckily plain JSON, but the interpretation of certain fields is non-trivial (since they contain a lot of “sugar”).

Synopsis

newtype LoggingPackage = LoggingPackage {
- unLoggingPackage :: (Package, [Warning])
}
decode :: ByteString -> Either Text LoggingPackage
data Warning
- = WrongType {
  - wrongTypeField :: Text
  - wrongTypeDefault :: Maybe Text
  }
- | PlainWarning Text
formatWarning :: Warning -> Text
data Package = Package {
- name :: Text
- version :: Text
- description :: Maybe Text
- homepage :: Maybe Text
- private :: Bool
- scripts :: HashMap Text Text
- bin :: Bin
- man :: Man
- license :: Maybe Text
- dependencies :: Dependencies
- devDependencies :: Dependencies
}
data Bin
- = BinFiles (HashMap Text FilePath)
- | BinFolder FilePath
data Man = ManFiles (HashMap Text FilePath)
type Dependencies = HashMap Text Text

Parsing `package.json`

newtype LoggingPackage Source #

Package with a potential bunch of parsing warnings. Note the FromJson instance.

Constructors

LoggingPackage
Fields unLoggingPackage :: (Package, [Warning])

Instances

FromJSON LoggingPackage Source #	See https://github.com/npm/normalize-package-data for normalization steps used by npm itself.
Instance details Defined in Distribution.Nodejs.Package Methods parseJSON :: Value -> Parser LoggingPackage # parseJSONList :: Value -> Parser [LoggingPackage] #

decode :: ByteString -> Either Text LoggingPackage Source #

Convenience decoding function.

data Warning Source #

Possible warnings from parsing.

Constructors

WrongType
Fields wrongTypeField :: Text the field which has a wrong type wrongTypeDefault :: Maybe Text the default value, if used
PlainWarning Text

formatWarning :: Warning -> Text Source #

Convert a package.json parsing warning to plain text.

`package.json` data

data Package Source #

npm `package.json`. Not complete.

See https://docs.npmjs.com/files/package.json

Constructors

Package
Fields name :: Text version :: Text description :: Maybe Text homepage :: Maybe Text private :: Bool scripts :: HashMap Text Text bin :: Bin man :: Man license :: Maybe Text dependencies :: Dependencies devDependencies :: Dependencies

Instances

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

data Bin Source #

The package’s executable files.

Constructors

BinFiles (HashMap Text FilePath)	map of files from name to their file path (relative to package path)
BinFolder FilePath	a folder containing all executable files of the project (also relative)

Instances

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

data Man Source #

The package’s manual files.

Constructors

ManFiles (HashMap Text FilePath)

map of files from name to their file path (relative to package path)

Instances

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

type Dependencies = HashMap Text Text Source #

Dependencies of a package.

Parsing package.json

package.json data

Parsing `package.json`

`package.json` data