Skip to content

docs(linter): Add configuration option docs for jsdoc/require-yields rule. #15024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

docs(linter): Add configuration option docs for jsdoc/require-yields rule. #15024

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90abb24
docs(linter): Add configuration option docs for jsdoc/require-yields …
connorshea Oct 28, 2025
9a51f03
Improve phrasing
connorshea Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions crates/oxc_linter/src/rules/jsdoc/require_yields.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_semantic::{JSDoc, JSDocTag};
use oxc_span::Span;
use schemars::JsonSchema;
use serde::Deserialize;

use crate::{
Expand Down Expand Up @@ -77,18 +78,22 @@ declare_oxc_lint!(
/// ```
RequireYields,
jsdoc,
correctness
correctness,
config = RequireYieldsConfig,
);

#[derive(Debug, Clone, Deserialize)]
#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct RequireYieldsConfig {
#[serde(default = "default_exempted_by", rename = "exemptedBy")]
/// Functions with these tags will be exempted from the lint rule.
#[serde(default = "default_exempted_by")]
exempted_by: Vec<String>,
#[serde(default, rename = "forceRequireYields")]
/// When `true`, all generator functions must have a `@yields` tag, even if they don't yield a value or have an empty body.
force_require_yields: bool,
#[serde(default, rename = "withGeneratorTag")]
/// When `true`, require `@yields` when a `@generator` tag is present.
with_generator_tag: bool,
}

impl Default for RequireYieldsConfig {
fn default() -> Self {
Self {
Expand Down
Loading