Add example and README

Author: felixSchl

README.md

@@ -0,0 +1,263 @@
+# Module Documentation
+
+## Module Node.FS.Aff
+
+
+
+[Node.FS][Node.FS] Wrappers for [purescript-aff][aff]
+
+The `Aff` monad let's you write async code with ease.
+
+Consider asynchronously listing only non-hidden directories:
+
+``` purescript
+main = launchAff do
+  files <- FS.readdir "."
+  files' <- flip filterM files \file -> do
+    stat <- FS.stat file
+    return $
+         FS.isDirectory stat
+      && (maybe false (fromChar >>> (/= ".")) $ charAt 0 file)
+  liftEff $ Debug.Trace.trace $ show files'
+```
+
+That was easy. For a working example, see [example.purs][example].
+To build the example, run `gulp example`.
+
+[Node.FS]: http://github.com/purescript-node/purescript-node-fs
+[aff]: https://github.com/slamdata/purescript-aff
+[example]: http://github.com/purescript-node/purescript-node-fs-aff/blob/master/example/example.purs
+
+#### `rename`
+
+``` purescript
+rename :: forall eff. FilePath -> FilePath -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Rename a file.
+
+
+#### `truncate`
+
+``` purescript
+truncate :: forall eff. FilePath -> Number -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Truncates a file to the specified length.
+
+
+#### `chown`
+
+``` purescript
+chown :: forall eff. FilePath -> Number -> Number -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Changes the ownership of a file.
+
+
+#### `chmod`
+
+``` purescript
+chmod :: forall eff. FilePath -> Perms -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Changes the permissions of a file.
+
+
+#### `stat`
+
+``` purescript
+stat :: forall eff. FilePath -> Aff (fs :: F.FS | eff) Stats
+```
+
+
+Gets file statistics.
+
+
+#### `link`
+
+``` purescript
+link :: forall eff. FilePath -> FilePath -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Creates a link to an existing file.
+
+
+#### `symlink`
+
+``` purescript
+symlink :: forall eff. FilePath -> FilePath -> F.SymlinkType -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Creates a symlink.
+
+
+#### `readlink`
+
+``` purescript
+readlink :: forall eff. FilePath -> Aff (fs :: F.FS | eff) FilePath
+```
+
+
+Reads the value of a symlink.
+
+
+#### `realpath`
+
+``` purescript
+realpath :: forall eff. FilePath -> Aff (fs :: F.FS | eff) FilePath
+```
+
+
+Find the canonicalized absolute location for a path.
+
+
+#### `realpath'`
+
+``` purescript
+realpath' :: forall eff cache. FilePath -> {  | cache } -> Aff (fs :: F.FS | eff) FilePath
+```
+
+
+Find the canonicalized absolute location for a path using a cache object
+for already resolved paths.
+
+
+#### `unlink`
+
+``` purescript
+unlink :: forall eff. FilePath -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Deletes a file.
+
+
+#### `rmdir`
+
+``` purescript
+rmdir :: forall eff. FilePath -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Deletes a directory.
+
+
+#### `mkdir`
+
+``` purescript
+mkdir :: forall eff. FilePath -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Makes a new directory.
+
+
+#### `mkdir'`
+
+``` purescript
+mkdir' :: forall eff. FilePath -> Perms -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Makes a new directory with the specified permissions.
+
+
+#### `readdir`
+
+``` purescript
+readdir :: forall eff. FilePath -> Aff (fs :: F.FS | eff) [FilePath]
+```
+
+
+Reads the contents of a directory.
+
+
+#### `utimes`
+
+``` purescript
+utimes :: forall eff. FilePath -> Date -> Date -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Sets the accessed and modified times for the specified file.
+
+
+#### `readFile`
+
+``` purescript
+readFile :: forall eff. FilePath -> Aff (fs :: F.FS | eff) Buffer
+```
+
+
+Reads the entire contents of a file returning the result as a raw buffer.
+
+
+#### `readTextFile`
+
+``` purescript
+readTextFile :: forall eff. Encoding -> FilePath -> Aff (fs :: F.FS | eff) String
+```
+
+
+Reads the entire contents of a text file with the specified encoding.
+
+
+#### `writeFile`
+
+``` purescript
+writeFile :: forall eff. FilePath -> Buffer -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Writes a buffer to a file.
+
+
+#### `writeTextFile`
+
+``` purescript
+writeTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Writes text to a file using the specified encoding.
+
+
+#### `appendFile`
+
+``` purescript
+appendFile :: forall eff. FilePath -> Buffer -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Appends the contents of a buffer to a file.
+
+
+#### `appendTextFile`
+
+``` purescript
+appendTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: F.FS | eff) Unit
+```
+
+
+Appends text to a file using the specified encoding.
+
+
+#### `exists`
+
+``` purescript
+exists :: forall eff. String -> Aff (fs :: F.FS | eff) Boolean
+```
+
+
+Check to see if a file exists.
+
+
+
+

example/example.purs

@@ -0,0 +1,29 @@
+module Example.Main where
+
+import Control.Monad (filterM)
+import Control.Functor
+import Data.String (charAt, fromChar)
+import Data.Maybe
+import Data.Array
+import Control.Monad.Trans
+import Control.Monad.Aff
+import Control.Monad.Eff.Class (liftEff)
+import qualified Node.Path as Path
+import qualified Debug.Trace as T
+import qualified Node.FS.Aff as FS
+import qualified Node.FS as FS
+import qualified Node.FS.Stats as FS
+
+trace :: forall e a. (Show a) => a -> Aff (trace :: T.Trace | e) a
+trace a = do
+  liftEff $ T.trace (show a)
+  return a
+
+main = launchAff do
+  files <- FS.readdir "."
+  files' <- flip filterM files \file -> do
+    stat <- FS.stat file
+    return $
+         FS.isDirectory stat
+      && (maybe false (fromChar >>> (/= ".")) $ charAt 0 file)
+  liftEff $ Debug.Trace.trace $ show files'

gulpfile.js

@@ -1,5 +1,13 @@
 'use strict';
 
+/**
+ * Add `./output` to path i.o. to load modules.
+ * Warning: This is a hack
+ * https://gist.github.com/branneman/8048520#6-the-hack
+ */
+process.env.NODE_PATH = __dirname + '/output';
+require('module').Module._initPaths();
+
 var gulp = require('gulp')
   , purs = require('gulp-purescript')
   , Promise = require('bluebird')
@@ -9,6 +17,7 @@ var gulp = require('gulp')
 
 var src = [ 'src/**/*.purs' ]
   , deps = [ 'bower_components/purescript-*/src/**/*.purs' ]
+  , example = [ 'example/example.purs' ]
   , output = [ 'output' ]
 ;
 
@@ -25,3 +34,22 @@ gulp.task('make', [ 'psci' ], function() {
         .pipe(purs.pscMake({}))
     ;
 });
+
+gulp.task('docs', function() {
+    return gulp
+        .src(src)
+        .pipe(purs.pscDocs({}))
+        .pipe(gulp.dest('README.md'))
+    ;
+});
+
+gulp.task('make:example', function() {
+    return gulp
+        .src(_.flatten([ src, example, deps ], false))
+        .pipe(purs.pscMake({}))
+    ;
+});
+
+gulp.task('example', ['make:example'], function() {
+    require('Example.Main').main();
+});

src/Node/FS/Aff.purs

@@ -1,3 +1,28 @@
+-- |
+-- | [Node.FS][Node.FS] Wrappers for [purescript-aff][aff]
+-- |
+-- | The `Aff` monad let's you write async code with ease.
+-- |
+-- | Consider asynchronously listing only non-hidden directories:
+-- |
+-- | ``` purescript
+-- | main = launchAff do
+-- |   files <- FS.readdir "."
+-- |   files' <- flip filterM files \file -> do
+-- |     stat <- FS.stat file
+-- |     return $
+-- |          FS.isDirectory stat
+-- |       && (maybe false (fromChar >>> (/= ".")) $ charAt 0 file)
+-- |   liftEff $ Debug.Trace.trace $ show files'
+-- | ```
+-- |
+-- | That was easy. For a working example, see [example.purs][example].
+-- | To build the example, run `gulp example`.
+-- |
+-- | [Node.FS]: http://github.com/purescript-node/purescript-node-fs
+-- | [aff]: https://github.com/slamdata/purescript-aff
+-- | [example]: http://github.com/purescript-node/purescript-node-fs-aff/blob/master/example/example.purs
+
 module Node.FS.Aff
   ( rename
   , truncate