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

Updates 0.7 #29

Merged
merged 5 commits into from
May 10, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 35 additions & 35 deletions MODULE.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,109 +140,109 @@ multipipe2 :: forall a b c. Stream a b -> Stream b c -> Stream a c



## Module GulpPurescript.OS
## Module GulpPurescript.Options

#### `OS`
#### `isForeignEither`

``` purescript
data OS :: !
instance isForeignEither :: (IsForeign a, IsForeign b) => IsForeign (Either a b)
```


#### `Platform`
#### `isForeignPsc`

``` purescript
data Platform
= Darwin
| Linux
| Win32
instance isForeignPsc :: IsForeign Psc
```


#### `showPlatform`
#### `isForeignPscMake`

``` purescript
instance showPlatform :: Show Platform
instance isForeignPscMake :: IsForeign PscMake
```


#### `isForeignPlatform`
#### `isForeignPscDocs`

``` purescript
instance isForeignPlatform :: IsForeign Platform
instance isForeignPscDocs :: IsForeign PscDocs
```


#### `platform`
#### `isForeignFormat`

``` purescript
platform :: forall eff. Eff (os :: OS | eff) (Maybe Platform)
instance isForeignFormat :: IsForeign Format
```



## Module GulpPurescript.Options

#### `isForeignEither`
#### `pscOptions`

``` purescript
instance isForeignEither :: (IsForeign a, IsForeign b) => IsForeign (Either a b)
pscOptions :: Foreign -> [String]
```


#### `isForeignPsc`
#### `pscOptionsNoOutput`

``` purescript
instance isForeignPsc :: IsForeign Psc
pscOptionsNoOutput :: Foreign -> Tuple (Maybe String) [String]
```


#### `isForeignPscMake`
#### `pscMakeOptions`

``` purescript
instance isForeignPscMake :: IsForeign PscMake
pscMakeOptions :: Foreign -> [String]
```


#### `isForeignPscDocs`
#### `pscDocsOptions`

``` purescript
instance isForeignPscDocs :: IsForeign PscDocs
pscDocsOptions :: Foreign -> [String]
```


#### `isForeignFormat`

## Module GulpPurescript.OS

#### `OS`

``` purescript
instance isForeignFormat :: IsForeign Format
data OS :: !
```


#### `pscOptions`
#### `Platform`

``` purescript
pscOptions :: Foreign -> [String]
data Platform
= Darwin
| Linux
| Win32
```


#### `pscOptionsNoOutput`
#### `showPlatform`

``` purescript
pscOptionsNoOutput :: Foreign -> Tuple (Maybe String) [String]
instance showPlatform :: Show Platform
```


#### `pscMakeOptions`
#### `isForeignPlatform`

``` purescript
pscMakeOptions :: Foreign -> [String]
instance isForeignPlatform :: IsForeign Platform
```


#### `pscDocsOptions`
#### `platform`

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


Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Toggles `--no-prefix` that does not include the comment header.

###### `ffi` (String Array)

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.
Sets one or more `--ffi=<string>` that specifies the files for code that is included with a `foreign import` in the PureScript source.

### `purescript.pscMake(options)`

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

###### `ffi` (String Array)

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.
Sets one or more `--ffi=<string>` that specifies files for code that is included with a `foreign import` in the PureScript source.

### `purescript.pscDocs(options)`

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

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

###### `docgen` (String | String Array | Object)

Sets `--docgen=...` that can be used to filter the modules documentation is generated for.

- If a string value is provided, the documentation for that single module will be generated.
- If a list of strings is provided, the documentation for all listed modules will be generated.
- 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.

### `purescript.dotPsci()`

Generates a `.psci` file in the current directory. Each source file is added with the `:m` command.
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gulp-purescript",
"description": "Run the PureScript compiler",
"version": "0.4.2",
"version": "0.5.0",
"license": "MIT",
"repository": "purescript-contrib/gulp-purescript",
"author": {
Expand Down Expand Up @@ -29,6 +29,7 @@
"purescript"
],
"dependencies": {
"glob": "^5.0.5",
"gulp-util": "^3.0.4",
"logalot": "^2.1.0",
"minimist": "^1.1.1",
Expand Down
Loading