-
-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(linter/eslint-plugin-promise): implement spec-only
Rule Detail: [link](https://github.com/eslint-community/eslint-plugin-promise/blob/main/docs/rules/spec-only.md)
- Loading branch information
Showing
3 changed files
with
162 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
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,124 @@ | ||
use oxc_ast::AstKind; | ||
use oxc_diagnostics::OxcDiagnostic; | ||
use oxc_macros::declare_oxc_lint; | ||
use oxc_span::GetSpan; | ||
use rustc_hash::FxHashSet; | ||
|
||
use crate::{context::LintContext, rule::Rule, utils::PROMISE_STATIC_METHODS, AstNode}; | ||
|
||
#[derive(Debug, Default, Clone)] | ||
pub struct SpecOnly { | ||
allowed_methods: Option<FxHashSet<String>>, | ||
} | ||
|
||
declare_oxc_lint!( | ||
/// ### What it does | ||
/// | ||
/// Disallow use of non-standard Promise static methods. | ||
/// | ||
/// ### Why is this bad? | ||
/// | ||
/// Non-standard Promises may cost more maintenance work. | ||
/// | ||
/// ### Examples | ||
/// | ||
/// Examples of **incorrect** code for this rule: | ||
/// ```js | ||
/// Promise.done() | ||
/// ``` | ||
/// | ||
/// Examples of **correct** code for this rule: | ||
/// ```js | ||
/// Promise.resolve() | ||
/// ``` | ||
SpecOnly, | ||
restriction, | ||
); | ||
|
||
impl Rule for SpecOnly { | ||
fn from_configuration(value: serde_json::Value) -> Self { | ||
let allowed_methods = value | ||
.get(0) | ||
.and_then(|v| v.get("allowedMethods")) | ||
.and_then(serde_json::Value::as_array) | ||
.map(|v| { | ||
v.iter().filter_map(serde_json::Value::as_str).map(ToString::to_string).collect() | ||
}); | ||
|
||
Self { allowed_methods } | ||
} | ||
|
||
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { | ||
let AstKind::MemberExpression(member_expr) = node.kind() else { | ||
return; | ||
}; | ||
|
||
if !member_expr.object().is_specific_id("Promise") { | ||
return; | ||
} | ||
|
||
let Some(prop_name) = member_expr.static_property_name() else { | ||
return; | ||
}; | ||
|
||
if PROMISE_STATIC_METHODS.contains(prop_name) { | ||
return; | ||
} | ||
|
||
if let Some(allowed_methods) = &self.allowed_methods { | ||
if allowed_methods.contains(prop_name) { | ||
return; | ||
} | ||
} | ||
|
||
ctx.diagnostic( | ||
OxcDiagnostic::warn(format!("Avoid using non-standard `Promise.{prop_name}`")) | ||
.with_label(member_expr.span()), | ||
); | ||
} | ||
} | ||
|
||
#[test] | ||
fn test() { | ||
use crate::tester::Tester; | ||
|
||
let pass = vec![ | ||
("Promise.resolve()", None), | ||
("Promise.reject()", None), | ||
("Promise.all()", None), | ||
("Promise.race()", None), | ||
("Promise.withResolvers()", None), | ||
("new Promise(function (resolve, reject) {})", None), | ||
("SomeClass.resolve()", None), | ||
("doSomething(Promise.all)", None), | ||
( | ||
"Promise.permittedMethod()", | ||
Some(serde_json::json!([ { "allowedMethods": ["permittedMethod"], }, ])), | ||
), | ||
]; | ||
|
||
let fail = vec![ | ||
("Promise.done()", None), | ||
("Promise.something()", None), | ||
("new Promise.done()", None), | ||
( | ||
" | ||
function foo() { | ||
var a = getA() | ||
return Promise.done(a) | ||
} | ||
", | ||
None, | ||
), | ||
( | ||
" | ||
function foo() { | ||
getA(Promise.done) | ||
} | ||
", | ||
None, | ||
), | ||
]; | ||
|
||
Tester::new(SpecOnly::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,36 @@ | ||
--- | ||
source: crates/oxc_linter/src/tester.rs | ||
--- | ||
⚠ eslint-plugin-promise(spec-only): Avoid using non-standard `Promise.done` | ||
╭─[spec_only.tsx:1:1] | ||
1 │ Promise.done() | ||
· ──────────── | ||
╰──── | ||
|
||
⚠ eslint-plugin-promise(spec-only): Avoid using non-standard `Promise.something` | ||
╭─[spec_only.tsx:1:1] | ||
1 │ Promise.something() | ||
· ───────────────── | ||
╰──── | ||
|
||
⚠ eslint-plugin-promise(spec-only): Avoid using non-standard `Promise.done` | ||
╭─[spec_only.tsx:1:5] | ||
1 │ new Promise.done() | ||
· ──────────── | ||
╰──── | ||
|
||
⚠ eslint-plugin-promise(spec-only): Avoid using non-standard `Promise.done` | ||
╭─[spec_only.tsx:4:22] | ||
3 │ var a = getA() | ||
4 │ return Promise.done(a) | ||
· ──────────── | ||
5 │ } | ||
╰──── | ||
|
||
⚠ eslint-plugin-promise(spec-only): Avoid using non-standard `Promise.done` | ||
╭─[spec_only.tsx:3:20] | ||
2 │ function foo() { | ||
3 │ getA(Promise.done) | ||
· ──────────── | ||
4 │ } | ||
╰──── |