Skip to content
New issue

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

no-multi-asterisks false positive on single line doc #735

Closed
OpportunityLiu opened this issue May 15, 2021 · 2 comments
Closed

no-multi-asterisks false positive on single line doc #735

OpportunityLiu opened this issue May 15, 2021 · 2 comments

Comments

@OpportunityLiu
Copy link

Expected behavior

no error for single line doc

Actual behavior

no-multi-asterisks for single line doc

ESLint Config

    parser: '@typescript-eslint/parser'
    parserOptions:
      project: tsconfig.json
    extends:
      - eslint:recommended
      - plugin:@typescript-eslint/recommended
      - plugin:@typescript-eslint/recommended-requiring-type-checking
      - plugin:jsdoc/recommended
    rules:
      jsdoc/require-jsdoc:
        - 1
        - require:
            ClassDeclaration: true
            FunctionDeclaration: true
          contexts:
            - TSMethodSignature
            - TSInterfaceDeclaration
            - TSTypeAliasDeclaration
            - MethodDefinition[ kind=/(method|get)/ ]:has(FunctionExpression)
            - { context: ClassProperty, inlineCommentBlock: true }
            - { context: TSInterfaceBody > TSPropertySignature, inlineCommentBlock: true }
      jsdoc/no-types: 1
      jsdoc/require-description:
        - 1
        - contexts: [any]
      jsdoc/require-param: 0
      jsdoc/require-param-type: 0
      jsdoc/require-returns: 0
      jsdoc/require-returns-check: 0
      jsdoc/require-returns-type: 0

ESLint sample

/** foo */
function foo(): void {
    //
}

Environment

  • Node version: v14.17.0
  • ESLint version v7.26.0
  • eslint-plugin-jsdoc version: 34.6.0
@gajus
Copy link
Owner

gajus commented May 15, 2021

🎉 This issue has been resolved in version 34.6.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label May 15, 2021
@brettz9
Copy link
Collaborator

brettz9 commented May 15, 2021

Thanks for the report, and apologies for overlooking that important case!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants