`tag-lines` should support `startLines` for `tags` groups

[mvorisek]

class FormService {
    /**
     * Validate a field using defined validation rules.
     *
     * @param   {$}             $form
     * @param   {string}        fieldName
     *
     * @returns {false}
     */
    validateField($form, fieldName) {
        return false
    }
}

Motivation

Our projects are mostly based on PHP where our coding style is to separate same phpdoc tags with a new line, ie. 1 empty line between params and return phpdoc.

To be consistent, we want the same style for JS too.

Current behavior

It seems startLines cannot be defined for specific tags.

Desired behavior

I would expect config like, ie. startLines in tags -> returns, to be possible:

'jsdoc/tag-lines': ['error', 'never', {
    startLines: 1,
    tags: {
        returns: { startLines: 1 },
    },
}],

and keep the empty line between @param and @returns in the code example above.

[brettz9]

Are you inclined against using sort-tags? With tagSequence, you could put @param and @returns into separate groups and use the default value for linesBetween (of 1).

[mvorisek]

Thank you!

'jsdoc/sort-tags': ['error', {
    tagSequence: [
        { tags: ['param'] },
        { tags: ['returns'] },
    ],
}],
'jsdoc/tag-lines': ['error', 'any', {
    startLines: 1,
}],

is working for me.