Function: withCustomJsdocTags()

function withCustomJsdocTags(tags: string[]): Config;

Returns a partial ESLint flat config block that extends the allowed JSDoc tag list beyond the built-in TypeDoc/TSDoc set.

Use this when your project uses custom TypeDoc tags (e.g. @myCustomTag) that are not part of the standard TypeDoc tag vocabulary. Add the returned config to your configure() call to suppress jsdoc/check-tag-names false positives.

Parameters

Parameter	Type	Description
tags	string[]	Array of custom tag names to allow (without the leading @)

Returns

Config

A partial ESLint flat config block that overrides jsdoc/check-tag-names

Example

import { configure, withCustomJsdocTags } from "@nhtio/eslint-config";
export default configure(withCustomJsdocTags(["myCustomTag", "internal"]));