We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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
The text was updated successfully, but these errors were encountered:
fix(require-jsdoc): ensure children of TS type reference and parame…
require-jsdoc
55d9f25
…ter instantiation can be exports; fixes gajus#1186
7461e01
…ter instantiation can be exports; fixes #1186
🎉 This issue has been resolved in version 48.0.3 🎉
The release is available on:
Your semantic-release bot 📦🚀
Sorry, something went wrong.
Successfully merging a pull request may close this issue.
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.2The text was updated successfully, but these errors were encountered: