Add @property to the no-types rules

[profaurore]

Motivation

Being able to disallow types on @property descriptions in Typescript files.

Current behavior

The no-types rule currently only covers the @param and @returns descriptions.

Desired behavior

The no-types rule should include @property descriptions.

Alternatives considered

The no-types rule should have a setting to optionally include @property descriptions.

[brettz9]

The default contexts only apply to functions. If the property option is on, should it also apply to all contexts?

[brettz9]

In what contexts do you want types removed from @property?

If from @typedef, then this will remove potentially useful information to developers in knowing what interfaces to create. Perhaps you instead want to report when there are @typedef and @callback so the whole structure can be removed (or adapted)?

Or do you mean when @property is added to @namespace and is already attached to a code construct? In such a case, I can see a use for it (since people may still use it for documentation), but if so, we should check for the presence of @namespace or such.

[profaurore]

Apologies for not responding to the first question. It is not clear to me, at least from reading the documentation, why the default context is limited to functions, so it is difficult for me to answer.

I would proppose that the rule applies to the ClassDeclaration context, where explicit type definitions may conflict with Typescript definitions.

/**
 * @class
 * @property {object} x
 */
class Example {
  x: number;
}

[github-actions]

🎉 This issue has been resolved in version 51.2.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[brettz9]

Thanks for the report. I've applied when found on a ClassDeclaration (a context which is now added to the checks). We don't want to be overly aggressive in the contexts as there could be @typedefs with @property tags whose types are needed.