0f5338cd90
The `restriction` group contains many lints which are not about necessarily “bad” things, but style choices — perhaps even style choices which contradict conventional Rust style — or are otherwise very situational. This results in silly wording like “Why is this bad? It isn't, but ...”, which I’ve seen confuse a newcomer at least once. To improve this situation, this commit replaces the “Why is this bad?” section heading with “Why restrict this?”, for most, but not all, restriction lints. I left alone the ones whose placement in the restriction group is more incidental. In order to make this make sense, I had to remove the “It isn't, but” texts from the contents of the sections. Sometimes further changes were needed, or there were obvious fixes to make, and I went ahead and made those changes without attempting to split them into another commit, even though many of them are not strictly necessary for the “Why restrict this?” project.
86 lines
2.7 KiB
Rust
86 lines
2.7 KiB
Rust
use clippy_utils::diagnostics::span_lint_and_note;
|
|
use clippy_utils::is_lint_allowed;
|
|
use clippy_utils::macros::root_macro_call_first_node;
|
|
use rustc_ast::LitKind;
|
|
use rustc_hir::{Expr, ExprKind};
|
|
use rustc_lint::{LateContext, LateLintPass};
|
|
use rustc_session::impl_lint_pass;
|
|
use rustc_span::sym;
|
|
|
|
declare_clippy_lint! {
|
|
/// ### What it does
|
|
/// Checks for the inclusion of large files via `include_bytes!()`
|
|
/// or `include_str!()`.
|
|
///
|
|
/// ### Why restrict this?
|
|
/// Including large files can undesirably increase the size of the binary produced by the compiler.
|
|
/// This lint may be used to catch mistakes where an unexpectedly large file is included, or
|
|
/// temporarily to obtain a list of all large files.
|
|
///
|
|
/// ### Example
|
|
/// ```rust,ignore
|
|
/// let included_str = include_str!("very_large_file.txt");
|
|
/// let included_bytes = include_bytes!("very_large_file.txt");
|
|
/// ```
|
|
///
|
|
/// Use instead:
|
|
/// ```rust,ignore
|
|
/// use std::fs;
|
|
///
|
|
/// // You can load the file at runtime
|
|
/// let string = fs::read_to_string("very_large_file.txt")?;
|
|
/// let bytes = fs::read("very_large_file.txt")?;
|
|
/// ```
|
|
#[clippy::version = "1.62.0"]
|
|
pub LARGE_INCLUDE_FILE,
|
|
restriction,
|
|
"including a large file"
|
|
}
|
|
|
|
pub struct LargeIncludeFile {
|
|
max_file_size: u64,
|
|
}
|
|
|
|
impl LargeIncludeFile {
|
|
#[must_use]
|
|
pub fn new(max_file_size: u64) -> Self {
|
|
Self { max_file_size }
|
|
}
|
|
}
|
|
|
|
impl_lint_pass!(LargeIncludeFile => [LARGE_INCLUDE_FILE]);
|
|
|
|
impl LateLintPass<'_> for LargeIncludeFile {
|
|
fn check_expr(&mut self, cx: &LateContext<'_>, expr: &'_ Expr<'_>) {
|
|
if let Some(macro_call) = root_macro_call_first_node(cx, expr)
|
|
&& !is_lint_allowed(cx, LARGE_INCLUDE_FILE, expr.hir_id)
|
|
&& (cx.tcx.is_diagnostic_item(sym::include_bytes_macro, macro_call.def_id)
|
|
|| cx.tcx.is_diagnostic_item(sym::include_str_macro, macro_call.def_id))
|
|
&& let ExprKind::Lit(lit) = &expr.kind
|
|
{
|
|
let len = match &lit.node {
|
|
// include_bytes
|
|
LitKind::ByteStr(bstr, _) => bstr.len(),
|
|
// include_str
|
|
LitKind::Str(sym, _) => sym.as_str().len(),
|
|
_ => return,
|
|
};
|
|
|
|
if len as u64 <= self.max_file_size {
|
|
return;
|
|
}
|
|
|
|
span_lint_and_note(
|
|
cx,
|
|
LARGE_INCLUDE_FILE,
|
|
expr.span.source_callsite(),
|
|
"attempted to include a large file",
|
|
None,
|
|
format!(
|
|
"the configuration allows a maximum size of {} bytes",
|
|
self.max_file_size
|
|
),
|
|
);
|
|
}
|
|
}
|
|
}
|