diff options
author | eric thul <thul.eric@gmail.com> | 2015-12-25 18:41:33 -0500 |
---|---|---|
committer | eric thul <thul.eric@gmail.com> | 2015-12-25 18:41:33 -0500 |
commit | 63d6a244462d050e119bde54a7063bae8a17e987 (patch) | |
tree | cce47ed541fa9ee8b2950945a89608b1c06fb8c9 /docs | |
parent | 2e2da2be94720a739c595ec179a7ed49480ce753 (diff) | |
download | purs-loader-63d6a244462d050e119bde54a7063bae8a17e987.tar.gz purs-loader-63d6a244462d050e119bde54a7063bae8a17e987.tar.zst purs-loader-63d6a244462d050e119bde54a7063bae8a17e987.zip |
Splitting PSC functionality into a separate plugin
The loader creates shim modules that reference their corresponding
PureScript module that is bundled by the PureScript webpack plugin,
which invokes `psc` and `psc-bundle`.
Resolves #31 and resolves #32
Diffstat (limited to 'docs')
-rw-r--r-- | docs/PursLoader/ChildProcess.md | 15 | ||||
-rw-r--r-- | docs/PursLoader/FS.md | 21 | ||||
-rw-r--r-- | docs/PursLoader/Glob.md | 15 | ||||
-rw-r--r-- | docs/PursLoader/Loader.md | 2 | ||||
-rw-r--r-- | docs/PursLoader/LoaderRef.md | 8 | ||||
-rw-r--r-- | docs/PursLoader/Options.md | 24 | ||||
-rw-r--r-- | docs/PursLoader/Path.md | 27 |
7 files changed, 38 insertions, 74 deletions
diff --git a/docs/PursLoader/ChildProcess.md b/docs/PursLoader/ChildProcess.md deleted file mode 100644 index 7c2e414..0000000 --- a/docs/PursLoader/ChildProcess.md +++ /dev/null | |||
@@ -1,15 +0,0 @@ | |||
1 | ## Module PursLoader.ChildProcess | ||
2 | |||
3 | #### `ChildProcess` | ||
4 | |||
5 | ``` purescript | ||
6 | data ChildProcess :: ! | ||
7 | ``` | ||
8 | |||
9 | #### `spawn` | ||
10 | |||
11 | ``` purescript | ||
12 | spawn :: forall eff. String -> Array String -> Aff (cp :: ChildProcess | eff) String | ||
13 | ``` | ||
14 | |||
15 | |||
diff --git a/docs/PursLoader/FS.md b/docs/PursLoader/FS.md deleted file mode 100644 index 811fcbd..0000000 --- a/docs/PursLoader/FS.md +++ /dev/null | |||
@@ -1,21 +0,0 @@ | |||
1 | ## Module PursLoader.FS | ||
2 | |||
3 | #### `FS` | ||
4 | |||
5 | ``` purescript | ||
6 | data FS :: ! | ||
7 | ``` | ||
8 | |||
9 | #### `writeFileUtf8` | ||
10 | |||
11 | ``` purescript | ||
12 | writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit | ||
13 | ``` | ||
14 | |||
15 | #### `findFileUtf8` | ||
16 | |||
17 | ``` purescript | ||
18 | findFileUtf8 :: forall eff. Regex -> Array String -> Aff (fs :: FS | eff) (Maybe String) | ||
19 | ``` | ||
20 | |||
21 | |||
diff --git a/docs/PursLoader/Glob.md b/docs/PursLoader/Glob.md deleted file mode 100644 index f7abe78..0000000 --- a/docs/PursLoader/Glob.md +++ /dev/null | |||
@@ -1,15 +0,0 @@ | |||
1 | ## Module PursLoader.Glob | ||
2 | |||
3 | #### `Glob` | ||
4 | |||
5 | ``` purescript | ||
6 | data Glob :: ! | ||
7 | ``` | ||
8 | |||
9 | #### `globAll` | ||
10 | |||
11 | ``` purescript | ||
12 | globAll :: forall eff. Array String -> Aff (glob :: Glob | eff) (Array (Array String)) | ||
13 | ``` | ||
14 | |||
15 | |||
diff --git a/docs/PursLoader/Loader.md b/docs/PursLoader/Loader.md index f81c486..bb02470 100644 --- a/docs/PursLoader/Loader.md +++ b/docs/PursLoader/Loader.md | |||
@@ -3,7 +3,7 @@ | |||
3 | #### `Effects` | 3 | #### `Effects` |
4 | 4 | ||
5 | ``` purescript | 5 | ``` purescript |
6 | type Effects eff = (cp :: ChildProcess, fs :: FS, glob :: Glob, loader :: Loader, err :: EXCEPTION | eff) | 6 | type Effects eff = (loader :: Loader | eff) |
7 | ``` | 7 | ``` |
8 | 8 | ||
9 | #### `loader` | 9 | #### `loader` |
diff --git a/docs/PursLoader/LoaderRef.md b/docs/PursLoader/LoaderRef.md index 36c1550..60341f7 100644 --- a/docs/PursLoader/LoaderRef.md +++ b/docs/PursLoader/LoaderRef.md | |||
@@ -1,5 +1,11 @@ | |||
1 | ## Module PursLoader.LoaderRef | 1 | ## Module PursLoader.LoaderRef |
2 | 2 | ||
3 | #### `AsyncCallback` | ||
4 | |||
5 | ``` purescript | ||
6 | type AsyncCallback eff = Maybe Error -> String -> Eff (loader :: Loader | eff) Unit | ||
7 | ``` | ||
8 | |||
3 | #### `LoaderRef` | 9 | #### `LoaderRef` |
4 | 10 | ||
5 | ``` purescript | 11 | ``` purescript |
@@ -15,7 +21,7 @@ data Loader :: ! | |||
15 | #### `async` | 21 | #### `async` |
16 | 22 | ||
17 | ``` purescript | 23 | ``` purescript |
18 | async :: forall eff a. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> a -> Eff (loader :: Loader | eff) Unit) | 24 | async :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> String -> Eff (loader :: Loader | eff) Unit) |
19 | ``` | 25 | ``` |
20 | 26 | ||
21 | #### `cacheable` | 27 | #### `cacheable` |
diff --git a/docs/PursLoader/Options.md b/docs/PursLoader/Options.md index 4202475..2bfcddd 100644 --- a/docs/PursLoader/Options.md +++ b/docs/PursLoader/Options.md | |||
@@ -8,31 +8,13 @@ newtype Options | |||
8 | 8 | ||
9 | ##### Instances | 9 | ##### Instances |
10 | ``` purescript | 10 | ``` purescript |
11 | instance isForeignOptions :: IsForeign Options | 11 | IsForeign Options |
12 | ``` | 12 | ``` |
13 | 13 | ||
14 | #### `output` | 14 | #### `runOptions` |
15 | 15 | ||
16 | ``` purescript | 16 | ``` purescript |
17 | output :: Options -> String | 17 | runOptions :: Options -> Options_ |
18 | ``` | ||
19 | |||
20 | #### `pscOptions` | ||
21 | |||
22 | ``` purescript | ||
23 | pscOptions :: Options -> Array String | ||
24 | ``` | ||
25 | |||
26 | #### `loaderSrcOption` | ||
27 | |||
28 | ``` purescript | ||
29 | loaderSrcOption :: Foreign -> Maybe (Array String) | ||
30 | ``` | ||
31 | |||
32 | #### `loaderFFIOption` | ||
33 | |||
34 | ``` purescript | ||
35 | loaderFFIOption :: Foreign -> Maybe (Array String) | ||
36 | ``` | 18 | ``` |
37 | 19 | ||
38 | 20 | ||
diff --git a/docs/PursLoader/Path.md b/docs/PursLoader/Path.md new file mode 100644 index 0000000..cc00436 --- /dev/null +++ b/docs/PursLoader/Path.md | |||
@@ -0,0 +1,27 @@ | |||
1 | ## Module PursLoader.Path | ||
2 | |||
3 | #### `relative` | ||
4 | |||
5 | ``` purescript | ||
6 | relative :: String -> String -> String | ||
7 | ``` | ||
8 | |||
9 | #### `resolve` | ||
10 | |||
11 | ``` purescript | ||
12 | resolve :: String -> String | ||
13 | ``` | ||
14 | |||
15 | #### `dirname` | ||
16 | |||
17 | ``` purescript | ||
18 | dirname :: String -> String | ||
19 | ``` | ||
20 | |||
21 | #### `joinPath` | ||
22 | |||
23 | ``` purescript | ||
24 | joinPath :: String -> String -> String | ||
25 | ``` | ||
26 | |||
27 | |||