Chore: Enable preferType in valid-jsdoc (refs #5188) (#6634)

Author: nzakas

Makefile.js

@@ -329,7 +329,7 @@ function getBranches() {
 /**
  * Lints Markdown files.
  * @param {array} files Array of file names to lint.
- * @returns {object} exec-style exit code object.
+ * @returns {Object} exec-style exit code object.
  * @private
  */
 function lintMarkdown(files) {
@@ -837,7 +837,7 @@ target.checkLicenses = function() {
 
     /**
      * Check if a dependency is eligible to be used by us
-     * @param {object} dependency dependency to check
+     * @param {Object} dependency dependency to check
      * @returns {boolean} true if we have permission
      * @private
      */
@@ -950,7 +950,7 @@ target.checkGitCommit = function() {
 /**
  * Downloads a repository which has many js files to test performance with multi files.
  * Here, it's eslint@1.10.3 (450 files)
- * @param {function} cb - A callback function.
+ * @param {Function} cb - A callback function.
  * @returns {void}
  */
 function downloadMultifilesTestTarget(cb) {
@@ -993,7 +993,7 @@ function createConfigForPerformanceTest() {
  * @param {int} runs Total number of runs to do
  * @param {int} runNumber Current run number
  * @param {int[]} results Collection results from each run
- * @param {function} cb Function to call when everything is done
+ * @param {Function} cb Function to call when everything is done
  * @returns {int[]} calls the cb with all the results
  * @private
  */
@@ -1033,7 +1033,7 @@ function time(cmd, runs, runNumber, results, cb) {
  * @param {string} title - A title.
  * @param {string} targets - Test targets.
  * @param {number} multiplier - A multiplier for limitation.
- * @param {function} cb - A callback function.
+ * @param {Function} cb - A callback function.
  * @returns {void}
  */
 function runPerformanceTest(title, targets, multiplier, cb) {

lib/cli-engine.js

@@ -340,7 +340,7 @@ function createIgnoreResult(filePath, baseDir) {
 
 /**
  * Checks if the given message is an error message.
- * @param {object} message The message to check.
+ * @param {Object} message The message to check.
  * @returns {boolean} Whether or not the message is an error message.
  * @private
  */

lib/code-path-analysis/code-path-state.js

@@ -225,7 +225,7 @@ function finalizeTestSegmentsOfFor(context, choiceContext, head) {
  * @constructor
  * @param {IdGenerator} idGenerator - An id generator to generate id for code
  *   path segments.
- * @param {function} onLooped - A callback function to notify looping.
+ * @param {Function} onLooped - A callback function to notify looping.
  */
 function CodePathState(idGenerator, onLooped) {
     this.idGenerator = idGenerator;
@@ -1280,7 +1280,7 @@ CodePathState.prototype = {
      * @param {boolean} breakable - The flag to indicate it can break by
      *      an unlabeled BreakStatement.
      * @param {string|null} label - The label of this context.
-     * @returns {object} The new context.
+     * @returns {Object} The new context.
      */
     pushBreakContext: function(breakable, label) {
         this.breakContext = {
@@ -1295,7 +1295,7 @@ CodePathState.prototype = {
     /**
      * Removes the top item of the break context stack.
      *
-     * @returns {object} The removed context.
+     * @returns {Object} The removed context.
      */
     popBreakContext: function() {
         var context = this.breakContext;

lib/code-path-analysis/code-path.js

@@ -22,7 +22,7 @@ var IdGenerator = require("./id-generator");
  * @constructor
  * @param {string} id - An identifier.
  * @param {CodePath|null} upper - The code path of the upper function scope.
- * @param {function} onLooped - A callback function to notify looping.
+ * @param {Function} onLooped - A callback function to notify looping.
  */
 function CodePath(id, upper, onLooped) {
 
@@ -117,10 +117,10 @@ CodePath.prototype = {
      * - `controller.skip()` - Skip the following segments in this branch.
      * - `controller.break()` - Skip all following segments.
      *
-     * @param {object} [options] - Omittable.
+     * @param {Object} [options] - Omittable.
      * @param {CodePathSegment} [options.first] - The first segment to traverse.
      * @param {CodePathSegment} [options.last] - The last segment to traverse.
-     * @param {function} callback - A callback function.
+     * @param {Function} callback - A callback function.
      * @returns {void}
      */
     traverseSegments: function(options, callback) {

lib/code-path-analysis/debug-helpers.js

@@ -140,7 +140,7 @@ module.exports = {
      * The DOT code can be visialized with Graphvis.
      *
      * @param {CodePath} codePath - A code path to make DOT.
-     * @param {object} traceMap - Optional. A map to check whether or not segments had been done.
+     * @param {Object} traceMap - Optional. A map to check whether or not segments had been done.
      * @returns {string} A DOT code of the code path.
      */
     makeDotArrows: function(codePath, traceMap) {

lib/code-path-analysis/fork-context.js

@@ -40,7 +40,7 @@ function isReachable(segment) {
  * @param {ForkContext} context - An instance.
  * @param {number} begin - The first index of the previous segments.
  * @param {number} end - The last index of the previous segments.
- * @param {function} create - A factory function of new segments.
+ * @param {Function} create - A factory function of new segments.
  * @returns {CodePathSegment[]} New segments.
  */
 function makeSegments(context, begin, end, create) {

lib/config/config-initializer.js

@@ -293,7 +293,7 @@ function getConfigForStyleGuide(guide) {
 /* istanbul ignore next: no need to test inquirer*/
 /**
  * Ask use a few questions on command prompt
- * @param {function} callback callback function when file has been written
+ * @param {Function} callback callback function when file has been written
  * @returns {void}
  */
 function promptUser(callback) {

lib/config/config-ops.js

@@ -267,7 +267,7 @@ module.exports = {
 
     /**
      * Checks whether every rule of a given config has valid severity or not.
-     * @param {object} config - The configuration for rules.
+     * @param {Object} config - The configuration for rules.
      * @returns {boolean} `true` if the configuration has valid severity.
      */
     isEverySeverityValid: function(config) {

lib/config/config-validator.js

@@ -25,7 +25,7 @@ var validators = {
 /**
  * Gets a complete options schema for a rule.
  * @param {string} id The rule's unique name.
- * @returns {object} JSON Schema for the rule's options.
+ * @returns {Object} JSON Schema for the rule's options.
  */
 function getRuleOptionsSchema(id) {
     var rule = rules.get(id),
@@ -119,7 +119,7 @@ function validateRuleOptions(id, options, source) {
 
 /**
  * Validates an environment object
- * @param {object} environment The environment config object to validate.
+ * @param {Object} environment The environment config object to validate.
  * @param {string} source The location to report with any errors.
  * @returns {void}
  */
@@ -152,7 +152,7 @@ function validateEnvironment(environment, source) {
 
 /**
  * Validates an entire config object.
- * @param {object} config The config object to validate.
+ * @param {Object} config The config object to validate.
  * @param {string} source The location to report with any errors.
  * @returns {void}
  */

lib/eslint.js

@@ -305,7 +305,7 @@ function enableReporting(reportingConfig, start, rulesToEnable) {
  * @param {Object} config The existing configuration data.
  * @param {Object[]} reportingConfig The existing reporting configuration data.
  * @param {Object[]} messages The messages queue.
- * @returns {object} Modified config object
+ * @returns {Object} Modified config object
  */
 function modifyConfigsFromComments(filename, ast, config, reportingConfig, messages) {
 
@@ -484,8 +484,8 @@ function createStubRule(message) {
 
     /**
      * Creates a fake rule object
-     * @param {object} context context object for each rule
-     * @returns {object} collection of node to listen on
+     * @param {Object} context context object for each rule
+     * @returns {Object} collection of node to listen on
      */
     function createRuleModule(context) {
         return {
@@ -522,7 +522,7 @@ var eslintEnvPattern = /\/\*\s*eslint-env\s(.+?)\*\//g;
 /**
  * Checks whether or not there is a comment which has "eslint-env *" in a given text.
  * @param {string} text - A source code text to check.
- * @returns {object|null} A result of parseListConfig() with "eslint-env *" comment.
+ * @returns {Object|null} A result of parseListConfig() with "eslint-env *" comment.
  */
 function findEslintEnv(text) {
     var match, retv;
@@ -1146,7 +1146,7 @@ module.exports = (function() {
 
     /**
      * Defines many new linting rules.
-     * @param {object} rulesToDefine map from unique rule identifier to rule
+     * @param {Object} rulesToDefine map from unique rule identifier to rule
      * @returns {void}
      */
     api.defineRules = function(rulesToDefine) {