Updates for 0.7

Author: paf31

Gruntfile.js

@@ -1,32 +1,13 @@
-# Module Documentation
+# purescript-node-readline
 
-## Module Node.ReadLine
+A low-level PureScript interface to the Node `readline` API.
 
-### Types
+## Installation
 
-    type Completer eff = String -> Eff eff { matched :: String, completions :: [String] }
+```
+bower install purescript-readline
+```
 
-    data Console :: !
+## Module documentation
 
-    data InputStream :: *
-
-    data Interface :: *
-
-    type LineHandler eff a = String -> Eff (console :: Console | eff) a
-
-    data OutputStream :: *
-
-
-### Values
-
-    createInterface :: forall eff. InputStream -> OutputStream -> Completer eff -> Eff (console :: Console | eff) Interface
-
-    noCompletion :: forall eff. Completer eff
-
-    process :: { stdin :: InputStream, stdout :: OutputStream, stderr :: OutputStream }
-
-    prompt :: forall eff. Interface -> Eff (console :: Console | eff) Interface
-
-    setLineHandler :: forall eff a. LineHandler eff a -> Interface -> Eff (console :: Console | eff) Interface
-
-    setPrompt :: forall eff. String -> Number -> Interface -> Eff (console :: Console | eff) Interface
+- [Node.ReadLine](docs/Node/ReadLine.md)

README.md

@@ -4,6 +4,10 @@
   "keywords": [
     "purescript"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:purescript-node/purescript-node-readline.git"
+  },
   "license": "MIT",
   "ignore": [
     "**/.*",
@@ -15,5 +19,8 @@
     "bower.json",
     "Gruntfile.js",
     "package.json"
-  ]
+  ],
+  "dependencies": {
+    "purescript-console": "^0.1.0"
+  }
 }

bower.json

@@ -0,0 +1,74 @@
+## Module Node.ReadLine
+
+This module provides a binding to the Node `readline` API.
+
+#### `Interface`
+
+``` purescript
+data Interface :: *
+```
+
+A handle to a console interface.
+
+A handle can be created with the `createInterface` function.
+
+#### `Completer`
+
+``` purescript
+type Completer eff = String -> Eff (console :: CONSOLE | eff) { completions :: Array String, matched :: String }
+```
+
+A function which performs tab completion.
+
+This function takes the partial command as input, and returns a collection of 
+completions, as well as the matched portion of the input string.
+
+#### `LineHandler`
+
+``` purescript
+type LineHandler eff a = String -> Eff (console :: CONSOLE | eff) a
+```
+
+A function which handles input from the user.
+
+#### `setLineHandler`
+
+``` purescript
+setLineHandler :: forall eff a. LineHandler eff a -> Interface -> Eff (console :: CONSOLE | eff) Interface
+```
+
+Set the current line handler function.
+
+#### `prompt`
+
+``` purescript
+prompt :: forall eff. Interface -> Eff (console :: CONSOLE | eff) Interface
+```
+
+Prompt the user for input on the specified `Interface`.
+
+#### `setPrompt`
+
+``` purescript
+setPrompt :: forall eff. String -> Int -> Interface -> Eff (console :: CONSOLE | eff) Interface
+```
+
+Set the prompt.
+
+#### `createInterface`
+
+``` purescript
+createInterface :: forall eff. Completer eff -> Eff (console :: CONSOLE | eff) Interface
+```
+
+Create an interface with the specified completion function.
+
+#### `noCompletion`
+
+``` purescript
+noCompletion :: forall eff. Completer eff
+```
+
+A completion function which offers no completions.
+
+

docs/Node/ReadLine.md

@@ -0,0 +1,48 @@
+/* global exports */
+"use strict";
+
+// module Node.ReadLine
+
+exports.setLineHandler = function(callback) {
+    return function(readline) {
+        return function() {
+            readline.removeAllListeners('line');
+            readline.on('line', function(line) {
+                callback(line)();
+            });
+            return readline;
+        };
+    };
+};
+
+exports.prompt = function(readline) {
+    return function() {
+        readline.prompt();
+        return readline;
+    };
+};
+
+exports.setPrompt = function(prompt) {
+    return function(length) {
+        return function(readline) {
+            return function() {
+                readline.setPrompt(prompt, length);
+                return readline;
+            };
+        };
+    };
+};
+
+exports.createInterface = function(completer) {
+    return function() {
+        var readline = require('readline');
+        return readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+            completer: function(line) {
+                var res = completer(line)();
+                return [res.completions, res.suffix];
+            }
+        });
+    };
+};

