language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-08-03 17:58:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 21

feat: lint ignored statements before break/continue/return (#1637)

Browse source 
* feat: impl it

* g

* g2

* feat: add tests

* fix: snapshot
This commit is contained in:
Myriad-Dreamin 2025-04-09 18:17:46 +08:00 • committed by GitHub
parent 6cf7739fb6
commit 23f10a2648
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
73 changed files with 1170 additions and 171 deletions
Download patch file Download diff file Expand all files Collapse all files

2
crates/tinymist-query/src/analysis.rs
View file

@ -671,7 +671,7 @@ mod lint_tests {
let source = ctx.source_by_path(&path).unwrap();
let expr = ctx.expr_stage(&source);
let result = tinymist_lint::lint_source(&expr);
let result = tinymist_lint::lint_file(&expr);
let result = crate::diagnostics::DiagWorker::new(ctx).convert_all(result.iter());
let result = result
.into_iter()

2
crates/tinymist-query/src/diagnostics.rs
View file

@ -247,5 +247,5 @@ impl DiagnosticRefiner for OutOfRootHintRefiner {
#[comemo::memoize]
fn lint_file(source: &ExprInfo) -> EcoVec<SourceDiagnostic> {
tinymist_lint::lint_source(source)
tinymist_lint::lint_file(source)
}

3
crates/tinymist-query/src/fixtures/lint/break_for.typ Normal file
View file

@ -0,0 +1,3 @@
#for value in (1, 2, 3) {
break
}

3
crates/tinymist-query/src/fixtures/lint/break_func_for.typ Normal file
View file

@ -0,0 +1,3 @@
#for value in (1, 2, 3) {
let _ = () => break
}

1
crates/tinymist-query/src/fixtures/lint/break_top.typ Normal file
View file

@ -0,0 +1 @@
#break

3
crates/tinymist-query/src/fixtures/lint/break_while.typ Normal file
View file

@ -0,0 +1,3 @@
#while true {
break
}

1
crates/tinymist-query/src/fixtures/lint/continue_top.typ Normal file
View file

@ -0,0 +1 @@
#continue

4
crates/tinymist-query/src/fixtures/lint/discard_array.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = [
#(1, 2)
#return 1;
]

9
crates/tinymist-query/src/fixtures/lint/discard_common.typ Normal file
View file

@ -0,0 +1,9 @@
#let f() = {
[0]
if true {
[1]
} else {
[2]
}
return [];
}

7
crates/tinymist-query/src/fixtures/lint/discard_common_break.typ Normal file
View file

@ -0,0 +1,7 @@
#let f() = {
while true {
[0]
break
}
return [];
}

7
crates/tinymist-query/src/fixtures/lint/discard_common_break2.typ Normal file
View file

@ -0,0 +1,7 @@
#let f() = {
while true {
[0]
break
return [];
}
}

4
crates/tinymist-query/src/fixtures/lint/discard_equation.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = [
$ 1 2 3 $
#return 1;
]

4
crates/tinymist-query/src/fixtures/lint/discard_for.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = for i in range(10) {
show: it => it
return [];
}

4
crates/tinymist-query/src/fixtures/lint/discard_for2.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = for i in range(10) {
show: it => it
return ;
}

3
crates/tinymist-query/src/fixtures/lint/discard_for3.typ Normal file
View file

@ -0,0 +1,3 @@
#let f() = for i in range(10) {
show: it => it
}

4
crates/tinymist-query/src/fixtures/lint/discard_for4.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = for i in range(10) {
show: it => it
break
}

4
crates/tinymist-query/src/fixtures/lint/discard_for5.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = for i in range(10) {
show: it => it
continue
}

4
crates/tinymist-query/src/fixtures/lint/discard_hello.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = [
Hello -- Test -- World
#return 1;
]

6
crates/tinymist-query/src/fixtures/lint/discard_if.typ Normal file
View file

@ -0,0 +1,6 @@
#let f() = if true {
set text(red)
return;
} else {
return [];
}

7
crates/tinymist-query/src/fixtures/lint/discard_if2.typ Normal file
View file

@ -0,0 +1,7 @@
#let f() = if true {
set text(red)
return;
} else {
set text(blue)
return [];
}

8
crates/tinymist-query/src/fixtures/lint/discard_join.typ Normal file
View file

@ -0,0 +1,8 @@
#let f() = {
if true {
[1]
} else {
[2]
}
return [];
}

9
crates/tinymist-query/src/fixtures/lint/discard_join_partial.typ Normal file
View file

@ -0,0 +1,9 @@
#let f() = {
if true {
[1]
} else {
[2]
return;
}
return [];
}

9
crates/tinymist-query/src/fixtures/lint/discard_join_partial2.typ Normal file
View file

@ -0,0 +1,9 @@
#let f() = {
if true {
[1]
return;
} else {
[2]
}
return [];
}

4
crates/tinymist-query/src/fixtures/lint/discard_set.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = {
set text(red)
return 1;
}

4
crates/tinymist-query/src/fixtures/lint/discard_show.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = {
show: it => it
return 1;
}

4
crates/tinymist-query/src/fixtures/lint/discard_show_content.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = [
#show: it => it
#return 1;
]

1
crates/tinymist-query/src/fixtures/lint/if_set.typ
View file

@ -1,4 +1,3 @@
#if false {
set text(red)
}

1
crates/tinymist-query/src/fixtures/lint/if_show.typ
View file

@ -1,4 +1,3 @@
#if false {
show: text(red)
}

1
crates/tinymist-query/src/fixtures/lint/return_contextual.typ Normal file
View file

@ -0,0 +1 @@
#context return

3
crates/tinymist-query/src/fixtures/lint/return_loop.typ Normal file
View file

@ -0,0 +1,3 @@
#while true {
return
}

3
crates/tinymist-query/src/fixtures/lint/return_loop2.typ Normal file
View file

@ -0,0 +1,3 @@
#let f() = while true {
return
}

1
crates/tinymist-query/src/fixtures/lint/return_regular.typ Normal file
View file

@ -0,0 +1 @@
#let f() = return

1
crates/tinymist-query/src/fixtures/lint/return_top.typ Normal file
View file

@ -0,0 +1 @@
#return

4
crates/tinymist-query/src/fixtures/lint/show_good.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = {
show: it => it
[Test]
}

4
crates/tinymist-query/src/fixtures/lint/show_good2.typ Normal file
View file

@ -0,0 +1,4 @@
#let f() = [
#show: it => it
Test
]

1
crates/tinymist-query/src/fixtures/lint/show_set.typ
View file

@ -1,4 +1,3 @@
#show: {
set text(red)
}

1
crates/tinymist-query/src/fixtures/lint/show_set2.typ
View file

@ -1,4 +1,3 @@
#show raw: {
set text(red)
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@break_for.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/break_for.typ
---
{}

23
crates/tinymist-query/src/fixtures/lint/snaps/test@break_func_for.typ.snap Normal file
View file

