????JFIF??x?x????'
| Server IP : 79.136.114.73 / Your IP : 216.73.216.216 Web Server : Apache/2.4.7 (Ubuntu) PHP/5.5.9-1ubuntu4.29 OpenSSL/1.0.1f System : Linux b8009 3.13.0-170-generic #220-Ubuntu SMP Thu May 9 12:40:49 UTC 2019 x86_64 User : www-data ( 33) PHP Version : 5.5.9-1ubuntu4.29 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority, MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /var/www/appsrv.astacus.se/forge/node_modules/eslint/lib/rules/ |
Upload File : |
/**
* @fileoverview Rule to check for jsdoc presence.
* @author Gyandeep Singh
*/
"use strict";
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "require JSDoc comments",
category: "Stylistic Issues",
recommended: false,
url: "https://eslint.org/docs/rules/require-jsdoc"
},
schema: [
{
type: "object",
properties: {
require: {
type: "object",
properties: {
ClassDeclaration: {
type: "boolean",
default: false
},
MethodDefinition: {
type: "boolean",
default: false
},
FunctionDeclaration: {
type: "boolean",
default: true
},
ArrowFunctionExpression: {
type: "boolean",
default: false
},
FunctionExpression: {
type: "boolean",
default: false
}
},
additionalProperties: false,
default: {}
}
},
additionalProperties: false
}
],
deprecated: true,
replacedBy: []
},
create(context) {
const source = context.getSourceCode();
const DEFAULT_OPTIONS = {
FunctionDeclaration: true,
MethodDefinition: false,
ClassDeclaration: false,
ArrowFunctionExpression: false,
FunctionExpression: false
};
const options = Object.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, message: "Missing JSDoc comment." });
}
/**
* Check if the jsdoc comment is present or not.
* @param {ASTNode} node node to examine
* @returns {void}
*/
function checkJsDoc(node) {
const jsdocComment = source.getJSDocComment(node);
if (!jsdocComment) {
report(node);
}
}
return {
FunctionDeclaration(node) {
if (options.FunctionDeclaration) {
checkJsDoc(node);
}
},
FunctionExpression(node) {
if (
(options.MethodDefinition && node.parent.type === "MethodDefinition") ||
(options.FunctionExpression && (node.parent.type === "VariableDeclarator" || (node.parent.type === "Property" && node === node.parent.value)))
) {
checkJsDoc(node);
}
},
ClassDeclaration(node) {
if (options.ClassDeclaration) {
checkJsDoc(node);
}
},
ArrowFunctionExpression(node) {
if (options.ArrowFunctionExpression && node.parent.type === "VariableDeclarator") {
checkJsDoc(node);
}
}
};
}
};