Merge branch 'master' into move-settings-to-options

* master:
  refactor: leverage `settings` property from `iterateJsdoc.js` for consistent settings access

Author: brettz9

src/iterateJsdoc.js

@@ -253,6 +253,9 @@ const getSettings = (context) => {
   // `check-tag-names` and many require/param rules
   settings.tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
 
+  // `check-types` and `no-undefined-types`
+  settings.preferredTypes = _.get(context, 'settings.jsdoc.preferredTypes') || {};
+
   // `require-param`, `require-description`, `require-example`, `require-returns`
   settings.overrideReplacesDocs = _.get(context, 'settings.jsdoc.overrideReplacesDocs');
   settings.implementsReplacesDocs = _.get(context, 'settings.jsdoc.implementsReplacesDocs');

src/rules/checkTagNames.js

@@ -7,6 +7,7 @@ export default iterateJsdoc(({
   report,
   utils,
   context,
+  settings,
   jsdocNode
 }) => {
   if (!jsdoc.tags) {
@@ -15,10 +16,10 @@ export default iterateJsdoc(({
   const {definedTags = []} = context.options[0] || {};
 
   let definedPreferredTags = [];
-  const preferredTags = _.get(context, 'settings.jsdoc.tagNamePreference');
-  if (preferredTags) {
+  const {tagNamePreference} = settings;
+  if (Object.keys(tagNamePreference).length) {
     // Replace `_.values` with `Object.values` when we may start requiring Node 7+
-    definedPreferredTags = _.values(preferredTags).map((preferredTag) => {
+    definedPreferredTags = _.values(tagNamePreference).map((preferredTag) => {
       if (typeof preferredTag === 'string') {
         // May become an empty string but will be filtered out below
         return preferredTag;

src/rules/checkTypes.js

@@ -20,13 +20,14 @@ export default iterateJsdoc(({
   sourceCode,
   report,
   utils,
+  settings,
   context
 }) => {
   const jsdocTags = utils.filterTags((tag) => {
     return utils.isTagWithType(tag.tag);
   });
 
-  const preferredTypes = _.get(context, 'settings.jsdoc.preferredTypes');
+  const {preferredTypes} = settings;
   const optionObj = context.options[0];
   const noDefaults = _.get(optionObj, 'noDefaults');
   const unifyParentAndChildTypeChecks = _.get(optionObj, 'unifyParentAndChildTypeChecks');
@@ -45,7 +46,7 @@ export default iterateJsdoc(({
       let hasMatchingPreferredType;
       let isGenericMatch;
       let typeName = nodeName;
-      if (preferredTypes) {
+      if (Object.keys(preferredTypes).length) {
         const parentType = parentName === 'subject';
         if (unifyParentAndChildTypeChecks || parentType) {
           const syntax = _.get(parentNode, 'meta.syntax');

src/rules/noUndefinedTypes.js

@@ -20,6 +20,7 @@ const stripPseudoTypes = (str) => {
 export default iterateJsdoc(({
   context,
   report,
+  settings,
   sourceCode: {scopeManager},
   utils
 }) => {
@@ -28,8 +29,8 @@ export default iterateJsdoc(({
   const {definedTypes = []} = context.options[0] || {};
 
   let definedPreferredTypes = [];
-  const preferredTypes = _.get(context, 'settings.jsdoc.preferredTypes');
-  if (preferredTypes) {
+  const {preferredTypes} = settings;
+  if (Object.keys(preferredTypes).length) {
     // Replace `_.values` with `Object.values` when we may start requiring Node 7+
     definedPreferredTypes = _.values(preferredTypes).map((preferredType) => {
       if (typeof preferredType === 'string') {