@ -0,0 +1,23 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/break_func_for.typ
---
{
"s0.typ": [
{
"message": "`break` statement in a non-loop context",
"range": "1:16:1:21",
"relatedInformation": [
{
"message": "error occurred while applying show rule to this loop"
},
{
"message": "error occurred in this function call"
}
],
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@break_top.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/break_top.typ
---
{
"s0.typ": [
{
"message": "`break` statement in a non-loop context",
"range": "0:1:0:6",
"severity": 2,
"source": "typst"
}
]
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@break_while.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/break_while.typ
---
{}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@continue_top.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/continue_top.typ
---
{
"s0.typ": [
{
"message": "`continue` statement in a non-loop context",
"range": "0:1:0:9",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_array.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_array.typ
---
{
"s0.typ": [
{
"message": "This array is implicitly discarded by function return\nHint: consider ignoring the value explicitly using underscore: `let _ = (1, 2)`",
"range": "1:3:1:9",
"severity": 2,
"source": "typst"
}
]
}

21
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_common.typ.snap Normal file
View file

@ -0,0 +1,21 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_common.typ
---
{
"s0.typ": [
{
"message": "This text is implicitly discarded by function return",
"range": "3:5:3:6",
"severity": 2,
"source": "typst"
},
{
"message": "This text is implicitly discarded by function return",
"range": "5:5:5:6",
"severity": 2,
"source": "typst"
}
]
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_common_break.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_common_break.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_common_break2.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_common_break2.typ
---
{}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_equation.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_equation.typ
---
{
"s0.typ": [
{
"message": "This equation is implicitly discarded by function return",
"range": "1:2:1:11",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_for.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_for.typ
---
{
"s0.typ": [
{
"message": "This `show` expression is implicitly discarded by function return",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_for2.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_for2.typ
---
{
"s0.typ": [
{
"message": "This `show` expression is implicitly discarded by function return",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_for3.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_for3.typ
---
{
"s0.typ": [
{
"message": "This show statement doesn't take effect.\nHint: consider changing parent to `show: range(10).fold(it => it, (style-it, i) => it => { show: it => it; style-it(it) })`",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_for4.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_for4.typ
---
{
"s0.typ": [
{
"message": "This show statement doesn't take effect.\nHint: consider changing parent to `show: range(10).fold(it => it, (style-it, i) => it => { show: it => it; style-it(it) })`",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_for5.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_for5.typ
---
{
"s0.typ": [
{
"message": "This show statement doesn't take effect.\nHint: consider changing parent to `show: range(10).fold(it => it, (style-it, i) => it => { show: it => it; style-it(it) })`",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_hello.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_hello.typ
---
{
"s0.typ": [
{
"message": "This text is implicitly discarded by function return",
"range": "1:19:1:24",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_if.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_if.typ
---
{
"s0.typ": [
{
"message": "This `set` expression is implicitly discarded by function return",
"range": "1:2:1:15",
"severity": 2,
"source": "typst"
}
]
}

21
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_if2.typ.snap Normal file
View file

@ -0,0 +1,21 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_if2.typ
---
{
"s0.typ": [
{
"message": "This `set` expression is implicitly discarded by function return",
"range": "1:2:1:15",
"severity": 2,
"source": "typst"
},
{
"message": "This `set` expression is implicitly discarded by function return",
"range": "4:2:4:16",
"severity": 2,
"source": "typst"
}
]
}

21
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_join.typ.snap Normal file
View file

@ -0,0 +1,21 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_join.typ
---
{
"s0.typ": [
{
"message": "This text is implicitly discarded by function return",
"range": "2:5:2:6",
"severity": 2,
"source": "typst"
},
{
"message": "This text is implicitly discarded by function return",
"range": "4:5:4:6",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_join_partial.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_join_partial.typ
---
{
"s0.typ": [
{
"message": "This text is implicitly discarded by function return",
"range": "2:5:2:6",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_join_partial2.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_join_partial2.typ
---
{
"s0.typ": [
{
"message": "This text is implicitly discarded by function return",
"range": "5:5:5:6",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_set.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_set.typ
---
{
"s0.typ": [
{
"message": "This `set` expression is implicitly discarded by function return",
"range": "1:2:1:15",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_show.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_show.typ
---
{
"s0.typ": [
{
"message": "This `show` expression is implicitly discarded by function return",
"range": "1:2:1:16",
"severity": 2,
"source": "typst"
}
]
}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@discard_show_content.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/discard_show_content.typ
---
{
"s0.typ": [
{
"message": "This `show` expression is implicitly discarded by function return",
"range": "1:3:1:17",
"severity": 2,
"source": "typst"
}
]
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@return_contextual.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/return_contextual.typ
---
{}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@return_loop.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/return_loop.typ
---
{
"s0.typ": [
{
"message": "`return` statement in a non-function context",
"range": "1:2:1:8",
"severity": 2,
"source": "typst"
}
]
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@return_loop2.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/return_loop2.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@return_regular.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/return_regular.typ
---
{}

15
crates/tinymist-query/src/fixtures/lint/snaps/test@return_top.typ.snap Normal file
View file

@ -0,0 +1,15 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/return_top.typ
---
{
"s0.typ": [
{
"message": "`return` statement in a non-function context",
"range": "0:1:0:7",
"severity": 2,
"source": "typst"
}
]
}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@show_good.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/show_good.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@show_good2.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/show_good2.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@while_good.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/while_good.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/snaps/test@while_good2.typ.snap Normal file
View file

@ -0,0 +1,6 @@
---
source: crates/tinymist-query/src/analysis.rs
expression: "JsonRepr::new_redacted(result, &REDACT_LOC)"
input_file: crates/tinymist-query/src/fixtures/lint/while_good2.typ
---
{}

6
crates/tinymist-query/src/fixtures/lint/while_good.typ Normal file
View file

@ -0,0 +1,6 @@
#let f() = {
while true {
[0]
break
}
}

5
crates/tinymist-query/src/fixtures/lint/while_good2.typ Normal file
View file

@ -0,0 +1,5 @@
#let f() = {
while false {
[0]
}
}