f601d040b5
Update ESLint to 2.1.0. ESLint has a number of potentially-useful new features but this change attempts to be minimal in its changes. However, some things could not be avoided reasonably. ESLint 2.1.0 found a few lint issues that ESLing 1.x missed with template strings that did not take advantage of any features of template strings, and `let` declarations where `const` sufficed. Additionally, ESLint 2.1.0 removes some granularity around enabling ES6 features. Some features (e.g., spread operator) that had been turned off in our configuration for ESLint 1.x are now permitted. PR-URL: https://github.com/nodejs/node/pull/5214 Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: jbergstroem - Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Myles Borins <myles.borins@gmail.com>
97 lines
2.5 KiB
JavaScript
97 lines
2.5 KiB
JavaScript
/**
|
|
* @fileoverview Rule to check for jsdoc presence.
|
|
* @author Gyandeep Singh
|
|
* @copyright 2015 Gyandeep Singh. All rights reserved.
|
|
*/
|
|
"use strict";
|
|
|
|
var lodash = require("lodash");
|
|
|
|
module.exports = function(context) {
|
|
var source = context.getSourceCode();
|
|
var DEFAULT_OPTIONS = {
|
|
"FunctionDeclaration": true,
|
|
"MethodDefinition": false,
|
|
"ClassDeclaration": false
|
|
};
|
|
var options = lodash.assign(DEFAULT_OPTIONS, context.options[0] && context.options[0].require || {});
|
|
|
|
/**
|
|
* Report the error message
|
|
* @param {ASTNode} node node to report
|
|
* @returns {void}
|
|
*/
|
|
function report(node) {
|
|
context.report(node, "Missing JSDoc comment.");
|
|
}
|
|
|
|
/**
|
|
* Check if the jsdoc comment is present for class methods
|
|
* @param {ASTNode} node node to examine
|
|
* @returns {void}
|
|
*/
|
|
function checkClassMethodJsDoc(node) {
|
|
if (node.parent.type === "MethodDefinition") {
|
|
var jsdocComment = source.getJSDocComment(node);
|
|
|
|
if (!jsdocComment) {
|
|
report(node);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if the jsdoc comment is present or not.
|
|
* @param {ASTNode} node node to examine
|
|
* @returns {void}
|
|
*/
|
|
function checkJsDoc(node) {
|
|
var jsdocComment = source.getJSDocComment(node);
|
|
|
|
if (!jsdocComment) {
|
|
report(node);
|
|
}
|
|
}
|
|
|
|
return {
|
|
"FunctionDeclaration": function(node) {
|
|
if (options.FunctionDeclaration) {
|
|
checkJsDoc(node);
|
|
}
|
|
},
|
|
"FunctionExpression": function(node) {
|
|
if (options.MethodDefinition) {
|
|
checkClassMethodJsDoc(node);
|
|
}
|
|
},
|
|
"ClassDeclaration": function(node) {
|
|
if (options.ClassDeclaration) {
|
|
checkJsDoc(node);
|
|
}
|
|
}
|
|
};
|
|
};
|
|
|
|
module.exports.schema = [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"require": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ClassDeclaration": {
|
|
"type": "boolean"
|
|
},
|
|
"MethodDefinition": {
|
|
"type": "boolean"
|
|
},
|
|
"FunctionDeclaration": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
];
|