[Linter] Unnecessary while loop #16876
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
db48e48 to
725865f
Compare
|
@tx-tomcat is attempting to deploy a commit to the Mysten Labs Team on Vercel. A member of the Team first needs to authorize it. |
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
725865f to
7767cd3
Compare
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
7767cd3 to
24aec0d
Compare
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
24aec0d to
0c69463
Compare
tnowacki
requested changes
Aug 12, 2024
Comment on lines
61
to
69
| fn is_condition_always_true(condition: &UnannotatedExp_) -> bool { | ||
| if let UnannotatedExp_::Value(val) = condition { | ||
| if let Value_::Bool(b) = &val.value { | ||
| return *b; | ||
| } | ||
| } | ||
| false | ||
| } | ||
| fn report_while_true_to_loop(env: &mut CompilationEnv, loc: Loc) { |
There was a problem hiding this comment.
breaking things up into functions like this is typically not preferred when they called exactly once
There was a problem hiding this comment.
refactored.Only is_condition_always_true remain
external-crates/move/crates/move-compiler/src/linters/unnecessary_while_loop.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/src/linters/unnecessary_while_loop.rs
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,54 @@ | |||
| module 0x42::loop_test { | |||
There was a problem hiding this comment.
Please split this file as previously discussed
external-crates/move/crates/move-compiler/tests/linter/incorrect_unnecessary_while_loop.exp
Outdated
Show resolved
Hide resolved
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
0c69463 to
e583142
Compare
tx-tomcat
force-pushed
the
custom_rules/unnecessary_while_loop
branch
from
e583142 to
c6308a6
Compare
tnowacki
approved these changes
Aug 14, 2024
suiwombat
pushed a commit
that referenced
this pull request
Sep 16, 2024
# Description This linter encourages replacing `while(true)` loops with the more idiomatic loop construct. Here's a breakdown of how it works: It checks each expression in the AST. If the expression is a While loop, it examines the condition. If the condition is always true (using the `is_condition_always_true` function), it reports a diagnostic suggesting to use loop instead. The `is_condition_always_true` function checks if the condition is a boolean literal with the value true. ## Test plan Added more use case including false positive, false negative case ## Release notes - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [X] CLI: Move will now lint against `while (true)`, which should be replaced by `loop` - [ ] Rust SDK: --------- Co-authored-by: jamedzung <[email protected]> Co-authored-by: Todd Nowacki <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This linter encourages replacing
while(true)loops with the more idiomatic loop construct. Here's a breakdown of how it works:It checks each expression in the AST.
If the expression is a While loop, it examines the condition.
If the condition is always true (using the
is_condition_always_truefunction), it reports a diagnostic suggesting to use loop instead.The
is_condition_always_truefunction checks if the condition is a boolean literal with the value true.Test plan
Added more use case including false positive, false negative case
Release notes
while (true), which should be replaced byloop