Skip to content
This repository was archived by the owner on May 1, 2020. It is now read-only.

Commit a108ca3

Browse files
committed
Merge pull request #29 from purescript-contrib/updates-0.7
Updates 0.7
2 parents 9812c6f + 785bcda commit a108ca3

File tree

4 files changed

+145
-89
lines changed

4 files changed

+145
-89
lines changed

MODULE.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -140,109 +140,109 @@ multipipe2 :: forall a b c. Stream a b -> Stream b c -> Stream a c
140140

141141

142142

143-
## Module GulpPurescript.OS
143+
## Module GulpPurescript.Options
144144

145-
#### `OS`
145+
#### `isForeignEither`
146146

147147
``` purescript
148-
data OS :: !
148+
instance isForeignEither :: (IsForeign a, IsForeign b) => IsForeign (Either a b)
149149
```
150150

151151

152-
#### `Platform`
152+
#### `isForeignPsc`
153153

154154
``` purescript
155-
data Platform
156-
= Darwin
157-
| Linux
158-
| Win32
155+
instance isForeignPsc :: IsForeign Psc
159156
```
160157

161158

162-
#### `showPlatform`
159+
#### `isForeignPscMake`
163160

164161
``` purescript
165-
instance showPlatform :: Show Platform
162+
instance isForeignPscMake :: IsForeign PscMake
166163
```
167164

168165

169-
#### `isForeignPlatform`
166+
#### `isForeignPscDocs`
170167

171168
``` purescript
172-
instance isForeignPlatform :: IsForeign Platform
169+
instance isForeignPscDocs :: IsForeign PscDocs
173170
```
174171

175172

176-
#### `platform`
173+
#### `isForeignFormat`
177174

178175
``` purescript
179-
platform :: forall eff. Eff (os :: OS | eff) (Maybe Platform)
176+
instance isForeignFormat :: IsForeign Format
180177
```
181178

182179

183-
184-
## Module GulpPurescript.Options
185-
186-
#### `isForeignEither`
180+
#### `pscOptions`
187181

188182
``` purescript
189-
instance isForeignEither :: (IsForeign a, IsForeign b) => IsForeign (Either a b)
183+
pscOptions :: Foreign -> [String]
190184
```
191185

192186

193-
#### `isForeignPsc`
187+
#### `pscOptionsNoOutput`
194188

195189
``` purescript
196-
instance isForeignPsc :: IsForeign Psc
190+
pscOptionsNoOutput :: Foreign -> Tuple (Maybe String) [String]
197191
```
198192

199193

200-
#### `isForeignPscMake`
194+
#### `pscMakeOptions`
201195

202196
``` purescript
203-
instance isForeignPscMake :: IsForeign PscMake
197+
pscMakeOptions :: Foreign -> [String]
204198
```
205199

206200

207-
#### `isForeignPscDocs`
201+
#### `pscDocsOptions`
208202

209203
``` purescript
210-
instance isForeignPscDocs :: IsForeign PscDocs
204+
pscDocsOptions :: Foreign -> [String]
211205
```
212206

213207

214-
#### `isForeignFormat`
208+
209+
## Module GulpPurescript.OS
210+
211+
#### `OS`
215212

216213
``` purescript
217-
instance isForeignFormat :: IsForeign Format
214+
data OS :: !
218215
```
219216

220217

221-
#### `pscOptions`
218+
#### `Platform`
222219

223220
``` purescript
224-
pscOptions :: Foreign -> [String]
221+
data Platform
222+
= Darwin
223+
| Linux
224+
| Win32
225225
```
226226

227227

228-
#### `pscOptionsNoOutput`
228+
#### `showPlatform`
229229

230230
``` purescript
231-
pscOptionsNoOutput :: Foreign -> Tuple (Maybe String) [String]
231+
instance showPlatform :: Show Platform
232232
```
233233

234234

235-
#### `pscMakeOptions`
235+
#### `isForeignPlatform`
236236

237237
``` purescript
238-
pscMakeOptions :: Foreign -> [String]
238+
instance isForeignPlatform :: IsForeign Platform
239239
```
240240

241241

242-
#### `pscDocsOptions`
242+
#### `platform`
243243

244244
``` purescript
245-
pscDocsOptions :: Foreign -> [String]
245+
platform :: forall eff. Eff (os :: OS | eff) (Maybe Platform)
246246
```
247247

248248

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Toggles `--no-prefix` that does not include the comment header.
9090

9191
###### `ffi` (String Array)
9292

93-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
93+
Sets one or more `--ffi=<string>` that specifies the files for code that is included with a `foreign import` in the PureScript source.
9494

9595
### `purescript.pscMake(options)`
9696

@@ -130,7 +130,7 @@ Toggles `--no-prefix` that does not include the comment header.
130130

131131
###### `ffi` (String Array)
132132

133-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
133+
Sets one or more `--ffi=<string>` that specifies files for code that is included with a `foreign import` in the PureScript source.
134134

135135
### `purescript.pscDocs(options)`
136136

@@ -140,6 +140,14 @@ Invokes the `pscDocs` command. The following options are supported.
140140

141141
Sets `--output=<markdown|etags|ctags>` that specifies the output format.
142142

143+
###### `docgen` (String | String Array | Object)
144+
145+
Sets `--docgen=...` that can be used to filter the modules documentation is generated for.
146+
147+
- If a string value is provided, the documentation for that single module will be generated.
148+
- If a list of strings is provided, the documentation for all listed modules will be generated.
149+
- If an object with module name/filename pairs (for example, `{ Module: "docs/Module.md" }`) is provided, files will be written for each of the modules. In this mode, the task requires no `dest` as no value is returned.
150+
143151
### `purescript.dotPsci()`
144152

145153
Generates a `.psci` file in the current directory. Each source file is added with the `:m` command.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gulp-purescript",
33
"description": "Run the PureScript compiler",
4-
"version": "0.4.2",
4+
"version": "0.5.0",
55
"license": "MIT",
66
"repository": "purescript-contrib/gulp-purescript",
77
"author": {
@@ -29,6 +29,7 @@
2929
"purescript"
3030
],
3131
"dependencies": {
32+
"glob": "^5.0.5",
3233
"gulp-util": "^3.0.4",
3334
"logalot": "^2.1.0",
3435
"minimist": "^1.1.1",

0 commit comments

Comments
 (0)