Update: Add preferType option to valid-jsdoc rule (fixes #3056)

[gyandeeps]

@nzakas @ilyavolodin This is what I am thinking when it comes to this enhancement.

CC: @janmarek
Please share your views on the approach and the option setup.

[nzakas]

I think we can simplify this by treating it the same as prefer. So, the keys represent types you don't want to see and the values are what should be used instead. You could do { String: "string" } to warn about usng uppercase, for example. Thoughts?

[gyandeeps]

But what if inside the code somebody writes strinG by mistake then we will not be able to catch it. That why I always want to compare the lowercased value from the jsdoc with the key here.

[nzakas]

Hmmm, good point. I'm just concerned that the conversion to lowercase will be confusing, and will prevent people from using both String and string while avoiding strinG.

[tschaub]

I also think the unwanted: wanted pattern is sensible. Then prefer is about correcting wrongly chosen types (not typos). The toLowerCase conversion only catches a limited set of typos anyway. So it would guard against strinG but not sring etc.

[gyandeeps]

Even with unwanted: wanted pattern, how would we catch sring? As the matching against the keys will never find sring.
To make this work we need to maintain a whitelist of all the types that can be used.

[nzakas]

We can always say that this doesn't prevent misspellings, only common errors like using String instead of string.

[gyandeeps]

Will make the change and mention in docs that we dont check for spelling mistakes.

[nzakas]

Lgtm