-
-
Notifications
You must be signed in to change notification settings - Fork 496
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(linter/eslint): Implement no-multi-str (#4038)
Rule Detail: [link](https://eslint.org/docs/latest/rules/no-multi-str) --------- Co-authored-by: wenzhe <mysteryven@gmail.com>
- Loading branch information
1 parent
7fe2a2f
commit aa45604
Showing
3 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
use oxc_ast::AstKind; | ||
use oxc_diagnostics::OxcDiagnostic; | ||
use oxc_macros::declare_oxc_lint; | ||
use oxc_span::Span; | ||
|
||
use crate::{context::LintContext, rule::Rule, AstNode}; | ||
|
||
fn no_multi_str_diagnostic(span0: Span) -> OxcDiagnostic { | ||
OxcDiagnostic::warn("eslint(no-multi-str): Unexpected multi string.").with_label(span0) | ||
} | ||
|
||
#[derive(Debug, Default, Clone)] | ||
pub struct NoMultiStr; | ||
|
||
declare_oxc_lint!( | ||
/// ### What it does | ||
/// | ||
/// Disallow multiline strings. | ||
/// | ||
/// ### Why is this bad? | ||
/// | ||
/// Some consider this to be a bad practice as it was an undocumented feature of JavaScript | ||
/// that was only formalized later. | ||
/// | ||
/// ### Example | ||
/// ```javascript | ||
/// var x = "Line 1 \ | ||
/// Line 2"; | ||
/// ``` | ||
NoMultiStr, | ||
style, | ||
); | ||
|
||
impl Rule for NoMultiStr { | ||
fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { | ||
if let AstKind::StringLiteral(literal) = node.kind() { | ||
let source = literal.span.source_text(ctx.source_text()); | ||
// https://github.com/eslint/eslint/blob/9e6d6405c3ee774c2e716a3453ede9696ced1be7/lib/shared/ast-utils.js#L12 | ||
let position = | ||
source.find(|ch| matches!(ch, '\r' | '\n' | '\u{2028}' | '\u{2029}')).unwrap_or(0); | ||
if position != 0 { | ||
// We found the "newline" character but want to highlight the '\', so go back one | ||
// character. | ||
let multi_span_start = | ||
literal.span.start + u32::try_from(position).unwrap_or_default() - 1; | ||
ctx.diagnostic(no_multi_str_diagnostic(Span::new( | ||
multi_span_start, | ||
multi_span_start + 1, | ||
))); | ||
} | ||
} | ||
} | ||
} | ||
|
||
#[test] | ||
fn test() { | ||
use crate::tester::Tester; | ||
|
||
let pass = vec![ | ||
"var a = 'Line 1 Line 2';", | ||
"var a = <div> | ||
<h1>Wat</h1> | ||
</div>;", // { "ecmaVersion": 6, "parserOptions": { "ecmaFeatures": { "jsx": true } } } | ||
]; | ||
|
||
let fail = vec![ | ||
"var x = 'Line 1 \\ | ||
Line 2'", | ||
"test('Line 1 \\ | ||
Line 2');", | ||
"'foo\\\rbar';", | ||
"'foo\\ bar';", | ||
"'foo\\ ar';", | ||
"'\\ still fails';", | ||
]; | ||
|
||
Tester::new(NoMultiStr::NAME, pass, fail).test_and_snapshot(); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters