Estoy tratando de configurar los tipos preferredTypes para evitar * o any de parámetro/propiedad. No quiero usar la mayoría de las reglas recomendadas, ya que señala demasiados problemas. Estoy tratando de facilitar a mi equipo el uso de este conjunto de reglas de lint y solucionar problemas gradualmente y activar las reglas más tarde.
Pensé que prevenir @param {*} sería fácil según los documentos :
settings.jsdoc.preferredTypesUn mapa de opciones para indicar los tipos preferidos o prohibidos (si los tipos predeterminados se indican aquí, estos tendrán prioridad sobre las recomendaciones predeterminadas para los tipos de verificación).
Entonces mi objeto de configuración .eslintrc.js se ve así:
... settings: { ... jsdoc: { preferredTypes: { '*': false } } }Y tengo las reglas 'jsdoc/valid-types', 'jsdoc/no-undefined-types' y 'jsdoc/check-tag-names' (elegido como un equilibrio para marcar errores más grandes pero no demasiados en este momento).
Pero no veo ningún informe de errores en @param {*} .
¿Se puede hacer esto sin agregar reglas de pelusa jsdoc adicionales, o si las necesita, puedo personalizarlo para que solo toque {*} o {any} ?
jsdoc/check-types Se hace referencia a esta regla en la documentación para check-types y esta regla es obligatoria, aunque no está explícita en la documentación para los tipos preferredTypes .
Aquí está el extracto enterrado en la parte inferior de los ejemplos check-types :
/** * @param {*} baz */ function qux(baz) { } // Settings: {"jsdoc":{"preferredTypes":{"*":false,"abc":"Abc","string":"Str"}}} // Message: Invalid JSDoc @param "baz" type "*". Sin check-types tipos preferidos no hace nada, lo cual, si lo piensa bien, tiene sentido.