oxc-project/oxc · error · OxcDiagnostic

Invalid tag name found.

Error message

Invalid tag name found.

What it means

Fires from jsdoc/check-tag-names when a JSDoc block uses a tag not present in the rule's allowed set (built-in JSDoc tags plus any configured additional tags, minus configured blocked ones). The helper attaches the rule's explanatory help text and labels the tag's span.

Source

Thrown at crates/oxc_linter/src/rules/jsdoc/check_tag_names.rs:14

use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;
use schemars::JsonSchema;
use serde::Deserialize;

use crate::{
    context::LintContext,
    rule::{DefaultRuleConfig, Rule},
    utils::{should_ignore_as_internal, should_ignore_as_private},
};

fn check_tag_names_diagnostic(span: Span, x1: &str) -> OxcDiagnostic {
    OxcDiagnostic::warn("Invalid tag name found.").with_help(x1.to_string()).with_label(span)
}

#[derive(Debug, Default, Clone, Deserialize)]
pub struct CheckTagNames(Box<CheckTagNamesConfig>);

declare_oxc_lint!(
    /// ### What it does
    ///
    /// Reports invalid block tag names.
    /// Additionally checks for tag names that are redundant when using a type checker such as TypeScript.
    ///
    /// ### Why is this bad?
    ///
    /// Using invalid tags can lead to confusion and make the documentation harder to read.
    ///
    /// ### Examples
    ///
    /// Examples of **incorrect** code for this rule:

View on GitHub (pinned to e1e7af627c)

Solutions

1. Use a valid JSDoc tag name
2. Add the custom tag to the rule's `enabled`/additional tags setting
3. Remove the invalid tag

When it happens

Trigger: Thrown at crates/oxc_linter/src/rules/jsdoc/check_tag_names.rs:14 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of oxc-project/oxc@e1e7af627c (2026-08-20). Data as JSON: /api/errors/101426c266ab36cf. Report an issue: GitHub.