2021-03-25 18:29:11 +00:00
|
|
|
use clippy_utils::diagnostics::span_lint_and_help;
|
|
|
|
use clippy_utils::is_direct_expn_of;
|
2020-02-09 00:44:35 +00:00
|
|
|
use if_chain::if_chain;
|
2022-09-08 00:52:51 +00:00
|
|
|
use rustc_ast::ast::{Expr, ExprKind, MethodCall};
|
2020-02-09 00:44:35 +00:00
|
|
|
use rustc_lint::{EarlyContext, EarlyLintPass};
|
|
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
2021-04-08 15:50:13 +00:00
|
|
|
use rustc_span::sym;
|
2020-02-09 00:44:35 +00:00
|
|
|
|
|
|
|
declare_clippy_lint! {
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for usage of `option_env!(...).unwrap()` and
|
2020-02-09 00:44:35 +00:00
|
|
|
/// suggests usage of the `env!` macro.
|
|
|
|
///
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### Why is this bad?
|
|
|
|
/// Unwrapping the result of `option_env!` will panic
|
2020-02-09 00:44:35 +00:00
|
|
|
/// at run-time if the environment variable doesn't exist, whereas `env!`
|
|
|
|
/// catches it at compile-time.
|
|
|
|
///
|
2021-07-29 10:16:06 +00:00
|
|
|
/// ### Example
|
2020-02-09 00:44:35 +00:00
|
|
|
/// ```rust,no_run
|
|
|
|
/// let _ = option_env!("HOME").unwrap();
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// Is better expressed as:
|
|
|
|
///
|
|
|
|
/// ```rust,no_run
|
|
|
|
/// let _ = env!("HOME");
|
|
|
|
/// ```
|
2021-12-06 11:33:31 +00:00
|
|
|
#[clippy::version = "1.43.0"]
|
2020-02-09 00:44:35 +00:00
|
|
|
pub OPTION_ENV_UNWRAP,
|
|
|
|
correctness,
|
|
|
|
"using `option_env!(...).unwrap()` to get environment variable"
|
|
|
|
}
|
|
|
|
|
|
|
|
declare_lint_pass!(OptionEnvUnwrap => [OPTION_ENV_UNWRAP]);
|
|
|
|
|
|
|
|
impl EarlyLintPass for OptionEnvUnwrap {
|
|
|
|
fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
|
|
|
|
if_chain! {
|
2022-09-08 00:52:51 +00:00
|
|
|
if let ExprKind::MethodCall(box MethodCall { seg, receiver, .. }) = &expr.kind;
|
|
|
|
if matches!(seg.ident.name, sym::expect | sym::unwrap);
|
2022-08-07 13:21:11 +00:00
|
|
|
if let ExprKind::Call(caller, _) = &receiver.kind;
|
2020-02-09 00:44:35 +00:00
|
|
|
if is_direct_expn_of(caller.span, "option_env").is_some();
|
|
|
|
then {
|
|
|
|
span_lint_and_help(
|
|
|
|
cx,
|
|
|
|
OPTION_ENV_UNWRAP,
|
|
|
|
expr.span,
|
2020-02-09 16:54:23 +00:00
|
|
|
"this will panic at run-time if the environment variable doesn't exist at compile-time",
|
2020-04-18 10:28:29 +00:00
|
|
|
None,
|
2020-02-09 00:44:35 +00:00
|
|
|
"consider using the `env!` macro instead"
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|