examples/Examples.purs.hs

@@ -1,73 +1,39 @@
+-- | This module provides a binding to the Node `readline` API.
+
 module Node.ReadLine where
 
-import Control.Monad.Eff
+import Prelude (return)
 
-foreign import data Console :: !
+import Control.Monad.Eff
+import Control.Monad.Eff.Console
 
+-- | A handle to a console interface.
+-- |
+-- | A handle can be created with the `createInterface` function.
 foreign import data Interface :: *
 
-foreign import data InputStream :: *
-
-foreign import data OutputStream :: *
-
-foreign import process :: { stderr :: OutputStream, stdout :: OutputStream, stdin :: InputStream }
-
-type Completer eff = String -> Eff eff { completions :: [String], matched :: String }
+-- | A function which performs tab completion.
+-- |
+-- | This function takes the partial command as input, and returns a collection of 
+-- | completions, as well as the matched portion of the input string.
+type Completer eff = String -> Eff (console :: CONSOLE | eff) { completions :: Array String, matched :: String }
 
-type LineHandler eff a = String -> Eff (console :: Console | eff) a 
+-- | A function which handles input from the user.
+type LineHandler eff a = String -> Eff (console :: CONSOLE | eff) a 
 
-foreign import setLineHandler 
-  "function setLineHandler(callback) {\
-  \  return function(readline) {\
-  \    return function() {\
-  \      readline.removeAllListeners('line');\
-  \      readline.on('line', function (line) {\
-  \        callback(line)();\
-  \      });\
-  \      return readline;\
-  \    };\
-  \  };\
-  \};" :: forall eff a. LineHandler eff a -> Interface -> Eff (console :: Console | eff) Interface
+-- | Set the current line handler function.
+foreign import setLineHandler :: forall eff a. LineHandler eff a -> Interface -> Eff (console :: CONSOLE | eff) Interface
 
-foreign import prompt 
-  "function prompt(readline) {\
-  \  return function() {\
-  \    readline.prompt();\
-  \    return readline;\
-  \  };\
-  \};" :: forall eff. Interface -> Eff (console :: Console | eff) Interface
+-- | Prompt the user for input on the specified `Interface`.
+foreign import prompt :: forall eff. Interface -> Eff (console :: CONSOLE | eff) Interface
 
-foreign import setPrompt 
-  "function setPrompt(prompt) {\
-  \  return function(length) {\
-  \    return function(readline) {\
-  \      return function() {\
-  \        readline.setPrompt(prompt, length);\
-  \        return readline;\
-  \      };\
-  \    };\
-  \  };\
-  \}" :: forall eff. Prim.String -> Prim.Number -> Interface -> Eff (console :: Console | eff) Interface
+-- | Set the prompt.
+foreign import setPrompt :: forall eff. String -> Int -> Interface -> Eff (console :: CONSOLE | eff) Interface
 
-foreign import createInterface 
-  "function createInterface(input) {\
-  \  return function(output) {\
-  \    return function(completer) {\
-  \      return function() {\
-  \        var readline = require('readline');\
-  \        return readline.createInterface({\
-  \          input: input,\
-  \          output: output,\
-  \          completer: function(line) {\
-  \            var res = completer(line)();\
-  \            return [res.completions, res.suffix];\
-  \          }\
-  \        });\
-  \      };\
-  \    };\
-  \  };\
-  \}" :: forall eff. InputStream -> OutputStream -> Completer eff -> Eff (console :: Console | eff) Interface
+-- | Create an interface with the specified completion function.
+foreign import createInterface :: forall eff. Completer eff -> Eff (console :: CONSOLE | eff) Interface
 
+-- | A completion function which offers no completions.
 noCompletion :: forall eff. Completer eff
 noCompletion s = return { completions: [], matched: s }
 

package.json

@@ -0,0 +1,20 @@
+module Test.Main where
+
+import Prelude
+
+import Control.Monad.Eff
+import Control.Monad.Eff.Console
+
+import Node.ReadLine
+
+main = do
+  interface <- createInterface noCompletion
+  
+  let
+    lineHandler s = do
+      log $ "You typed: " ++ s
+      prompt interface
+  
+  setPrompt "> " 2 interface
+  prompt interface
+  setLineHandler lineHandler interface