Permalink
Browse files

Add spell check to JSDoc

  • Loading branch information...
1 parent cc5e50e commit e610ef32a2b547fa2233f56c9e6c1413737d384d @ai ai committed Sep 26, 2016
Showing with 48 additions and 9 deletions.
  1. +2 −1 .jsdocrc
  2. +39 −1 .yaspellerrc
  3. +2 −2 gulpfile.babel.js
  4. +2 −2 lib/lazy-result.es6
  5. +2 −2 lib/list.es6
  6. +1 −1 lib/previous-map.es6
View
@@ -9,7 +9,8 @@
"plugins": ["plugins/markdown"],
"templates": {
"default": {
- "layoutFile": "node_modules/docdash/tmpl/layout.tmpl"
+ "layoutFile": "node_modules/docdash/tmpl/layout.tmpl",
+ "includeDate": false
}
}
}
View
@@ -142,6 +142,44 @@
"evilmartians",
"Less’s",
"visualizer",
- "Rollup"
+ "Rollup",
+ "AtRule",
+ "CssSyntaxError",
+ "LazyResult",
+ "RegExp",
+ "atRule",
+ "childIterator",
+ "cloneAfter",
+ "cloneBefore",
+ "docdash",
+ "withContent",
+ "walkRules",
+ "walkDecls",
+ "walkComments",
+ "unprefixed",
+ "toResult",
+ "showSourceCode",
+ "replaceWith",
+ "replaceValues",
+ "removeChild",
+ "removeAll",
+ "prepend",
+ "params",
+ "moveTo",
+ "moveAfter",
+ "moveBefore",
+ "insertBefore",
+ "insertAfter",
+ "decl",
+ "es6",
+ "stringify",
+ "defaultType",
+ "newParent",
+ "otherNode",
+ "SourceMapGenerator",
+ "onFulfilled",
+ "onRejected",
+ "base64",
+ "stringifing"
]
}
View
@@ -51,9 +51,9 @@ gulp.task('lint', () => {
.pipe(eslint.failAfterError());
});
-gulp.task('spellcheck', () => {
+gulp.task('spellcheck', ['api'], () => {
let run = require('gulp-run');
- return gulp.src(['*.md', 'docs/**/*.md'], { read: false })
+ return gulp.src(['api/*.html', '*.md', 'docs/**/*.md'], { read: false })
.pipe(run('yaspeller <%= file.path %>'));
});
View
@@ -188,7 +188,7 @@ class LazyResult {
*
* @param {onFulfilled} onFulfilled - callback will be executed
* when all plugins will finish work
- * @param {onRejected} onRejected - callback will be execited on any error
+ * @param {onRejected} onRejected - callback will be executed on any error
*
* @return {Promise} Promise API to make queue
*
@@ -207,7 +207,7 @@ class LazyResult {
*
* It implements standard Promise API.
*
- * @param {onRejected} onRejected - callback will be execited on any error
+ * @param {onRejected} onRejected - callback will be executed on any error
*
* @return {Promise} Promise API to make queue
*
View
@@ -58,7 +58,7 @@ let list = {
*
* @param {string} string - space-separated values
*
- * @return {string[]} splitted values
+ * @return {string[]} split values
*
* @example
* postcss.list.space('1px calc(10% + 1px)') //=> ['1px', 'calc(10% + 1px)']
@@ -74,7 +74,7 @@ let list = {
*
* @param {string} string - comma-separated values
*
- * @return {string[]} splitted values
+ * @return {string[]} split values
*
* @example
* postcss.list.comma('black, linear-gradient(white, black)')
@@ -39,7 +39,7 @@ class PreviousMap {
* It is lazy method, so it will create object only on first call
* and then it will use cache.
*
- * @return {SourceMapGenerator} object woth source map information
+ * @return {SourceMapGenerator} object with source map information
*/
consumer() {
if ( !this.consumerCache ) {

0 comments on commit e610ef3

Please sign in to comment.