summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/lib/rules/require-jsdoc.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/lib/rules/require-jsdoc.js')
-rw-r--r--tools/node_modules/eslint/lib/rules/require-jsdoc.js105
1 files changed, 105 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/lib/rules/require-jsdoc.js b/tools/node_modules/eslint/lib/rules/require-jsdoc.js
new file mode 100644
index 0000000000..a02ee3659c
--- /dev/null
+++ b/tools/node_modules/eslint/lib/rules/require-jsdoc.js
@@ -0,0 +1,105 @@
+/**
+ * @fileoverview Rule to check for jsdoc presence.
+ * @author Gyandeep Singh
+ */
+"use strict";
+
+module.exports = {
+ meta: {
+ docs: {
+ description: "require JSDoc comments",
+ category: "Stylistic Issues",
+ recommended: false
+ },
+
+ schema: [
+ {
+ type: "object",
+ properties: {
+ require: {
+ type: "object",
+ properties: {
+ ClassDeclaration: {
+ type: "boolean"
+ },
+ MethodDefinition: {
+ type: "boolean"
+ },
+ FunctionDeclaration: {
+ type: "boolean"
+ },
+ ArrowFunctionExpression: {
+ type: "boolean"
+ },
+ FunctionExpression: {
+ type: "boolean"
+ }
+ },
+ additionalProperties: false
+ }
+ },
+ additionalProperties: false
+ }
+ ]
+ },
+
+ 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);
+ }
+ }
+ };
+ }
+};