Permalink
Browse files

Added npm test for using code standards in the examples. Fixed all di…

…screpencies. #111 (#112)
  • Loading branch information...
jethrolarson authored and hemanth committed Aug 31, 2016
1 parent 6256c79 commit a67155dd446734957321c43101b08c9bd2b447b4
Showing with 161 additions and 139 deletions.
  1. +7 −0 .eslintrc.yml
  2. +6 −2 contributing.md
  3. +4 −1 package.json
  4. +144 −136 readme.md
View
@@ -0,0 +1,7 @@
---
extends: "standard"
plugins: [markdown]
rules:
no-unused-vars: 0
no-undef: 0
no-extend-native: 0
View
@@ -2,6 +2,10 @@
This project is a work in progress. Contributions are very welcome.
## Hard rules
* Run `npm test` to lint the code examples. Your changes must pass.
* If you add a new definition or reorder them run `npm run toc` to regenerate the table of contents.
That said, we'd like to maintain some consistency across the document.
## Style guide
@@ -14,12 +18,12 @@ That said, we'd like to maintain some consistency across the document.
1. Avoid big walls of text
## Code conventions
Be consistent with other examples
[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
* Be consistent with other examples
* Prefer arrow functions
* Parenthesis around function arguments
* Put output values in comments
* Use semi-colons
* Keep it short and simple
This styleguide is a WIP too! Send PRs :)
View
@@ -4,7 +4,7 @@
"description": "Jargon from the functional programming world in simple terms!",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"test": "eslint readme.md",
"toc": "roadmarks"
},
"repository": {
@@ -18,6 +18,9 @@
},
"homepage": "https://github.com/hemanth/functional-programming-jargon#readme",
"devDependencies": {
"eslint": "^3.4.0",
"eslint-config-standard": "^6.0.0",
"eslint-plugin-markdown": "^1.0.0-beta.2",
"roadmarks": "^1.6.3"
}
}
Oops, something went wrong.

0 comments on commit a67155d

Please sign in to comment.