| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Web.BowerJson
Description
A data type representing the Bower.json package description file, together with a parser and related functions.
This code is based on the specification at https://github.com/bower/bower.json-spec.
- data BowerJson = BowerJson {
- bowerName :: PackageName
- bowerDescription :: Maybe String
- bowerMain :: [FilePath]
- bowerModuleType :: [ModuleType]
- bowerLicence :: [String]
- bowerIgnore :: [String]
- bowerKeywords :: [String]
- bowerAuthors :: [Author]
- bowerHomepage :: Maybe String
- bowerRepository :: Maybe Repository
- bowerDependencies :: [(PackageName, VersionRange)]
- bowerDevDependencies :: [(PackageName, VersionRange)]
- bowerResolutions :: [(PackageName, Version)]
- bowerPrivate :: Bool
- decodeFile :: FilePath -> IO (Either String BowerJson)
- data PackageName
- runPackageName :: PackageName -> String
- mkPackageName :: String -> Maybe PackageName
- data ModuleType
- data Author = Author {}
- data Repository = Repository {}
- newtype VersionRange = VersionRange {}
- newtype Version = Version {
- runVersion :: String
Documentation
A data type representing the data stored in a bower.json package manifest file.
Note that the ToJSON / FromJSON instances don't exactly match; for
example, it is not always the case that decoding from JSON and then encoding
to JSON will give you the exact same JSON that you started with. However, if
you start with a BowerJson value, encode to JSON, and then decode, you
should always get the same value back.
Constructors
| BowerJson | |
Fields
| |
decodeFile :: FilePath -> IO (Either String BowerJson) Source
Read and attempt to decode a bower.json file.
data PackageName Source
A valid package name for a Bower package.
mkPackageName :: String -> Maybe PackageName Source
A smart constructor for a PackageName. It ensures that the package name satisfies the restrictions described at https://github.com/bower/bower.json-spec#name.
data ModuleType Source
Constructors
| Author | |
Fields
| |
data Repository Source
Constructors
| Repository | |
Fields | |
newtype VersionRange Source
Constructors
| VersionRange | |
Fields | |