summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/clippy_lints/src/option_env_unwrap.rs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/tools/clippy/clippy_lints/src/option_env_unwrap.rs56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/tools/clippy/clippy_lints/src/option_env_unwrap.rs b/src/tools/clippy/clippy_lints/src/option_env_unwrap.rs
new file mode 100644
index 000000000..3f5286ba0
--- /dev/null
+++ b/src/tools/clippy/clippy_lints/src/option_env_unwrap.rs
@@ -0,0 +1,56 @@
+use clippy_utils::diagnostics::span_lint_and_help;
+use clippy_utils::is_direct_expn_of;
+use if_chain::if_chain;
+use rustc_ast::ast::{Expr, ExprKind};
+use rustc_lint::{EarlyContext, EarlyLintPass};
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+use rustc_span::sym;
+
+declare_clippy_lint! {
+ /// ### What it does
+ /// Checks for usage of `option_env!(...).unwrap()` and
+ /// suggests usage of the `env!` macro.
+ ///
+ /// ### Why is this bad?
+ /// Unwrapping the result of `option_env!` will panic
+ /// at run-time if the environment variable doesn't exist, whereas `env!`
+ /// catches it at compile-time.
+ ///
+ /// ### Example
+ /// ```rust,no_run
+ /// let _ = option_env!("HOME").unwrap();
+ /// ```
+ ///
+ /// Is better expressed as:
+ ///
+ /// ```rust,no_run
+ /// let _ = env!("HOME");
+ /// ```
+ #[clippy::version = "1.43.0"]
+ 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! {
+ if let ExprKind::MethodCall(path_segment, args, _) = &expr.kind;
+ if matches!(path_segment.ident.name, sym::expect | sym::unwrap);
+ if let ExprKind::Call(caller, _) = &args[0].kind;
+ if is_direct_expn_of(caller.span, "option_env").is_some();
+ then {
+ span_lint_and_help(
+ cx,
+ OPTION_ENV_UNWRAP,
+ expr.span,
+ "this will panic at run-time if the environment variable doesn't exist at compile-time",
+ None,
+ "consider using the `env!` macro instead"
+ );
+ }
+ }
+ }
+}