Skip to content

refactor(linter): improve unicorn/error-message #9560

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
graphite-app merged 1 commit into from
Mar 5, 2025
Merged

refactor(linter): improve unicorn/error-message #9560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 24 additions & 30 deletions crates/oxc_linter/src/rules/unicorn/error_message.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,15 @@ pub struct ErrorMessage;
declare_oxc_lint!(
/// ### What it does
///
/// This rule enforces a `message` value to be passed in when creating an instance of a built-in `Error` object, which leads to more readable and debuggable code.
/// Enforces providing a `message` when creating built-in `Error` objects to
/// improve readability and debugging.
///
/// ### Why is this bad?
///
/// Throwing an `Error` without a message, like `throw new Error()`, provides no context
/// on what went wrong, making debugging harder. A clear error message improves
/// code clarity and helps developers quickly identify issues.
///
/// ### Examples
///
/// Examples of **incorrect** code for this rule:
Expand Down Expand Up @@ -71,48 +76,37 @@ impl Rule for ErrorMessage {
return;
}

let constructor_name = &callee.name;
let message_argument_idx = usize::from(constructor_name.as_str() == "AggregateError");

// If message is `SpreadElement` or there is `SpreadElement` before message
if args
.iter()
.enumerate()
.any(|(i, arg)| i <= message_argument_idx && matches!(arg, Argument::SpreadElement(_)))
{
// If there is `SpreadElement` before message
if matches!(args.first(), Some(Argument::SpreadElement(_))) {
return;
}

let constructor_name = &callee.name;
let message_argument_idx = usize::from(callee.name == "AggregateError");
let message_argument = args.get(message_argument_idx);

let Some(arg) = message_argument else {
return ctx.diagnostic(missing_message(constructor_name.as_str(), span));
return ctx.diagnostic(missing_message(constructor_name, span));
};

match arg {
Argument::StringLiteral(lit) => {
if lit.value.is_empty() {
ctx.diagnostic(empty_message(lit.span));
}
}
Argument::TemplateLiteral(template_lit) => {
if template_lit.span.source_text(ctx.source_text()).len() == 2 {
ctx.diagnostic(empty_message(template_lit.span));
}
}
Argument::ObjectExpression(object_expr) => {
ctx.diagnostic(not_string(object_expr.span));
let diagnostic = match arg {
Argument::ArrayExpression(array_expr) => not_string(array_expr.span),
Argument::ObjectExpression(object_expr) => not_string(object_expr.span),
Argument::StringLiteral(lit) if lit.value.is_empty() => empty_message(lit.span),
Argument::TemplateLiteral(template_lit)
if template_lit.span.source_text(ctx.source_text()).len() == 2 =>
{
empty_message(template_lit.span)
}
Argument::ArrayExpression(array_expr) => {
ctx.diagnostic(not_string(array_expr.span));
}
_ => {}
}
_ => return,
};

ctx.diagnostic(diagnostic);
}
}

// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Error_types
const BUILT_IN_ERRORS: &[&str] = &[
const BUILT_IN_ERRORS: [&str; 9] = [
"Error",
"EvalError",
"RangeError",
Expand Down
Loading