add linting for the READMEs (#170)

.eslintignore

@@ -1,3 +1,6 @@
 node_modules
 build
 coverage
+
+README.md
+!src/**/README.md

.eslintrc.js

@@ -8,6 +8,9 @@ module.exports = {
   "parserOptions": {
     "sourceType": "module"
   },
+  "plugins": [
+    'markdown'
+  ],
   "rules": {
     "array-bracket-spacing": [ "error", "always" ],
     "arrow-spacing": [ "error" ],

package.json

@@ -8,7 +8,7 @@
     "build:publish": "npm test && ./bin/publish",
     "build:dist": "webpack && uglifyjs build/dist/crocks.js -c \"warnings=false\" -m -o build/dist/crocks.min.js",
     "build": "rm -rf build && buble -i src -o build && npm run build:dist",
-    "lint": "eslint .",
+    "lint": "eslint --ext .md,.js .",
     "spec:coverage": "nyc npm run spec:build",
     "spec:dev": "nodemon -q -e js -w src -x 'npm run spec:src -s | tap-spec'",
     "spec:build": "npm run build && tape build/**/*.spec.js build/*.spec.js",
@@ -51,6 +51,7 @@
     "buble": "^0.18.0",
     "coveralls": "^3.0.0",
     "eslint": "^4.13.1",
+    "eslint-plugin-markdown": "^1.0.0-beta.6",
     "nodemon": "^1.9.2",
     "nyc": "^11.4.1",
     "sinon": "^4.1.3",

src/All/README.md

@@ -8,6 +8,7 @@ conjunction (AND) on their coerced `Boolean` values, mapping truth-y values to
 
 ```js
 const All = require('crocks/All')
+
 const mconcat = require('crocks/helpers/mconcat')
 
 const trueNum = All(13)
@@ -46,6 +47,8 @@ the case of `All` the result of `empty` is `true`. `empty` is available on both
 the Constructor and the Instance for convenience.
 
 ```js
+const All = require('crocks/All')
+
 All.empty() //=> All true
 
 All(true).concat(All.empty())   //=> All true
@@ -67,6 +70,8 @@ the boilerplate. `type` is available on both the Constructor and the Instance
 for convenience.
 
 ```js
+const All = require('crocks/All')
+
 const Maybe = require('crocks/Maybe')
 const isSameType = require('crocks/predicates/isSameType')
 
@@ -90,6 +95,8 @@ specified by the `Semigroup`. In the case of `All`, it will combine the two
 using logical AND (conjunction).
 
 ```js
+const All = require('crocks/All')
+
 All(true).concat(All(true))   //=> All true
 All(true).concat(All(false))  //=> All false
 All(false).concat(All(true))  //=> All false
@@ -108,6 +115,8 @@ helper functions that ship with `crocks`. Calling `valueOf` on an `All` instance
 will result in the underlying `Boolean` value.
 
 ```js
+const All = require('crocks/All')
+
 All(0).value()          //=> false
 All('string').valueOf() //=> true
 

src/Any/README.md

@@ -8,6 +8,7 @@ disjunction (OR) on their coerced `Boolean` values, mapping truth-y values to
 
 ```js
 const Any = require('crocks/Any')
+
 const isNumber = require('crocks/predicates/isNumber')
 const mconcatMap = require('crocks/helpers/mconcat')
 
@@ -47,6 +48,8 @@ the case of `Any` the result of `empty` is `false`. `empty` is available on both
 the Constructor and the Instance for convenience.
 
 ```js
+const Any = require('crocks/Any')
+
 Any.empty() //=> Any false
 
 Any(true).concat(Any.empty())   //=> Any true
@@ -68,6 +71,8 @@ the boilerplate. `type` is available on both the Constructor and the Instance
 for convenience.
 
 ```js
+const Any = require('crocks/Any')
+
 const Assign = require('crocks/Assign')
 const isSameType = require('crocks/predicates/isSameType')
 
@@ -93,6 +98,8 @@ specified by the `Semigroup`. In the case of `Any`, it will combine the two
 using logical OR (disjunction).
 
 ```js
+const Any = require('crocks/Any')
+
 Any(true).concat(Any(true))   //=> Any true
 Any(true).concat(Any(false))  //=> Any true
 Any(false).concat(Any(true))  //=> Any true
@@ -111,11 +118,13 @@ helper functions that ship with `crocks`. Calling `value` on an `Any` instance
 will result in the underlying `Boolean` value.
 
 ```js
+const Any = require('crocks/Any')
+
 Any(0).valueOf()        //=> false
 Any('string').valueOf() //=> true
 
 //=> true
 Any(45)
- .concat('')
- .valueOf()
+  .concat('')
+  .valueOf()
 ```

src/Arrow/README.md

@@ -117,7 +117,7 @@ Arrow.type() //=> "Arrow"
 
 isSameType(Arrow, Arrow(x => x + 3))  //=> true
 isSameType(Arrow, Arrow)              //=> true
-isSameType(Arrow, Idenity(0))         //=> false
+isSameType(Arrow, Identity(0))        //=> false
 isSameType(Arrow(I), Identity)        //=> false
 ```
 

src/Equiv/README.md

@@ -21,6 +21,7 @@ comparison.
 
 ```js
 const Equiv = require('crocks/Equiv')
+
 const equals = require('crocks/pointfree/equals')
 
 // toString :: a -> String
@@ -62,6 +63,7 @@ convenience.
 
 ```js
 const Equiv = require('crocks/Equiv')
+
 const equals = require('crocks/pointfree/equals')
 
 const eq =
@@ -100,6 +102,8 @@ the boilerplate. `type` is available on both the Constructor and the Instance
 for convenience.
 
 ```js
+const Equiv = require('crocks/Equiv')
+
 const Endo = require('crocks/Endo')
 const equals = require('crocks/pointfree/equals')
 const isSameType = require('crocks/predicates/isSameType')
@@ -125,6 +129,7 @@ specified by the `Semigroup`. In the case of `Equiv`, the results of both
 
 ```js
 const Equiv = require('crocks/Equiv')
+
 const compareWith = require('crocks/pointfree/compareWith')
 const equals = require('crocks/pointfree/equals')
 const isSameType = require('crocks/predicates/isSameType')
@@ -195,6 +200,7 @@ function.
 
 ```js
 const Equiv = require('crocks/Equiv')
+
 const equals = require('crocks/pointfree/equals')
 
 // length :: String -> Number
@@ -243,6 +249,7 @@ instance will result in the underlying curried equivalence function.
 
 ```js
 const Equiv = require('crocks/Equiv')
+
 const compose = require('crocks/helpers/compose')
 const equals = require('crocks/pointfree/equals')
 const propOr = require('crocks/helpers/propOr')

src/Pred/README.md

@@ -94,8 +94,8 @@ const empty =
 const notEmpty =
   Pred(not(isEmpty))
 
- empty
-    .runWith('')
+empty
+  .runWith('')
 //=> true
 
 notEmpty

src/Reader/README.md

@@ -147,7 +147,7 @@ Reader.type() //=> 'Reader'
 
 isSameType(Reader, Reader.of(76))   //=> true
 isSameType(Reader, Reader)          //=> true
-isSameType(Reader, Idenity(0))      //=> false
+isSameType(Reader, Identity(0))     //=> false
 isSameType(Reader(I), Identity)     //=> false
 ```
 
@@ -192,7 +192,7 @@ const lengthObj =
 
 // addLength :: Object -> Redaer Array Object
 const addLength = x =>
- ask(propOr('list', []))
+  ask(propOr('list', []))
     .map(B(assign(x), lengthObj))
 
 Reader.of({ num: 27 })
@@ -454,6 +454,7 @@ the form of `a -> m b` into a function that can be `chain`ed with the `ReaderT`.
 Although, [`liftFn`](#liftfn) can be used to remove the composition boilerplate
 and promote and `a -> m b` function.
 
+<!-- eslint-disable no-console -->
 ```js
 const ReaderT = require('crocks/Reader/ReaderT')
 const Async = require('crocks/Async')
@@ -629,7 +630,7 @@ envToUpper
 //=> Nothing
 
 envToUpper
-  .runWith("hola")
+  .runWith('hola')
 //=> Just "HOLA"
 
 ```