Fixed linting issues.

Author: gajus

src/iterateJsdoc.js

@@ -2,12 +2,8 @@ import _ from 'lodash';
 import commentParser from 'comment-parser';
 import jsdocUtils from './jsdocUtils';
 
-let curryUtils;
-
-curryUtils = (functionNode, jsdoc, tagNamePreference) => {
-    let utils;
-
-    utils = {};
+const curryUtils = (functionNode, jsdoc, tagNamePreference) => {
+    const utils = {};
 
     utils.getFunctionParameterNames = () => {
         return jsdocUtils.getFunctionParameterNames(functionNode);
@@ -34,27 +30,17 @@ curryUtils = (functionNode, jsdoc, tagNamePreference) => {
 
 export default (iterator) => {
     return (context) => {
-        let checkJsdoc,
-            sourceCode,
-            tagNamePreference;
-
-        sourceCode = context.getSourceCode();
-
-        tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
-
-        checkJsdoc = (functionNode) => {
-            let jsdoc,
-                jsdocNode,
-                report,
-                utils;
+        const sourceCode = context.getSourceCode();
+        const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
 
-            jsdocNode = sourceCode.getJSDocComment(functionNode);
+        const checkJsdoc = (functionNode) => {
+            const jsdocNode = sourceCode.getJSDocComment(functionNode);
 
             if (!jsdocNode) {
                 return;
             }
 
-            jsdoc = commentParser('/*' + jsdocNode.value + '*/', {
+            const jsdoc = commentParser('/*' + jsdocNode.value + '*/', {
                 // @see https://github.com/yavorskiy/comment-parser/issues/21
                 parsers: [
                     commentParser.PARSERS.parse_tag,
@@ -69,11 +55,11 @@ export default (iterator) => {
                 ]
             })[0] || {};
 
-            report = (message) => {
+            const report = (message) => {
                 context.report(jsdocNode, message);
             };
 
-            utils = curryUtils(functionNode, jsdoc, tagNamePreference);
+            const utils = curryUtils(functionNode, jsdoc, tagNamePreference);
 
             iterator({
                 context,

src/jsdocUtils.js

@@ -1,13 +1,7 @@
 import _ from 'lodash';
 import tagNames from './tagNames';
 
-let getFunctionParameterNames,
-    getJsdocParameterNames,
-    getJsdocParameterNamesDeep,
-    getPreferredTagName,
-    isValidTag;
-
-getFunctionParameterNames = (functionNode : Object) : Array<string> => {
+const getFunctionParameterNames = (functionNode : Object) : Array<string> => {
     return _.map(functionNode.params, (param) => {
         if (_.has(param, 'name')) {
             return param.name;
@@ -28,7 +22,7 @@ getFunctionParameterNames = (functionNode : Object) : Array<string> => {
 /**
  * Gets all parameter names, including those that refer to a path, e.g. "@param foo; @param foo.bar".
  */
-getJsdocParameterNamesDeep = (jsdoc : Object, targetTagName : string) : Array<string> => {
+const getJsdocParameterNamesDeep = (jsdoc : Object, targetTagName : string) : Array<string> => {
     let jsdocParameterNames;
 
     jsdocParameterNames = _.filter(jsdoc.tags, {
@@ -40,7 +34,7 @@ getJsdocParameterNamesDeep = (jsdoc : Object, targetTagName : string) : Array<st
     return jsdocParameterNames;
 };
 
-getJsdocParameterNames = (jsdoc : Object, targetTagName : string) : Array<string> => {
+const getJsdocParameterNames = (jsdoc : Object, targetTagName : string) : Array<string> => {
     let jsdocParameterNames;
 
     jsdocParameterNames = getJsdocParameterNamesDeep(jsdoc, targetTagName);
@@ -52,14 +46,12 @@ getJsdocParameterNames = (jsdoc : Object, targetTagName : string) : Array<string
     return jsdocParameterNames;
 };
 
-getPreferredTagName = (name : string, tagPreference : Object = {}) : string => {
-    let preferredTagName;
-
+const getPreferredTagName = (name : string, tagPreference : Object = {}) : string => {
     if (_.includes(_.values(tagPreference), name)) {
         return name;
     }
 
-    preferredTagName = _.findKey(tagNames, (aliases) => {
+    const preferredTagName = _.findKey(tagNames, (aliases) => {
         return _.includes(aliases, name);
     });
 
@@ -70,10 +62,8 @@ getPreferredTagName = (name : string, tagPreference : Object = {}) : string => {
     return _.has(tagPreference, name) ? tagPreference[name] : name;
 };
 
-isValidTag = (name : string) : boolean => {
-    let validTagNames;
-
-    validTagNames = _.keys(tagNames).concat(_.flatten(_.values(tagNames)));
+const isValidTag = (name : string) : boolean => {
+    const validTagNames = _.keys(tagNames).concat(_.flatten(_.values(tagNames)));
 
     return _.includes(validTagNames, name);
 };

src/rules/checkParamNames.js

@@ -1,14 +1,9 @@
 import _ from 'lodash';
 import iterateJsdoc from './../iterateJsdoc';
 
-let validateParameterNames,
-    validateParameterNamesDeep;
-
-validateParameterNames = (targetTagName : string, functionParameterNames : Array<string>, jsdocParameterNames : Array<string>, report : Function) => {
+const validateParameterNames = (targetTagName : string, functionParameterNames : Array<string>, jsdocParameterNames : Array<string>, report : Function) => {
     return _.some(jsdocParameterNames, (jsdocParameterName, index) => {
-        let functionParameterName;
-
-        functionParameterName = functionParameterNames[index];
+        const functionParameterName = functionParameterNames[index];
 
         if (!functionParameterName) {
             report('@' + targetTagName + ' "' + jsdocParameterName + '" does not match an existing function parameter.');
@@ -25,27 +20,25 @@ validateParameterNames = (targetTagName : string, functionParameterNames : Array
 
             return true;
         }
+
+        return false;
     });
 };
 
-validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames : Array<string>, report : Function) => {
+const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames : Array<string>, report : Function) => {
     let lastRealParameter;
 
     return _.some(jsdocParameterNames, (jsdocParameterName) => {
-        let isPropertyPath;
-
-        isPropertyPath = _.includes(jsdocParameterName, '.');
+        const isPropertyPath = _.includes(jsdocParameterName, '.');
 
         if (isPropertyPath) {
-            let pathRootNodeName;
-
             if (!lastRealParameter) {
                 report('@' + targetTagName + ' path declaration ("' + jsdocParameterName + '") appears before any real parameter.');
 
                 return true;
             }
 
-            pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));
+            const pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));
 
             if (pathRootNodeName !== lastRealParameter) {
                 report('@' + targetTagName + ' path declaration ("' + jsdocParameterName + '") root node name ("' + pathRootNodeName + '") does not match previous real parameter name ("' + lastRealParameter + '").');
@@ -55,25 +48,20 @@ validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames : Arra
         } else {
             lastRealParameter = jsdocParameterName;
         }
+
+        return false;
     });
 };
 
 export default iterateJsdoc(({
     report,
     utils
 }) => {
-    let functionParameterNames,
-        isError,
-        jsdocParameterNames,
-        jsdocParameterNamesDeep,
-        targetTagName;
-
-    functionParameterNames = utils.getFunctionParameterNames();
-    jsdocParameterNames = utils.getJsdocParameterNames();
-    jsdocParameterNamesDeep = utils.getJsdocParameterNamesDeep();
-    targetTagName = utils.getPreferredTagName('param');
-
-    isError = validateParameterNames(targetTagName, functionParameterNames, jsdocParameterNames, report);
+    const functionParameterNames = utils.getFunctionParameterNames();
+    const jsdocParameterNames = utils.getJsdocParameterNames();
+    const jsdocParameterNamesDeep = utils.getJsdocParameterNamesDeep();
+    const targetTagName = utils.getPreferredTagName('param');
+    const isError = validateParameterNames(targetTagName, functionParameterNames, jsdocParameterNames, report);
 
     if (isError) {
         return;

src/rules/checkTagNames.js

@@ -8,9 +8,7 @@ export default iterateJsdoc(({
 }) => {
     _.forEach(jsdoc.tags, (jsdocTag) => {
         if (utils.isValidTag(jsdocTag.tag)) {
-            let preferredTagName;
-
-            preferredTagName = utils.getPreferredTagName(jsdocTag.tag);
+            const preferredTagName = utils.getPreferredTagName(jsdocTag.tag);
 
             if (preferredTagName !== jsdocTag.tag) {
                 report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".');

src/rules/checkTypes.js

@@ -1,11 +1,7 @@
 import _ from 'lodash';
 import iterateJsdoc from './../iterateJsdoc';
 
-let strictNativeTypes,
-    targetTagAliases,
-    targetTags;
-
-targetTags = [
+let targetTags = [
     'class',
     'constant',
     'enum',
@@ -20,7 +16,7 @@ targetTags = [
     'typedef'
 ];
 
-targetTagAliases = [
+const targetTagAliases = [
     'constructor',
     'const',
     'var',
@@ -33,7 +29,7 @@ targetTagAliases = [
 
 targetTags = targetTags.concat(targetTagAliases);
 
-strictNativeTypes = [
+const strictNativeTypes = [
     'boolean',
     'number',
     'string',
@@ -48,9 +44,7 @@ export default iterateJsdoc(({
     jsdoc,
     report
 }) => {
-    let jsdocTags;
-
-    jsdocTags = _.filter(jsdoc.tags, (tag) => {
+    const jsdocTags = _.filter(jsdoc.tags, (tag) => {
         return _.includes(targetTags, tag.tag);
     });
 

src/rules/newlineAfterDescription.js

@@ -6,8 +6,7 @@ export default iterateJsdoc(({
     report,
     context
 }) => {
-    let always,
-        descriptionEndsWithANewline;
+    let always;
 
     if (!jsdoc.description || !jsdoc.tags.length) {
         return;
@@ -22,7 +21,7 @@ export default iterateJsdoc(({
     // The contents of the jsdoc.source and of jsdoc.description is left trimmed.
     // The contents of the jsdoc.description is right trimmed.
     // This gets the text following the description.
-    descriptionEndsWithANewline = _.startsWith(jsdoc.source.slice(jsdoc.description.length), '\n\n');
+    const descriptionEndsWithANewline = _.startsWith(jsdoc.source.slice(jsdoc.description.length), '\n\n');
 
     if (always) {
         if (!descriptionEndsWithANewline) {

src/rules/requireDescriptionCompleteSentence.js

@@ -1,37 +1,32 @@
 import _ from 'lodash';
 import iterateJsdoc from './../iterateJsdoc';
 
-let extractParagraphs,
-    isNewLinePrecededByAPeriod,
-    validateDescription;
-
-extractParagraphs = (text) => {
+const extractParagraphs = (text) => {
     return text.split(/\n\n/);
 };
 
-isNewLinePrecededByAPeriod = (text) => {
-    let lastLineEndsSentence,
-        lines;
+const isNewLinePrecededByAPeriod = (text) => {
+    let lastLineEndsSentence;
 
-    lines = text.split('\n');
+    const lines = text.split('\n');
 
     return !_.some(lines, (line) => {
         if (_.isBoolean(lastLineEndsSentence) && !lastLineEndsSentence && /^[A-Z]/.test(line)) {
             return true;
         }
 
         lastLineEndsSentence = /\.$/.test(line);
+
+        return false;
     });
 };
 
-validateDescription = (description, report) => {
-    let paragraphs;
-
+const validateDescription = (description, report) => {
     if (!description) {
         return false;
     }
 
-    paragraphs = extractParagraphs(description);
+    const paragraphs = extractParagraphs(description);
 
     return _.some(paragraphs, (paragraph, index) => {
         if (!/^[A-Z]/.test(paragraph)) {
@@ -55,27 +50,25 @@ validateDescription = (description, report) => {
 
             return true;
         }
+
+        return false;
     });
 };
 
 export default iterateJsdoc(({
     jsdoc,
     report
 }) => {
-    let tags;
-
     if (validateDescription(jsdoc.description, report)) {
         return;
     }
 
-    tags = _.filter(jsdoc.tags, (tag) => {
+    const tags = _.filter(jsdoc.tags, (tag) => {
         return _.includes(['param', 'returns'], tag.tag);
     });
 
     _.some(tags, (tag) => {
-        let description;
-
-        description = _.trimStart(tag.description, '- ');
+        const description = _.trimStart(tag.description, '- ');
 
         return validateDescription(description, report);
     });

src/rules/requireHyphenBeforeDescription.js

@@ -5,9 +5,7 @@ export default iterateJsdoc(({
     jsdoc,
     report
 }) => {
-    let jsdocTags;
-
-    jsdocTags = _.filter(jsdoc.tags, {
+    const jsdocTags = _.filter(jsdoc.tags, {
         tag: 'param'
     });
 

src/rules/requireParam.js

@@ -5,21 +5,18 @@ export default iterateJsdoc(({
     report,
     utils
 }) => {
-    let functionParameterNames,
-        jsdocParameterNames;
-
-    functionParameterNames = utils.getFunctionParameterNames();
-    jsdocParameterNames = utils.getJsdocParameterNames();
+    const functionParameterNames = utils.getFunctionParameterNames();
+    const jsdocParameterNames = utils.getJsdocParameterNames();
 
     _.some(functionParameterNames, (functionParameterName, index) => {
-        let jsdocParameterName;
-
-        jsdocParameterName = jsdocParameterNames[index];
+        const jsdocParameterName = jsdocParameterNames[index];
 
         if (!jsdocParameterName) {
             report('Missing JSDoc @' + utils.getPreferredTagName('param') + ' "' + functionParameterName + '" declaration.');
 
             return true;
         }
+
+        return false;
     });
 });