summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGraeme Yeates <yeatesgraeme@gmail.com>2016-04-12 18:16:44 -0400
committerGraeme Yeates <yeatesgraeme@gmail.com>2016-04-12 18:47:17 -0400
commit6ed90c61f9d06717034c88560b6210cb7de9d4e8 (patch)
treedfa36dcc13520572cfe8f340a6ec0827ceca2d47
parent6ed5305d0f954b7b10bd8d67d62c70c4cc487443 (diff)
downloadasync-6ed90c61f9d06717034c88560b6210cb7de9d4e8.tar.gz
Add linting for jsdocs
-rw-r--r--.jscsrc9
-rw-r--r--lib/auto.js2
-rw-r--r--lib/dir.js2
-rw-r--r--lib/log.js2
-rw-r--r--package.json3
5 files changed, 13 insertions, 5 deletions
diff --git a/.jscsrc b/.jscsrc
index 3e93b59..baab92f 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -1,4 +1,11 @@
{
"validateIndentation": 4,
- "esnext": true
+ "esnext": true,
+ "plugins": [
+ "jscs-jsdoc"
+ ],
+ "jsDoc": {
+ "checkTypes": "strictNativeCase",
+ "enforceExistence": false
+ }
}
diff --git a/lib/auto.js b/lib/auto.js
index b37970e..148cd5f 100644
--- a/lib/auto.js
+++ b/lib/auto.js
@@ -14,7 +14,7 @@ import onlyOnce from './internal/onlyOnce';
/**
* Determines the best order for running the functions in `tasks`, based on
* their requirements. Each function can optionally depend on other functions
- *nbeing completed first, and each function is run as soon as its requirements
+ * being completed first, and each function is run as soon as its requirements
* are satisfied.
*
* If any of the functions pass an error to their callback, the `auto` sequence
diff --git a/lib/dir.js b/lib/dir.js
index 71425dc..70bd4e2 100644
--- a/lib/dir.js
+++ b/lib/dir.js
@@ -15,7 +15,7 @@ import consoleFunc from './internal/consoleFunc';
* @category Util
* @param {Function} function - The function you want to eventually apply all
* arguments to.
- * @param {..*} arguments... - Any number of arguments to apply to the function.
+ * @param {...*} arguments... - Any number of arguments to apply to the function.
* @example
*
* // in a module
diff --git a/lib/log.js b/lib/log.js
index b6eb7f7..467cd17 100644
--- a/lib/log.js
+++ b/lib/log.js
@@ -14,7 +14,7 @@ import consoleFunc from './internal/consoleFunc';
* @category Util
* @param {Function} function - The function you want to eventually apply all
* arguments to.
- * @param {..*} arguments... - Any number of arguments to apply to the function.
+ * @param {...*} arguments... - Any number of arguments to apply to the function.
* @example
*
* // in a module
diff --git a/package.json b/package.json
index 2577ec0..6c8eb02 100644
--- a/package.json
+++ b/package.json
@@ -35,6 +35,7 @@
"es6-promise": "^2.3.0",
"fs-extra": "^0.26.7",
"jscs": "^1.13.1",
+ "jscs-jsdoc": "^1.3.2",
"jshint": "~2.8.0",
"karma": "^0.13.2",
"karma-browserify": "^4.2.1",
@@ -90,4 +91,4 @@
"tests"
]
}
-} \ No newline at end of file
+}