Disallow {[string]} array notation

[yvele]

I know that the {[string]} array notation doesn't exists at all.. but I can find it quite often in my company code base, and I would like to restrict it (ideally with an auto fix). Does that make sense?

Is it possible to disallow and fix this kind of array notation?

❌ This should be disallowed

/**
 * @param {[string]} foo
 */

And fixed depending on preferredTypes to either

/**
 * @param {Array<string>} foo
 */

/**
 * @param {Array.<string>} foo
 */

/**
 * @param {string[]} foo
 */

[brettz9]

[string] is a valid type for tuples in TypeScript: https://www.typescriptlang.org/docs/handbook/basic-types.html#tuple .

Both jsdoc and Closure have open issues to add this support. (There are also issues filed with closure and jsdoc which may also be of interest in seeking to add a way for jsdoc to add names for the components (Tuple in the case of the closure feature request); but these are not supported in jsdoctypeparser.)

There is a jsdoctypeparser issue filed, but the PR I put together for it needs research toward which rule differences exist for which modes, and I haven't found time for this research. However, I should be able to complete the PR earlier and just add to the different modes gradually, such as treating tuples as disallowed for "settings":{"jsdoc":{"mode": "jsdoc"}} and "settings":{"jsdoc":{"mode": "closure"}} (and tying it to a settings.jsdoc.modeVersion or mode: ["jsdoc", <version>] as well in case future versions of jsdoc/Closure do support this). But still would need time to get to it (or someone to revise the PR).

So that aspect is really a jsdoctypeparser, but as with your other issue recently filed, the fixer does have something for us to fix on our end.

[yvele]

Thanks for the super explicit and referenced clarification! (I like your style 👍 )

Yeah, I would like to disable the tuple type in projects that doesn't use TypeScript

[brettz9]

Closing as this is effectively a dupe of part of #356, though I have made explicit mention there of this use case.

[yvele]

Hum FYI I just remembered where I saw the {[type]} array notation back in 2017: jsdoc/jsdoc#1073 (comment)

/**
 * Foo function.
 *
 * @param {[number, string]} bar - The bar array.
 */
function foo(bar) {}

[gajus]

🎉 This issue has been resolved in version 28.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