oxc-project/oxc · error · OxcDiagnostic

Missing name in `@property` tag.

Error message

Missing name in `@property` tag.

What it means

Raised by the jsdoc/require_property_name rule when a `@property` tag in a JSDoc block (typically documenting a typedef or object type) omits the property name. At the throw site the tag cannot be tied to a concrete member of the documented type, making the type documentation incomplete/unresolvable. run_once() scans all `@property` tags of the file's JSDoc and reports each one lacking a name, skipping blocks marked internal or private.

Source

Thrown at crates/oxc_linter/src/rules/jsdoc/require_property_name.rs:12

use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;

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

fn require_property_name_diagnostic(span: Span) -> OxcDiagnostic {
    OxcDiagnostic::warn("Missing name in `@property` tag.")
        .with_help("Add a type name to this `@property` tag.")
        .with_label(span)
}

#[derive(Debug, Default, Clone)]
pub struct RequirePropertyName;

declare_oxc_lint!(
    /// ### What it does
    ///
    /// Requires that all `@property` tags have names.
    ///
    /// ### Why is this bad?
    ///
    /// The name of a property type should be documented.
    ///
    /// ### Examples
    ///

View on GitHub (pinned to e1e7af627c)

Solutions

1. Add the property name after the type: `@property {string} propName`
2. Remove the malformed `@property` tag

When it happens

Trigger: Thrown at crates/oxc_linter/src/rules/jsdoc/require_property_name.rs:12 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/0509d5ea05a8a86f. Report an issue: GitHub.