Closed ComradeVanti closed 6 months ago
I have the following export in my TypeScript project:
/** * Command options for the login command */ export type LoginOptions = CmdOptions<{ username?: string; password?: string; email?: string; basicAuth?: boolean; alwaysAuth?: boolean; }>;
I expect to get a warning that JSDoc for properties is missing.
I do not get a warning for the properties.
The properties get the expected warning if either:
module.exports = { root: true, env: { node: true, }, extends: [ "eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:jsdoc/recommended-typescript", "prettier", ], rules: { "no-console": process.env.NODE_ENV === "production" ? "error" : "off", "no-debugger": process.env.NODE_ENV === "production" ? "error" : "off", "jsdoc/require-jsdoc": [ "warn", { publicOnly: { ancestorsOnly: true, cjs: true }, contexts: [ "TSTypeAliasDeclaration", "TSInterfaceDeclaration", "TSMethodSignature", "TSPropertySignature", ], }, ], "jsdoc/require-throws": 1, "jsdoc/require-returns": 0, }, parser: "@typescript-eslint/parser", plugins: ["@typescript-eslint", "jsdoc"], };
eslint-plugin-jsdoc
:tada: This issue has been resolved in version 48.0.3 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
Expected behavior
I have the following export in my TypeScript project:
I expect to get a warning that JSDoc for properties is missing.
Actual behavior
I do not get a warning for the properties.
Notes
The properties get the expected warning if either:
ESLint Config
Environment
eslint-plugin-jsdoc
version: 47.0.2