Skip to content

Commit 18e84dd

Browse files
committed
Add travis build
1 parent 2c2d96d commit 18e84dd

File tree

5 files changed

+78
-54
lines changed

5 files changed

+78
-54
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/.*
22
!/.gitignore
3+
!/.travis.yml
34
/bower_components/
45
/node_modules/
56
/output/

.travis.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
language: node_js
2+
node_js:
3+
- "0.10"
4+
install:
5+
- "sudo apt-get install cabal-install"
6+
- "cabal update"
7+
- "cabal install Cabal cabal-install"
8+
- "export PATH=~/.cabal/bin:$PATH"
9+
- "cabal install purescript --force-reinstalls"
10+
- "npm install bower grunt-cli -g"
11+
- "npm install"
12+
- "bower install"
13+
script:
14+
- "grunt examples"

Gruntfile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module.exports = function(grunt) {
1616
docgen: {
1717
readme: {
1818
src: "src/**/*.purs",
19-
dest: "README.md"
19+
dest: "docs/Module.md"
2020
}
2121
},
2222

README.md

Lines changed: 6 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,9 @@
1-
# Module Documentation
1+
purescript-foreign
2+
==================
23

3-
## Module Data.Foreign
4+
[![Build Status](https://travis-ci.org/purescript/purescript-foreign.svg?branch=master)](https://travis-ci.org/purescript/purescript-foreign)
45

5-
### Types
6+
Library for dealing with foreign data (JSON and JavaScript objects).
67

7-
data Foreign :: *
8-
9-
data ForeignParser a where
10-
ForeignParser :: Foreign -> Either String a -> ForeignParser a
11-
12-
13-
### Type Classes
14-
15-
class ReadForeign a where
16-
read :: ForeignParser a
17-
18-
19-
### Type Class Instances
20-
21-
instance applicativeForeignParser :: Prelude.Applicative ForeignParser
22-
23-
instance applyForeignParser :: Prelude.Apply ForeignParser
24-
25-
instance bindForeignParser :: Prelude.Bind ForeignParser
26-
27-
instance functorForeignParser :: Prelude.Functor ForeignParser
28-
29-
instance monadForeignParser :: Prelude.Monad ForeignParser
30-
31-
instance readArray :: (ReadForeign a) => ReadForeign [a]
32-
33-
instance readBoolean :: ReadForeign Boolean
34-
35-
instance readError :: ReadForeign Error
36-
37-
instance readMaybe :: (ReadForeign a) => ReadForeign (Maybe a)
38-
39-
instance readNumber :: ReadForeign Number
40-
41-
instance readString :: ReadForeign String
42-
43-
instance showForeign :: Prelude.Show Foreign
44-
45-
46-
### Values
47-
48-
index :: forall a. (ReadForeign a) => Number -> ForeignParser a
49-
50-
keys :: String -> ForeignParser [String]
51-
52-
parseForeign :: forall a. ForeignParser a -> Foreign -> Either String a
53-
54-
parseJSON :: forall a. (ReadForeign a) => String -> Either String a
55-
56-
prop :: forall a. (ReadForeign a) => String -> ForeignParser a
8+
- [Module documentation](docs/Module.md)
9+
- [Examples](examples/)

docs/Module.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Module Documentation
2+
3+
## Module Data.Foreign
4+
5+
### Types
6+
7+
data Foreign :: *
8+
9+
data ForeignParser a where
10+
ForeignParser :: Foreign -> Either String a -> ForeignParser a
11+
12+
13+
### Type Classes
14+
15+
class ReadForeign a where
16+
read :: ForeignParser a
17+
18+
19+
### Type Class Instances
20+
21+
instance applicativeForeignParser :: Prelude.Applicative ForeignParser
22+
23+
instance applyForeignParser :: Prelude.Apply ForeignParser
24+
25+
instance bindForeignParser :: Prelude.Bind ForeignParser
26+
27+
instance functorForeignParser :: Prelude.Functor ForeignParser
28+
29+
instance monadForeignParser :: Prelude.Monad ForeignParser
30+
31+
instance readArray :: (ReadForeign a) => ReadForeign [a]
32+
33+
instance readBoolean :: ReadForeign Boolean
34+
35+
instance readError :: ReadForeign Error
36+
37+
instance readMaybe :: (ReadForeign a) => ReadForeign (Maybe a)
38+
39+
instance readNumber :: ReadForeign Number
40+
41+
instance readString :: ReadForeign String
42+
43+
instance showForeign :: Prelude.Show Foreign
44+
45+
46+
### Values
47+
48+
index :: forall a. (ReadForeign a) => Number -> ForeignParser a
49+
50+
keys :: String -> ForeignParser [String]
51+
52+
parseForeign :: forall a. ForeignParser a -> Foreign -> Either String a
53+
54+
parseJSON :: forall a. (ReadForeign a) => String -> Either String a
55+
56+
prop :: forall a. (ReadForeign a) => String -> ForeignParser a

0 commit comments

Comments
 (0)