Web.Bower.PackageMeta

newtype PackageMeta

A human-friendly version of BowerJson.

Decoding to and encoding from this type does not preserve fields with default values.

For example, encoding a PackageMeta with license: [] and private: false will result in a json object without these fields.

Use BowerJson if these omissions are not desirable.

Constructors

• PackageMeta { authors :: Array Author, dependencies :: Dependencies, description :: Maybe String, devDependencies :: Dependencies, homepage :: Maybe String, ignore :: Array String, keywords :: Array String, license :: Array String, main :: Array String, moduleType :: Array ModuleType, name :: String, private :: Boolean, repository :: Maybe { type :: String, url :: String }, resolutions :: Resolutions }

Instances

• Eq PackageMeta
• Newtype PackageMeta _
• Generic PackageMeta _
• Show PackageMeta
• DecodeJson PackageMeta
• EncodeJson PackageMeta

newtype Dependencies

Constructors

• Dependencies (Array { packageName :: String, versionRange :: String })

Instances

• Newtype Dependencies _
• Eq Dependencies
• Generic Dependencies _
• Semigroup Dependencies
• Monoid Dependencies
• Show Dependencies
• DecodeJson Dependencies
• EncodeJson Dependencies

newtype Resolutions

Constructors

• Resolutions (Array { packageName :: String, version :: String })

Instances

• Newtype Resolutions _
• Eq Resolutions
• Generic Resolutions _
• Semigroup Resolutions
• Monoid Resolutions
• Show Resolutions
• DecodeJson Resolutions
• EncodeJson Resolutions

data ModuleType

Constructors

• Globals
• AMD
• Node
• ES6
• YUI

Instances

• Eq ModuleType
• Generic ModuleType _
• Show ModuleType
• DecodeJson ModuleType
• EncodeJson ModuleType

newtype Author

If an author is specified as a String, e.g.:

"author": "Author Name <author@gmail.com>",

this string will not be parsed, and this entry will be decoded as

Author { name: Just "Author Name <author@gmail.com>"
       , email: Nothing
       , homepage: Nothing }

Constructors

• Author { email :: Maybe String, homepage :: Maybe String, name :: Maybe String }

Instances

• Newtype Author _
• Eq Author
• Generic Author _
• Show Author
• DecodeJson Author
• EncodeJson Author

newtype BowerJson

A bower.json file represented as it is. Decoding and encoding a bower.json to and from BowerJson does not change it (up to JSON reformatting).

BowerJson type should only be used when the above property is needed.

For other use cases, it is more convenient to use PackageMeta instead.

Constructors

• BowerJson { authors :: Maybe (Array Author), dependencies :: Maybe Dependencies, description :: Maybe String, devDependencies :: Maybe Dependencies, homepage :: Maybe String, ignore :: Maybe (Array String), keywords :: Maybe (Array String), license :: Maybe (Array String), main :: Maybe (Array String), moduleType :: Maybe (Array ModuleType), name :: String, private :: Maybe Boolean, repository :: Maybe { type :: String, url :: String }, resolutions :: Maybe Resolutions }

Instances

• Newtype BowerJson _
• Eq BowerJson
• Generic BowerJson _
• Show BowerJson
• DecodeJson BowerJson
• EncodeJson BowerJson

readPackageMeta :: BowerJson -> PackageMeta

writePackageMeta :: PackageMeta -> BowerJson