Skip to content

Using tagNamePreference breaks other rules #1559

@edg2s

Description

@edg2s

Expected behavior

jsdoc/require-yields-type reports errors even if I have set my preferred tag name to yield via tagNamePreference

Actual behavior

The error is not detected

ESLint Config

{
	"extends": [ "plugin:jsdoc/recommended" ],
	"settings": {
		"jsdoc": {
			"tagNamePreference": {
				"returns": "return",
				"yields": "yield"
			}
		}
	},
	"rules": {
		"jsdoc/require-yields-type": "error"
	}
}

ESLint sample

/**
 * @yield
 */

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions