Merge pull request #260 from brettz9/check-types-replacement

- `check-types`: Allow `replacement` in place of `preferredType`

Author: brettz9

.README/README.md

@@ -236,8 +236,8 @@ The format of the configuration is as follows:
     forbidding the type. The message string will have the following
     substrings with special meaning replaced with their corresponding
     value (`{{tagName}}`, `{{tagValue}}`, `{{badType}}`, and
-    `{{preferredType}}`, noting that the latter is of no use when one is
-    merely forbidding a type).
+    `{{preferredType}}` (or `{{replacement}}`), noting that the latter is
+    of no use when one is merely forbidding a type).
 
 If `no-undefined-types` has the option key `preferredTypesDefined` set to
 `true`, the preferred types indicated in the `settings.jsdoc.preferredTypes`

README.md

@@ -289,8 +289,8 @@ The format of the configuration is as follows:
     forbidding the type. The message string will have the following
     substrings with special meaning replaced with their corresponding
     value (`{{tagName}}`, `{{tagValue}}`, `{{badType}}`, and
-    `{{preferredType}}`, noting that the latter is of no use when one is
-    merely forbidding a type).
+    `{{preferredType}}` (or `{{replacement}}`), noting that the latter is
+    of no use when one is merely forbidding a type).
 
 If `no-undefined-types` has the option key `preferredTypesDefined` set to
 `true`, the preferred types indicated in the `settings.jsdoc.preferredTypes`
@@ -1402,7 +1402,7 @@ function qux(foo) {
  */
 function qux(foo) {
 }
-// Settings: {"jsdoc":{"preferredTypes":{"abc":{"message":"Messed up JSDoc @{{tagName}}{{tagValue}} type \"{{badType}}\"; prefer: \"{{preferredType}}\".","replacement":"Abc"},"string":"Str"}}}
+// Settings: {"jsdoc":{"preferredTypes":{"abc":{"message":"Messed up JSDoc @{{tagName}}{{tagValue}} type \"{{badType}}\"; prefer: \"{{replacement}}\".","replacement":"Abc"},"string":"Str"}}}
 // Message: Messed up JSDoc @param "foo" type "abc"; prefer: "Abc".
 
 /**

src/rules/checkTypes.js

@@ -109,6 +109,7 @@ export default iterateJsdoc(({
           message ? {
             badType,
             preferredType,
+            replacement: preferredType,
             tagName,
             tagValue
           } : null

test/rules/assertions/checkTypes.js

@@ -191,7 +191,7 @@ export default {
         jsdoc: {
           preferredTypes: {
             abc: {
-              message: 'Messed up JSDoc @{{tagName}}{{tagValue}} type "{{badType}}"; prefer: "{{preferredType}}".',
+              message: 'Messed up JSDoc @{{tagName}}{{tagValue}} type "{{badType}}"; prefer: "{{replacement}}".',
               replacement: 'Abc'
             },
             string: 'Str'