mirror of
https://github.com/danbulant/oxc
synced 2026-05-19 04:08:41 +00:00
feat(linter): eslint-plugin-jest/prefer-lowercase-title (#2911)
part of https://github.com/oxc-project/oxc/issues/492 Rule Detail: [link](https://github.com/jest-community/eslint-plugin-jest/blob/main/src/rules/prefer-lowercase-title.ts)
This commit is contained in:
cinchen
GitHub
parent
b4b471f4cf
commit
6757dbab8a
3 changed files with 914 additions and 0 deletions
|
|
@ -171,6 +171,7 @@ mod jest {
|
|||
pub mod prefer_comparison_matcher;
|
||||
pub mod prefer_equality_matcher;
|
||||
pub mod prefer_expect_resolves;
|
||||
pub mod prefer_lowercase_title;
|
||||
pub mod prefer_mock_promise_shorthand;
|
||||
pub mod prefer_spy_on;
|
||||
pub mod prefer_strict_equal;
|
||||
|
|
@ -502,6 +503,7 @@ oxc_macros::declare_all_lint_rules! {
|
|||
jest::prefer_comparison_matcher,
|
||||
jest::prefer_equality_matcher,
|
||||
jest::prefer_expect_resolves,
|
||||
jest::prefer_lowercase_title,
|
||||
jest::prefer_mock_promise_shorthand,
|
||||
jest::prefer_spy_on,
|
||||
jest::prefer_strict_equal,
|
||||
|
|
|
|||
668
crates/oxc_linter/src/rules/jest/prefer_lowercase_title.rs
Normal file
668
crates/oxc_linter/src/rules/jest/prefer_lowercase_title.rs
Normal file
|
|
@ -0,0 +1,668 @@
|
|||
use oxc_ast::{
|
||||
ast::{Argument, Expression},
|
||||
AstKind,
|
||||
};
|
||||
use oxc_diagnostics::{
|
||||
miette::{self, Diagnostic},
|
||||
thiserror::Error,
|
||||
};
|
||||
use oxc_macros::declare_oxc_lint;
|
||||
use oxc_span::{CompactStr, Span};
|
||||
|
||||
use crate::{
|
||||
context::LintContext,
|
||||
fixer::Fix,
|
||||
rule::Rule,
|
||||
utils::{
|
||||
collect_possible_jest_call_node, parse_jest_fn_call, JestFnKind, JestGeneralFnKind,
|
||||
ParsedJestFnCallNew, PossibleJestNode,
|
||||
},
|
||||
};
|
||||
|
||||
#[derive(Debug, Error, Diagnostic)]
|
||||
#[error("eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names")]
|
||||
#[diagnostic(severity(warning), help("`{0:?}`s should begin with lowercase"))]
|
||||
struct UnexpectedLowercase(CompactStr, #[label] Span);
|
||||
|
||||
#[derive(Debug, Default, Clone)]
|
||||
pub struct PreferLowercaseTitleConfig {
|
||||
allowed_prefixes: Vec<String>,
|
||||
ignore: Vec<String>,
|
||||
ignore_top_level_describe: bool,
|
||||
}
|
||||
|
||||
impl std::ops::Deref for PreferLowercaseTitle {
|
||||
type Target = PreferLowercaseTitleConfig;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
&self.0
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone)]
|
||||
pub struct PreferLowercaseTitle(Box<PreferLowercaseTitleConfig>);
|
||||
|
||||
declare_oxc_lint!(
|
||||
/// ### What it does
|
||||
///
|
||||
/// Enforce `it`, `test` and `describe` to have descriptions that begin with a
|
||||
/// lowercase letter. This provides more readable test failures. This rule is not
|
||||
/// enabled by default.
|
||||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```javascript
|
||||
/// // invalid
|
||||
/// it('Adds 1 + 2 to equal 3', () => {
|
||||
/// expect(sum(1, 2)).toBe(3);
|
||||
/// });
|
||||
///
|
||||
/// // valid
|
||||
/// it('adds 1 + 2 to equal 3', () => {
|
||||
/// expect(sum(1, 2)).toBe(3);
|
||||
/// });
|
||||
/// ```
|
||||
///
|
||||
/// ## Options
|
||||
/// ```json
|
||||
/// {
|
||||
/// "jest/prefer-lowercase-title": [
|
||||
/// "error",
|
||||
/// {
|
||||
/// "ignore": ["describe", "test"]
|
||||
/// }
|
||||
/// ]
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// ### `ignore`
|
||||
///
|
||||
/// This array option controls which Jest functions are checked by this rule. There
|
||||
/// are three possible values:
|
||||
/// - `"describe"`
|
||||
/// - `"test"`
|
||||
/// - `"it"`
|
||||
///
|
||||
/// By default, none of these options are enabled (the equivalent of
|
||||
/// `{ "ignore": [] }`).
|
||||
///
|
||||
/// Example of **correct** code for the `{ "ignore": ["describe"] }` option:
|
||||
/// ```js
|
||||
/// /* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] */
|
||||
/// describe('Uppercase description');
|
||||
/// ```
|
||||
///
|
||||
/// Example of **correct** code for the `{ "ignore": ["test"] }` option:
|
||||
///
|
||||
/// ```js
|
||||
/// /* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] */
|
||||
/// test('Uppercase description');
|
||||
/// ```
|
||||
///
|
||||
/// Example of **correct** code for the `{ "ignore": ["it"] }` option:
|
||||
/// ```js
|
||||
/// /* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] */
|
||||
/// it('Uppercase description');
|
||||
/// ```
|
||||
///
|
||||
/// ### `allowedPrefixes`
|
||||
/// This array option allows specifying prefixes, which contain capitals that titles
|
||||
/// can start with. This can be useful when writing tests for API endpoints, where
|
||||
/// you'd like to prefix with the HTTP method.
|
||||
/// By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).
|
||||
///
|
||||
/// Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:
|
||||
/// ```js
|
||||
/// /* eslint jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] */
|
||||
/// describe('GET /live');
|
||||
/// ```
|
||||
///
|
||||
/// ### `ignoreTopLevelDescribe`
|
||||
/// This option can be set to allow only the top-level `describe` blocks to have a
|
||||
/// title starting with an upper-case letter.
|
||||
/// Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:
|
||||
///
|
||||
/// ```js
|
||||
/// /* eslint jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] */
|
||||
/// describe('MyClass', () => {
|
||||
/// describe('#myMethod', () => {
|
||||
/// it('does things', () => {
|
||||
/// //
|
||||
/// });
|
||||
/// });
|
||||
/// });
|
||||
/// ```
|
||||
///
|
||||
PreferLowercaseTitle,
|
||||
style,
|
||||
);
|
||||
|
||||
impl Rule for PreferLowercaseTitle {
|
||||
fn from_configuration(value: serde_json::Value) -> Self {
|
||||
let obj = value.get(0);
|
||||
let ignore_top_level_describe = obj
|
||||
.and_then(|config| config.get("ignoreTopLevelDescribe"))
|
||||
.and_then(serde_json::Value::as_bool)
|
||||
.unwrap_or(false);
|
||||
let ignore = obj
|
||||
.and_then(|config| config.get("ignore"))
|
||||
.and_then(serde_json::Value::as_array)
|
||||
.map(|v| {
|
||||
v.iter().filter_map(serde_json::Value::as_str).map(ToString::to_string).collect()
|
||||
})
|
||||
.unwrap_or_default();
|
||||
let allowed_prefixes = obj
|
||||
.and_then(|config| config.get("allowedPrefixes"))
|
||||
.and_then(serde_json::Value::as_array)
|
||||
.map(|v| {
|
||||
v.iter().filter_map(serde_json::Value::as_str).map(ToString::to_string).collect()
|
||||
})
|
||||
.unwrap_or_default();
|
||||
|
||||
Self(Box::new(PreferLowercaseTitleConfig {
|
||||
allowed_prefixes,
|
||||
ignore,
|
||||
ignore_top_level_describe,
|
||||
}))
|
||||
}
|
||||
|
||||
fn run_once(&self, ctx: &LintContext) {
|
||||
for possible_jest_node in &collect_possible_jest_call_node(ctx) {
|
||||
self.run(possible_jest_node, ctx);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl PreferLowercaseTitle {
|
||||
fn run<'a>(&self, possible_jest_node: &PossibleJestNode<'a, '_>, ctx: &LintContext<'a>) {
|
||||
let scopes = ctx.scopes();
|
||||
let node = possible_jest_node.node;
|
||||
let ignores = Self::populate_ignores(&self.ignore);
|
||||
let AstKind::CallExpression(call_expr) = node.kind() else {
|
||||
return;
|
||||
};
|
||||
let Some(ParsedJestFnCallNew::GeneralJestFnCall(jest_fn_call)) =
|
||||
parse_jest_fn_call(call_expr, possible_jest_node, ctx)
|
||||
else {
|
||||
return;
|
||||
};
|
||||
|
||||
if ignores.contains(&jest_fn_call.name.as_ref()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if matches!(jest_fn_call.kind, JestFnKind::General(JestGeneralFnKind::Describe)) {
|
||||
if self.ignore_top_level_describe && scopes.get_flags(node.scope_id()).is_top() {
|
||||
return;
|
||||
}
|
||||
} else if !matches!(jest_fn_call.kind, JestFnKind::General(JestGeneralFnKind::Test)) {
|
||||
return;
|
||||
}
|
||||
|
||||
let Some(Argument::Expression(expr)) = call_expr.arguments.first() else {
|
||||
return;
|
||||
};
|
||||
|
||||
if let Expression::StringLiteral(string_expr) = expr {
|
||||
if string_expr.value.is_empty()
|
||||
|| self.allowed_prefixes.iter().any(|name| string_expr.value.starts_with(name))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
let Some(first_char) = string_expr.value.chars().next() else {
|
||||
return;
|
||||
};
|
||||
|
||||
if first_char == first_char.to_ascii_lowercase() {
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.diagnostic_with_fix(
|
||||
UnexpectedLowercase(string_expr.value.to_compact_str(), string_expr.span),
|
||||
|| {
|
||||
let mut content = ctx.codegen();
|
||||
content.print_str(first_char.to_ascii_lowercase().to_string().as_bytes());
|
||||
Fix::new(
|
||||
content.into_source_text(),
|
||||
Span::new(string_expr.span.start + 1, string_expr.span.start + 2),
|
||||
)
|
||||
},
|
||||
);
|
||||
} else if let Expression::TemplateLiteral(template_expr) = expr {
|
||||
let Some(template_string) = template_expr.quasi() else {
|
||||
return;
|
||||
};
|
||||
|
||||
if template_string.is_empty()
|
||||
|| self.allowed_prefixes.iter().any(|name| template_string.starts_with(name))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
let Some(first_char) = template_string.chars().next() else {
|
||||
return;
|
||||
};
|
||||
|
||||
if first_char == first_char.to_ascii_lowercase() {
|
||||
return;
|
||||
}
|
||||
|
||||
ctx.diagnostic_with_fix(
|
||||
UnexpectedLowercase(template_string.to_compact_str(), template_expr.span),
|
||||
|| {
|
||||
let mut content = ctx.codegen();
|
||||
content.print_str(first_char.to_ascii_lowercase().to_string().as_bytes());
|
||||
Fix::new(
|
||||
content.into_source_text(),
|
||||
Span::new(template_expr.span.start + 1, template_expr.span.start + 2),
|
||||
)
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
fn populate_ignores(ignore: &[String]) -> Vec<&str> {
|
||||
let mut ignores: Vec<&str> = vec![];
|
||||
let test_case_name = ["fit", "it", "xit", "test", "xtest"];
|
||||
let describe_alias = ["describe", "fdescribe", "xdescribe"];
|
||||
let test_name = "test";
|
||||
let it_name = "it";
|
||||
|
||||
if ignore.iter().any(|alias| alias == "describe") {
|
||||
ignores.extend(describe_alias.iter());
|
||||
}
|
||||
|
||||
if ignore.iter().any(|alias| alias == test_name) {
|
||||
ignores.extend(test_case_name.iter().filter(|alias| alias.ends_with(test_name)));
|
||||
}
|
||||
|
||||
if ignore.iter().any(|alias| alias == it_name) {
|
||||
ignores.extend(test_case_name.iter().filter(|alias| alias.ends_with(it_name)));
|
||||
}
|
||||
|
||||
ignores
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test() {
|
||||
use crate::tester::Tester;
|
||||
|
||||
let pass = vec![
|
||||
("it.each()", None),
|
||||
("it.each()(1)", None),
|
||||
("randomFunction()", None),
|
||||
("foo.bar()", None),
|
||||
("it()", None),
|
||||
("it(' ', function () {})", None),
|
||||
("it(true, function () {})", None),
|
||||
("it(MY_CONSTANT, function () {})", None),
|
||||
("it(\" \", function () {})", None),
|
||||
("it(` `, function () {})", None),
|
||||
("it('foo', function () {})", None),
|
||||
("it(\"foo\", function () {})", None),
|
||||
("it(`foo`, function () {})", None),
|
||||
("it(\"<Foo/>\", function () {})", None),
|
||||
("it(\"123 foo\", function () {})", None),
|
||||
("it(42, function () {})", None),
|
||||
("it(``)", None),
|
||||
("it(\"\")", None),
|
||||
("it(42)", None),
|
||||
("test()", None),
|
||||
("test('foo', function () {})", None),
|
||||
("test(\"foo\", function () {})", None),
|
||||
("test(`foo`, function () {})", None),
|
||||
("test(\"<Foo/>\", function () {})", None),
|
||||
("test(\"123 foo\", function () {})", None),
|
||||
("test(\"42\", function () {})", None),
|
||||
("test(``)", None),
|
||||
("test(\"\")", None),
|
||||
("test(42)", None),
|
||||
("describe()", None),
|
||||
("describe('foo', function () {})", None),
|
||||
("describe(\"foo\", function () {})", None),
|
||||
("describe(`foo`, function () {})", None),
|
||||
("describe(\"<Foo/>\", function () {})", None),
|
||||
("describe(\"123 foo\", function () {})", None),
|
||||
("describe(\"42\", function () {})", None),
|
||||
("describe(function () {})", None),
|
||||
("describe(``)", None),
|
||||
("describe(\"\")", None),
|
||||
(
|
||||
"
|
||||
describe.each()(1);
|
||||
describe.each()(2);
|
||||
",
|
||||
None,
|
||||
),
|
||||
("jest.doMock(\"my-module\")", None),
|
||||
(
|
||||
"
|
||||
import { jest } from '@jest/globals';
|
||||
jest.doMock('my-module');
|
||||
",
|
||||
None,
|
||||
),
|
||||
("describe(42)", None),
|
||||
(
|
||||
"describe(42)",
|
||||
Some(serde_json::json!([{ "ignore": "undefined", "allowedPrefixes": "undefined" }])),
|
||||
),
|
||||
// ignore = describe
|
||||
("describe('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["describe"] }]))),
|
||||
(
|
||||
"describe(\"Foo\", function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["describe"] }])),
|
||||
),
|
||||
("describe(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["describe"] }]))),
|
||||
("fdescribe(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["describe"] }]))),
|
||||
(
|
||||
"describe.skip(`Foo`, function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["describe"] }])),
|
||||
),
|
||||
// ignore=test
|
||||
("test('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("test(\"Foo\", function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("test(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("xtest(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("test.only(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
// ignore=it
|
||||
("it('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("it(\"Foo\", function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("it(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("fit(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("it.skip(`Foo`, function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
// allowedPrefixes
|
||||
(
|
||||
"it('GET /live', function () {})",
|
||||
Some(serde_json::json!([{ "allowedPrefixes": ["GET"] }])),
|
||||
),
|
||||
(
|
||||
"it(\"POST /live\", function () {})",
|
||||
Some(serde_json::json!([{ "allowedPrefixes": ["GET", "POST"] }])),
|
||||
),
|
||||
(
|
||||
"it(`PATCH /live`, function () {})",
|
||||
Some(serde_json::json!([{ "allowedPrefixes": ["GET", "PATCH"] }])),
|
||||
),
|
||||
// ignoreTopLevelDescribe
|
||||
(
|
||||
"describe(\"MyClass\", () => {});",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('#myMethod', () => {
|
||||
it('does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('Strings', () => {
|
||||
it('are strings', () => {
|
||||
expect('abc').toBe('abc');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Booleans', () => {
|
||||
it('are booleans', () => {
|
||||
expect(true).toBe(true);
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
];
|
||||
|
||||
let fail = vec![
|
||||
("it('Foo', function () {})", None),
|
||||
("xit('Foo', function () {})", None),
|
||||
("it(\"Foo\", function () {})", None),
|
||||
("it(`Foo`, function () {})", None),
|
||||
("test('Foo', function () {})", None),
|
||||
("xtest('Foo', function () {})", None),
|
||||
("test(\"Foo\", function () {})", None),
|
||||
("test(`Foo`, function () {})", None),
|
||||
("describe('Foo', function () {})", None),
|
||||
("describe(\"Foo\", function () {})", None),
|
||||
("describe(`Foo`, function () {})", None),
|
||||
(
|
||||
"
|
||||
import { describe as context } from '@jest/globals';
|
||||
context(`Foo`, () => {});
|
||||
",
|
||||
None,
|
||||
),
|
||||
("describe(`Some longer description`, function () {})", None),
|
||||
("fdescribe(`Some longer description`, function () {})", None),
|
||||
("it.each(['green', 'black'])('Should return %', () => {})", None),
|
||||
("describe.each(['green', 'black'])('Should return %', () => {})", None),
|
||||
// ignore describe
|
||||
("test('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["describe"] }]))),
|
||||
("xit('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["describe"] }]))),
|
||||
// ignore test
|
||||
("describe('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("it('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
("xit('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["test"] }]))),
|
||||
// ignore it
|
||||
("describe('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("test('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
("xtest('Foo', function () {})", Some(serde_json::json!([{ "ignore": ["it"] }]))),
|
||||
// allowedPrefixes
|
||||
|
||||
// ignoreTopLevelDescribe
|
||||
(
|
||||
"it(\"Works!\", () => {});",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
import { describe, describe as context } from '@jest/globals';
|
||||
describe('MyClass', () => {
|
||||
context('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": false }])),
|
||||
),
|
||||
];
|
||||
|
||||
let fix = vec![
|
||||
("it('Foo', function () {})", "it('foo', function () {})", None),
|
||||
("xit('Foo', function () {})", "xit('foo', function () {})", None),
|
||||
("it(\"Foo\", function () {})", "it(\"foo\", function () {})", None),
|
||||
("it(`Foo`, function () {})", "it(`foo`, function () {})", None),
|
||||
("test('Foo', function () {})", "test('foo', function () {})", None),
|
||||
("xtest('Foo', function () {})", "xtest('foo', function () {})", None),
|
||||
("test(\"Foo\", function () {})", "test(\"foo\", function () {})", None),
|
||||
("test(`Foo`, function () {})", "test(`foo`, function () {})", None),
|
||||
("describe('Foo', function () {})", "describe('foo', function () {})", None),
|
||||
("describe(\"Foo\", function () {})", "describe(\"foo\", function () {})", None),
|
||||
("describe(`Foo`, function () {})", "describe(`foo`, function () {})", None),
|
||||
(
|
||||
"
|
||||
import { describe as context } from '@jest/globals';
|
||||
context(`Foo`, () => {});
|
||||
",
|
||||
"
|
||||
import { describe as context } from '@jest/globals';
|
||||
context(`foo`, () => {});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"describe(`Some longer description`, function () {})",
|
||||
"describe(`some longer description`, function () {})",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"fdescribe(`Some longer description`, function () {})",
|
||||
"fdescribe(`some longer description`, function () {})",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"it.each(['green', 'black'])('Should return %', () => {})",
|
||||
"it.each(['green', 'black'])('should return %', () => {})",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"describe.each(['green', 'black'])('Should return %', () => {})",
|
||||
"describe.each(['green', 'black'])('should return %', () => {})",
|
||||
None,
|
||||
),
|
||||
// ignore describe
|
||||
(
|
||||
"test('Foo', function () {})",
|
||||
"test('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["describe"] }])),
|
||||
),
|
||||
(
|
||||
"xit('Foo', function () {})",
|
||||
"xit('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["describe"] }])),
|
||||
),
|
||||
// ignore test
|
||||
(
|
||||
"describe('Foo', function () {})",
|
||||
"describe('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["test"] }])),
|
||||
),
|
||||
(
|
||||
"it('Foo', function () {})",
|
||||
"it('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["test"] }])),
|
||||
),
|
||||
(
|
||||
"xit('Foo', function () {})",
|
||||
"xit('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["test"] }])),
|
||||
),
|
||||
// ignore it
|
||||
(
|
||||
"describe('Foo', function () {})",
|
||||
"describe('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["it"] }])),
|
||||
),
|
||||
(
|
||||
"test('Foo', function () {})",
|
||||
"test('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["it"] }])),
|
||||
),
|
||||
(
|
||||
"xtest('Foo', function () {})",
|
||||
"xtest('foo', function () {})",
|
||||
Some(serde_json::json!([{ "ignore": ["it"] }])),
|
||||
),
|
||||
// allowedPrefixes empty
|
||||
// ignoreTopLevelDescribe
|
||||
(
|
||||
"it(\"Works!\", () => {});",
|
||||
"it(\"works!\", () => {});",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('myMethod', () => {
|
||||
it('does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
import { describe, describe as context } from '@jest/globals';
|
||||
describe('MyClass', () => {
|
||||
context('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
"
|
||||
import { describe, describe as context } from '@jest/globals';
|
||||
describe('MyClass', () => {
|
||||
context('myMethod', () => {
|
||||
it('does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": true }])),
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('MyClass', () => {
|
||||
describe('MyMethod', () => {
|
||||
it('Does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
"
|
||||
describe('myClass', () => {
|
||||
describe('myMethod', () => {
|
||||
it('does things', () => {
|
||||
//
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
Some(serde_json::json!([{ "ignoreTopLevelDescribe": false }])),
|
||||
),
|
||||
];
|
||||
|
||||
Tester::new(PreferLowercaseTitle::NAME, pass, fail)
|
||||
.with_jest_plugin(true)
|
||||
.expect_fix(fix)
|
||||
.test_and_snapshot();
|
||||
}
|
||||
244
crates/oxc_linter/src/snapshots/prefer_lowercase_title.snap
Normal file
244
crates/oxc_linter/src/snapshots/prefer_lowercase_title.snap
Normal file
|
|
@ -0,0 +1,244 @@
|
|||
---
|
||||
source: crates/oxc_linter/src/tester.rs
|
||||
assertion_line: 151
|
||||
expression: prefer_lowercase_title
|
||||
---
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:4]
|
||||
1 │ it('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:5]
|
||||
1 │ xit('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:4]
|
||||
1 │ it("Foo", function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:4]
|
||||
1 │ it(`Foo`, function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:6]
|
||||
1 │ test('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:7]
|
||||
1 │ xtest('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:6]
|
||||
1 │ test("Foo", function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:6]
|
||||
1 │ test(`Foo`, function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe("Foo", function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe(`Foo`, function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:3:25]
|
||||
2 │ import { describe as context } from '@jest/globals';
|
||||
3 │ context(`Foo`, () => {});
|
||||
· ─────
|
||||
4 │
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe(`Some longer description`, function () {})
|
||||
· ─────────────────────────
|
||||
╰────
|
||||
help: `"Some longer description"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:11]
|
||||
1 │ fdescribe(`Some longer description`, function () {})
|
||||
· ─────────────────────────
|
||||
╰────
|
||||
help: `"Some longer description"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:29]
|
||||
1 │ it.each(['green', 'black'])('Should return %', () => {})
|
||||
· ─────────────────
|
||||
╰────
|
||||
help: `"Should return %"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:35]
|
||||
1 │ describe.each(['green', 'black'])('Should return %', () => {})
|
||||
· ─────────────────
|
||||
╰────
|
||||
help: `"Should return %"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:6]
|
||||
1 │ test('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:5]
|
||||
1 │ xit('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:4]
|
||||
1 │ it('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:5]
|
||||
1 │ xit('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:10]
|
||||
1 │ describe('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:6]
|
||||
1 │ test('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:7]
|
||||
1 │ xtest('Foo', function () {})
|
||||
· ─────
|
||||
╰────
|
||||
help: `"Foo"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:1:4]
|
||||
1 │ it("Works!", () => {});
|
||||
· ────────
|
||||
╰────
|
||||
help: `"Works!"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:4:28]
|
||||
3 │ describe('MyMethod', () => {
|
||||
4 │ it('Does things', () => {
|
||||
· ─────────────
|
||||
5 │ //
|
||||
╰────
|
||||
help: `"Does things"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:3:30]
|
||||
2 │ describe('MyClass', () => {
|
||||
3 │ describe('MyMethod', () => {
|
||||
· ──────────
|
||||
4 │ it('Does things', () => {
|
||||
╰────
|
||||
help: `"MyMethod"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:4:29]
|
||||
3 │ describe('MyClass', () => {
|
||||
4 │ context('MyMethod', () => {
|
||||
· ──────────
|
||||
5 │ it('Does things', () => {
|
||||
╰────
|
||||
help: `"MyMethod"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:5:28]
|
||||
4 │ context('MyMethod', () => {
|
||||
5 │ it('Does things', () => {
|
||||
· ─────────────
|
||||
6 │ //
|
||||
╰────
|
||||
help: `"Does things"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:4:28]
|
||||
3 │ describe('MyMethod', () => {
|
||||
4 │ it('Does things', () => {
|
||||
· ─────────────
|
||||
5 │ //
|
||||
╰────
|
||||
help: `"Does things"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:3:30]
|
||||
2 │ describe('MyClass', () => {
|
||||
3 │ describe('MyMethod', () => {
|
||||
· ──────────
|
||||
4 │ it('Does things', () => {
|
||||
╰────
|
||||
help: `"MyMethod"`s should begin with lowercase
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-lowercase-title): Enforce lowercase test names
|
||||
╭─[prefer_lowercase_title.tsx:2:26]
|
||||
1 │
|
||||
2 │ describe('MyClass', () => {
|
||||
· ─────────
|
||||
3 │ describe('MyMethod', () => {
|
||||
╰────
|
||||
help: `"MyClass"`s should begin with lowercase
|
||||
Loading…
Reference in a new issue