Updates for RC

Author: garyb

.gitignore

@@ -1,7 +1,8 @@
 /.*
 !/.gitignore
+!/.jscsrc
+!/.jshintrc
 !/.travis.yml
 /bower_components/
 /node_modules/
 /output/
-/tmp/

.jscsrc

@@ -0,0 +1,12 @@
+{
+  "preset": "grunt",
+  "disallowSpacesInAnonymousFunctionExpression": null,
+  "requireSpacesInAnonymousFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInsideObjectBrackets": null,
+  "requireSpacesInsideObjectBrackets": "all",
+  "validateQuoteMarks": "\"",
+  "requireCurlyBraces": null
+}

.jshintrc

@@ -0,0 +1,19 @@
+{
+  "bitwise": true,
+  "eqeqeq": true,
+  "forin": true,
+  "freeze": true,
+  "funcscope": true,
+  "futurehostile": true,
+  "globalstrict": true,
+  "latedef": true,
+  "maxparams": 1,
+  "noarg": true,
+  "nocomma": true,
+  "nonew": true,
+  "notypeof": true,
+  "singleGroups": true,
+  "undef": true,
+  "unused": true,
+  "eqnull": true
+}

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/purescript/purescript-strings.svg?branch=master)](https://travis-ci.org/purescript/purescript-strings)
 
-String utility functions, Char type, regular expressions.
+String and char utility functions, regular expressions.
 
 ## Installation
 

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "purescript-strings",
   "homepage": "https://github.com/purescript/purescript-strings",
-  "description": "String utility functions, Char type, regular expressions.",
+  "description": "String and char utility functions, regular expressions.",
   "keywords": [
     "purescript"
   ],
@@ -16,7 +16,6 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-functions": "~0.1.0",
-    "purescript-maybe": "~0.3.0"
+    "purescript-maybe": "^0.3.0"
   }
 }

docs/Data.Char.md

@@ -1,18 +1,7 @@
-# Module Documentation
-
 ## Module Data.Char
 
-
 A type and functions for single characters.
 
-#### `Char`
-
-``` purescript
-newtype Char
-```
-
-A unicode character.
-
 #### `toString`
 
 ``` purescript
@@ -37,37 +26,4 @@ fromCharCode :: Int -> Char
 
 Constructs a character from the given Unicode numeric value.
 
-#### `eqChar`
-
-``` purescript
-instance eqChar :: Eq Char
-```
-
-Characters can be compared for equality with `==` and `/=`.
-
-#### `ordChar`
-
-``` purescript
-instance ordChar :: Ord Char
-```
-
-Characters can be compared with `compare`, `>`, `>=`, `<` and `<=`.
-
-#### `boundedChar`
-
-``` purescript
-instance boundedChar :: Bounded Char
-```
-
-Characters fall within the Unicode range.
-
-#### `showChar`
-
-``` purescript
-instance showChar :: Show Char
-```
-
-Characters can be rendered as a string with `show`.
-
-
 

docs/Data.String.Regex.md

@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Data.String.Regex
 
-
 Wraps Javascript's `RegExp` object that enables matching strings with
 patternes defined by regular expressions.
 For details of the underlying implementation, see [RegExp Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp).
@@ -15,17 +12,15 @@ data Regex :: *
 
 Wraps Javascript `RegExp` objects.
 
-#### `showRegex`
-
+##### Instances
 ``` purescript
 instance showRegex :: Show Regex
 ```
 
-
 #### `RegexFlags`
 
 ``` purescript
-type RegexFlags = { unicode :: Boolean, sticky :: Boolean, multiline :: Boolean, ignoreCase :: Boolean, global :: Boolean }
+type RegexFlags = { global :: Boolean, ignoreCase :: Boolean, multiline :: Boolean, sticky :: Boolean, unicode :: Boolean }
 ```
 
 Flags that control matching.
@@ -89,7 +84,7 @@ Returns `true` if the `Regex` matches the string.
 #### `match`
 
 ``` purescript
-match :: Regex -> String -> Maybe [Maybe String]
+match :: Regex -> String -> Maybe (Array (Maybe String))
 ```
 
 Matches the string against the `Regex` and returns an array of matches
@@ -110,7 +105,7 @@ See [reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Referenc
 #### `replace'`
 
 ``` purescript
-replace' :: Regex -> (String -> [String] -> String) -> String -> String
+replace' :: Regex -> (String -> Array String -> String) -> String -> String
 ```
 
 Transforms occurences of the `Regex` using a function of the matched
@@ -129,10 +124,9 @@ Returns the index of the first match of the `Regex` in the string, or
 #### `split`
 
 ``` purescript
-split :: Regex -> String -> [String]
+split :: Regex -> String -> Array String
 ```
 
 Split the string into an array of substrings along occurences of the `Regex`.
 
 
-

docs/Data.String.Unsafe.md

@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Data.String.Unsafe
 
-
 Unsafe string and character functions.
 
 #### `charCodeAt`
@@ -36,4 +33,3 @@ Converts a string of length `1` to a character.
 **Unsafe:** throws runtime exception if length is not `1`.
 
 
-

docs/Data.String.md

@@ -1,8 +1,5 @@
-# Module Documentation
-
 ## Module Data.String
 
-
 Wraps the functions of Javascript's `String` object.
 A String represents a sequence of characters.
 For details of the underlying implementation, see [String Reference at MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String).
@@ -41,6 +38,12 @@ charCodeAt :: Int -> String -> Maybe Int
 Returns the numeric Unicode value of the character at the given index,
 if the index is within bounds.
 
+#### `toChar`
+
+``` purescript
+toChar :: String -> Maybe Char
+```
+
 #### `null`
 
 ``` purescript
@@ -52,7 +55,7 @@ Returns `true` if the given string is empty.
 #### `uncons`
 
 ``` purescript
-uncons :: String -> Maybe { tail :: String, head :: Char }
+uncons :: String -> Maybe { head :: Char, tail :: String }
 ```
 
 Returns the first character and the rest of the string,
@@ -78,7 +81,7 @@ Returns the suffix remaining after `takeWhile`.
 #### `fromCharArray`
 
 ``` purescript
-fromCharArray :: [Char] -> String
+fromCharArray :: Array Char -> String
 ```
 
 Converts an array of characters into a string.
@@ -180,7 +183,7 @@ Returns the number of characters in the string for which the predicate holds.
 #### `split`
 
 ``` purescript
-split :: String -> String -> [String]
+split :: String -> String -> Array String
 ```
 
 Returns the substrings of the first string separated along occurences
@@ -189,7 +192,7 @@ of the second string.
 #### `toCharArray`
 
 ``` purescript
-toCharArray :: String -> [Char]
+toCharArray :: String -> Array Char
 ```
 
 Converts the string into an array of characters.
@@ -223,18 +226,10 @@ and [line terminators](http://www.ecma-international.org/ecma-262/5.1/#sec-7.3).
 #### `joinWith`
 
 ``` purescript
-joinWith :: String -> [String] -> String
+joinWith :: String -> Array String -> String
 ```
 
 Joins the strings in the array together, inserting the first argument
 as separator between them.
 
-#### `stringMonoid`
-
-``` purescript
-instance stringMonoid :: Monoid String
-```
-
-
-
 

gulpfile.js

@@ -1,48 +1,63 @@
+/* jshint node: true */
 "use strict";
 
 var gulp = require("gulp");
+var jshint = require("gulp-jshint");
+var jscs = require("gulp-jscs");
 var plumber = require("gulp-plumber");
 var purescript = require("gulp-purescript");
-var jsvalidate = require("gulp-jsvalidate");
+var rimraf = require("rimraf");
 
-var paths = [
+var sources = [
   "src/**/*.purs",
   "bower_components/purescript-*/src/**/*.purs"
 ];
 
-gulp.task("make", function() {
-  return gulp.src(paths)
-    .pipe(plumber())
-    .pipe(purescript.pscMake());
+var foreigns = [
+  "src/**/*.js",
+  "bower_components/purescript-*/src/**/*.js"
+];
+
+gulp.task("clean-docs", function (cb) {
+  rimraf("docs", cb);
 });
 
-gulp.task("jsvalidate", ["make"], function () {
-  return gulp.src("output/**/*.js")
-    .pipe(plumber())
-    .pipe(jsvalidate());
+gulp.task("clean-output", function (cb) {
+  rimraf("output", cb);
 });
 
-var docTasks = [];
+gulp.task("clean", ["clean-docs", "clean-output"]);
 
-var docTask = function(name) {
-  var taskName = "docs-" + name.toLowerCase();
-  gulp.task(taskName, function () {
-    return gulp.src("src/" + name.replace(/\./g, "/") + ".purs")
-      .pipe(plumber())
-      .pipe(purescript.pscDocs())
-      .pipe(gulp.dest("docs/" + name + ".md"));
-  });
-  docTasks.push(taskName);
-};
+gulp.task("lint", function() {
+  return gulp.src("src/**/*.js")
+    .pipe(jshint())
+    .pipe(jshint.reporter())
+    .pipe(jscs());
+});
 
-["Data.Char", "Data.String", "Data.String.Regex", "Data.String.Unsafe"].forEach(docTask);
+gulp.task("make", ["lint"], function() {
+  return gulp.src(sources)
+    .pipe(plumber())
+    .pipe(purescript.pscMake({ ffi: foreigns }));
+});
 
-gulp.task("docs", docTasks);
+gulp.task("docs", ["clean-docs"], function () {
+  return gulp.src(sources)
+    .pipe(plumber())
+    .pipe(purescript.pscDocs({
+      docgen: {
+        "Data.Char": "docs/Data.Char.md",
+        "Data.String": "docs/Data.String.md",
+        "Data.String.Regex": "docs/Data.String.Regex.md",
+        "Data.String.Unsafe": "docs/Data.String.Unsafe.md"
+      }
+    }));
+});
 
 gulp.task("dotpsci", function () {
-  return gulp.src(paths)
+  return gulp.src(sources)
     .pipe(plumber())
     .pipe(purescript.dotPsci());
 });
 
-gulp.task("default", ["jsvalidate", "docs", "dotpsci"]);
+gulp.task("default", ["make", "docs", "dotpsci"]);