-
-
Notifications
You must be signed in to change notification settings - Fork 485
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(linter/jsdoc): Implement require-param-name rule (#3636)
Part of #1170 > https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md
- Loading branch information
Showing
3 changed files
with
211 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
crates/oxc_linter/src/rules/jsdoc/require_param_name.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
use oxc_diagnostics::OxcDiagnostic; | ||
use oxc_macros::declare_oxc_lint; | ||
use oxc_span::Span; | ||
|
||
use crate::{ | ||
ast_util::is_function_node, | ||
context::LintContext, | ||
rule::Rule, | ||
utils::{get_function_nearest_jsdoc_node, should_ignore_as_internal, should_ignore_as_private}, | ||
AstNode, | ||
}; | ||
|
||
fn missing_name_diagnostic(span0: Span) -> OxcDiagnostic { | ||
OxcDiagnostic::warn("eslint-plugin-jsdoc(require-param-name): Missing JSDoc `@param` name.") | ||
.with_help("Add name to `@param` tag.") | ||
.with_labels([span0.into()]) | ||
} | ||
|
||
#[derive(Debug, Default, Clone)] | ||
pub struct RequireParamName; | ||
|
||
declare_oxc_lint!( | ||
/// ### What it does | ||
/// Requires that all `@param` tags have names. | ||
/// | ||
/// ### Why is this bad? | ||
/// The name of a param should be documented. | ||
/// | ||
/// ### Example | ||
/// ```javascript | ||
/// // Passing | ||
/// /** @param {SomeType} foo */ | ||
/// function quux (foo) {} | ||
/// | ||
/// // Failing | ||
/// /** @param {SomeType} */ | ||
/// function quux (foo) {} | ||
/// ``` | ||
RequireParamName, | ||
pedantic, | ||
); | ||
|
||
impl Rule for RequireParamName { | ||
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { | ||
if !is_function_node(node) { | ||
return; | ||
} | ||
|
||
// If no JSDoc is found, skip | ||
let Some(jsdocs) = get_function_nearest_jsdoc_node(node, ctx) | ||
.and_then(|node| ctx.jsdoc().get_all_by_node(node)) | ||
else { | ||
return; | ||
}; | ||
|
||
let settings = &ctx.settings().jsdoc; | ||
let resolved_param_tag_name = settings.resolve_tag_name("param"); | ||
|
||
for jsdoc in jsdocs | ||
.iter() | ||
.filter(|jsdoc| !should_ignore_as_internal(jsdoc, settings)) | ||
.filter(|jsdoc| !should_ignore_as_private(jsdoc, settings)) | ||
{ | ||
for tag in jsdoc.tags() { | ||
if tag.kind.parsed() != resolved_param_tag_name { | ||
continue; | ||
} | ||
|
||
let (_, name_part, _) = tag.type_name_comment(); | ||
|
||
// If name exists, skip | ||
if name_part.is_some() { | ||
continue; | ||
} | ||
|
||
ctx.diagnostic(missing_name_diagnostic(tag.kind.span)); | ||
} | ||
} | ||
} | ||
} | ||
|
||
#[test] | ||
fn test() { | ||
use crate::tester::Tester; | ||
|
||
let pass = vec![ | ||
( | ||
" | ||
/** | ||
* @param foo | ||
*/ | ||
function quux (foo) { | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** | ||
* @param {string} foo | ||
*/ | ||
function quux (foo) { | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** | ||
* @function | ||
* @param | ||
*/ | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** | ||
* @callback | ||
* @param | ||
*/ | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** | ||
* @param {Function} [processor=data => data] A function to run | ||
*/ | ||
function processData(processor) { | ||
return processor(data) | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** Example with multi-line param type. | ||
* | ||
* @param {function( | ||
* number | ||
* )} cb Callback. | ||
*/ | ||
function example(cb) { | ||
cb(42); | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
]; | ||
|
||
let fail = vec![ | ||
( | ||
" | ||
/** | ||
* @param | ||
*/ | ||
function quux (foo) { | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
( | ||
" | ||
/** | ||
* @param {string} | ||
*/ | ||
function quux (foo) { | ||
} | ||
", | ||
None, | ||
None, | ||
), | ||
]; | ||
|
||
Tester::new(RequireParamName::NAME, pass, fail).test_and_snapshot(); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
source: crates/oxc_linter/src/tester.rs | ||
expression: require_param_name | ||
--- | ||
⚠ eslint-plugin-jsdoc(require-param-name): Missing JSDoc `@param` name. | ||
╭─[require_param_name.tsx:3:17] | ||
2 │ /** | ||
3 │ * @param | ||
· ────── | ||
4 │ */ | ||
╰──── | ||
help: Add name to `@param` tag. | ||
|
||
⚠ eslint-plugin-jsdoc(require-param-name): Missing JSDoc `@param` name. | ||
╭─[require_param_name.tsx:3:17] | ||
2 │ /** | ||
3 │ * @param {string} | ||
· ────── | ||
4 │ */ | ||
╰──── | ||
help: Add name to `@param` tag. |