trigger string_lit_as_bytes when literal has escapes

This commit is contained in:
Andy Russell 2019-11-11 17:42:12 -05:00
parent cc35165f52
commit d33ad45d7d
No known key found for this signature in database
GPG Key ID: BE2221033EDBC374
4 changed files with 52 additions and 47 deletions

View File

@ -4,6 +4,8 @@ use rustc::{declare_lint_pass, declare_tool_lint};
use rustc_errors::Applicability; use rustc_errors::Applicability;
use syntax::source_map::Spanned; use syntax::source_map::Spanned;
use if_chain::if_chain;
use crate::utils::SpanlessEq; use crate::utils::SpanlessEq;
use crate::utils::{get_parent_expr, is_allowed, match_type, paths, span_lint, span_lint_and_sugg, walk_ptrs_ty}; use crate::utils::{get_parent_expr, is_allowed, match_type, paths, span_lint, span_lint_and_sugg, walk_ptrs_ty};
@ -146,53 +148,46 @@ declare_lint_pass!(StringLitAsBytes => [STRING_LIT_AS_BYTES]);
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for StringLitAsBytes { impl<'a, 'tcx> LateLintPass<'a, 'tcx> for StringLitAsBytes {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) { fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
use crate::utils::{snippet, snippet_with_applicability}; use crate::utils::{snippet, snippet_with_applicability};
use syntax::ast::{LitKind, StrStyle}; use syntax::ast::LitKind;
if let ExprKind::MethodCall(ref path, _, ref args) = e.kind { if_chain! {
if path.ident.name == sym!(as_bytes) { if let ExprKind::MethodCall(path, _, args) = &e.kind;
if let ExprKind::Lit(ref lit) = args[0].kind { if path.ident.name == sym!(as_bytes);
if let LitKind::Str(ref lit_content, style) = lit.node { if let ExprKind::Lit(lit) = &args[0].kind;
let callsite = snippet(cx, args[0].span.source_callsite(), r#""foo""#); if let LitKind::Str(lit_content, _) = &lit.node;
let expanded = if let StrStyle::Raw(n) = style { then {
let term = "#".repeat(usize::from(n)); let callsite = snippet(cx, args[0].span.source_callsite(), r#""foo""#);
format!("r{0}\"{1}\"{0}", term, lit_content.as_str()) let mut applicability = Applicability::MachineApplicable;
} else { if callsite.starts_with("include_str!") {
format!("\"{}\"", lit_content.as_str()) span_lint_and_sugg(
}; cx,
let mut applicability = Applicability::MachineApplicable; STRING_LIT_AS_BYTES,
if callsite.starts_with("include_str!") { e.span,
span_lint_and_sugg( "calling `as_bytes()` on `include_str!(..)`",
cx, "consider using `include_bytes!(..)` instead",
STRING_LIT_AS_BYTES, snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability).replacen(
e.span, "include_str",
"calling `as_bytes()` on `include_str!(..)`", "include_bytes",
"consider using `include_bytes!(..)` instead", 1,
snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability).replacen( ),
"include_str", applicability,
"include_bytes", );
1, } else if lit_content.as_str().is_ascii()
), && lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT
applicability, && !args[0].span.from_expansion()
); {
} else if callsite == expanded span_lint_and_sugg(
&& lit_content.as_str().chars().all(|c| c.is_ascii()) cx,
&& lit_content.as_str().len() <= MAX_LENGTH_BYTE_STRING_LIT STRING_LIT_AS_BYTES,
&& !args[0].span.from_expansion() e.span,
{ "calling `as_bytes()` on a string literal",
span_lint_and_sugg( "consider using a byte string literal instead",
cx, format!(
STRING_LIT_AS_BYTES, "b{}",
e.span, snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability)
"calling `as_bytes()` on a string literal", ),
"consider using a byte string literal instead", applicability,
format!( );
"b{}",
snippet_with_applicability(cx, args[0].span, r#""foo""#, &mut applicability)
),
applicability,
);
}
}
} }
} }
} }

View File

@ -15,6 +15,8 @@ fn str_lit_as_bytes() {
let strify = stringify!(foobar).as_bytes(); let strify = stringify!(foobar).as_bytes();
let includestr = include_bytes!("entry_unfixable.rs"); let includestr = include_bytes!("entry_unfixable.rs");
let _ = b"string with newline\t\n";
} }
fn main() {} fn main() {}

View File

@ -15,6 +15,8 @@ fn str_lit_as_bytes() {
let strify = stringify!(foobar).as_bytes(); let strify = stringify!(foobar).as_bytes();
let includestr = include_str!("entry_unfixable.rs").as_bytes(); let includestr = include_str!("entry_unfixable.rs").as_bytes();
let _ = "string with newline\t\n".as_bytes();
} }
fn main() {} fn main() {}

View File

@ -18,5 +18,11 @@ error: calling `as_bytes()` on `include_str!(..)`
LL | let includestr = include_str!("entry_unfixable.rs").as_bytes(); LL | let includestr = include_str!("entry_unfixable.rs").as_bytes();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using `include_bytes!(..)` instead: `include_bytes!("entry_unfixable.rs")` | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using `include_bytes!(..)` instead: `include_bytes!("entry_unfixable.rs")`
error: aborting due to 3 previous errors error: calling `as_bytes()` on a string literal
--> $DIR/string_lit_as_bytes.rs:19:13
|
LL | let _ = "string with newline/t/n".as_bytes();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using a byte string literal instead: `b"string with newline/t/n"`
error: aborting due to 4 previous errors