Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion crates/oxc_linter/src/generated/rule_runner_impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1551,7 +1551,8 @@ impl RuleRunner for crate::rules::jsdoc::require_returns_type::RequireReturnsTyp
}

impl RuleRunner for crate::rules::jsdoc::require_yields::RequireYields {
const NODE_TYPES: Option<&AstTypesBitset> = None;
const NODE_TYPES: Option<&AstTypesBitset> =
Some(&AstTypesBitset::from_types(&[AstType::Function, AstType::YieldExpression]));
const RUN_FUNCTIONS: RuleRunFunctionsImplemented = RuleRunFunctionsImplemented::Run;
}

Expand Down
24 changes: 16 additions & 8 deletions crates/oxc_linter/src/rules/jsdoc/require_yields.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
use std::ops::Deref;

use oxc_ast::AstKind;
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
Expand Down Expand Up @@ -37,6 +39,14 @@ fn missing_yields_with_generator(span: Span) -> OxcDiagnostic {
#[derive(Debug, Default, Clone)]
pub struct RequireYields(Box<RequireYieldsConfig>);

impl Deref for RequireYields {
type Target = RequireYieldsConfig;

fn deref(&self) -> &Self::Target {
&self.0
}
}

declare_oxc_lint!(
/// ### What it does
///
Expand Down Expand Up @@ -71,7 +81,7 @@ declare_oxc_lint!(
);

#[derive(Debug, Clone, Deserialize)]
struct RequireYieldsConfig {
pub struct RequireYieldsConfig {
#[serde(default = "default_exempted_by", rename = "exemptedBy")]
exempted_by: Vec<String>,
#[serde(default, rename = "forceRequireYields")]
Expand Down Expand Up @@ -103,8 +113,6 @@ impl Rule for RequireYields {
}

fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) {
let config = &self.0;

// This rule checks generator function should have JSDoc `@yields` tag.
// By default, this rule only checks:
// ```
Expand Down Expand Up @@ -134,7 +142,7 @@ impl Rule for RequireYields {
if jsdocs
.iter()
.filter(|jsdoc| !should_ignore_as_custom_skip(jsdoc))
.filter(|jsdoc| !should_ignore_as_avoid(jsdoc, settings, &config.exempted_by))
.filter(|jsdoc| !should_ignore_as_avoid(jsdoc, settings, &self.exempted_by))
.filter(|jsdoc| !should_ignore_as_private(jsdoc, settings))
.filter(|jsdoc| !should_ignore_as_internal(jsdoc, settings))
.count()
Expand All @@ -148,7 +156,7 @@ impl Rule for RequireYields {

// Without this option, need to check `yield` value.
// Check will be performed in `YieldExpression` branch.
if config.force_require_yields
if self.force_require_yields
&& is_missing_special_tag(&jsdoc_tags, resolved_yields_tag_name)
{
ctx.diagnostic(missing_yields(func.span));
Expand All @@ -163,7 +171,7 @@ impl Rule for RequireYields {
return;
}

if config.with_generator_tag {
if self.with_generator_tag {
let resolved_generator_tag_name = settings.resolve_tag_name("generator");

if let Some(span) = is_missing_yields_tag_with_generator_tag(
Expand All @@ -186,7 +194,7 @@ impl Rule for RequireYields {
AstKind::YieldExpression(yield_expr) => {
// With this option, no needs to check `yield` value.
// We can perform all checks in `Function` branch instead.
if config.force_require_yields {
if self.force_require_yields {
return;
}

Expand Down Expand Up @@ -226,7 +234,7 @@ impl Rule for RequireYields {
if jsdocs
.iter()
.filter(|jsdoc| !should_ignore_as_custom_skip(jsdoc))
.filter(|jsdoc| !should_ignore_as_avoid(jsdoc, settings, &config.exempted_by))
.filter(|jsdoc| !should_ignore_as_avoid(jsdoc, settings, &self.exempted_by))
.filter(|jsdoc| !should_ignore_as_private(jsdoc, settings))
.filter(|jsdoc| !should_ignore_as_internal(jsdoc, settings))
.count()
Expand Down
Loading