Skip to content

Optionally allow bullet lists and other indented text in comments when check-indentation is enabled #541

@edg2s

Description

@edg2s

For example:

/**
 * Foobar
 *
 * This method does the following things:
 * - foo...
 *   this is the first step
 * - bar
 *   this is the second step
 */

Rather than looking for bullet lists explicitly, the option could cause the linter to only check the indentation of the first line (of each 'section'?):

/**
 * Allowed
 *   Indentation
 */

/**
 *   Disallowed
 *   Indentation
 */

This could also apply to tags with descriptions, instead of having to list them manually:

/**
 * @param {number} val Multi-
 *                     line
 */

/**
 *   @param {number} val Still disallowed
 */

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions