Skip to content

Can't require descriptions on TS Property Signatures #582

@snowystinger

Description

@snowystinger

Expected behavior

{
      code: `
          interface quux {
            checked?: boolean
          }
      `,
      errors: [
        {
          message: 'Missing JSDoc @description declaration.',
        },
      ],
      options: [
        {
          contexts: [
            'TSPropertySignature',
          ],
          descriptionStyle: 'tag',
        },
      ],
      parser: require.resolve('@typescript-eslint/parser'),
    },

Actual behavior

This passes even though checked doesn't have a description.

ESLint Config

ESLint sample

// Format code using Markdown code blocks

Environment

  • Node version:
  • ESLint version
  • eslint-plugin-jsdoc version:

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions