[Linter] Constant naming #16819
[Linter] Constant naming #16819
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
4 Ignored Deployments
|
external-crates/move/crates/move-compiler/src/linters/constant_naming.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/src/linters/constant_naming.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/src/linters/constant_naming.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/src/linters/constant_naming.rs
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/tests/custom_rules/constant_naming.move
Outdated
Show resolved
Hide resolved
external-crates/move/crates/move-compiler/src/linters/constant_naming.rs
Outdated
Show resolved
Hide resolved
|
I have resolved all of these comment above |
| LinterDiagCategory::ConstantNaming as u8, | ||
| LINTER_DEFAULT_DIAG_CODE, |
There was a problem hiding this comment.
Let's build up some categories here. So we should decide on the category for linting and then make the code one specific to constant naming
| Severity::Warning, | ||
| LinterDiagCategory::ConstantNaming as u8, | ||
| LINTER_DEFAULT_DIAG_CODE, | ||
| "Constant name should be in all caps, snake case, pascal case or upper camel case.", |
There was a problem hiding this comment.
| "Constant name should be in all caps, snake case, pascal case or upper camel case.", | |
| "non-conventional constant name", |
The message on the error code should be relatively short
There was a problem hiding this comment.
"constant should follow naming convention" ?
There was a problem hiding this comment.
I like that a lot more, thanks!
| .iter() | ||
| .for_each(|(loc, name, _constant)| { | ||
| if !is_valid_name(name.as_str()) { | ||
| let uid_msg = format!("'{}' should be named using UPPER_CASE_WITH_UNDERSCORES or PascalCase/UpperCamelCase",name.as_str()); |
There was a problem hiding this comment.
Formatting looks off here. We probably need to split the line
| let uid_msg = format!("'{}' should be named using UPPER_CASE_WITH_UNDERSCORES or PascalCase/UpperCamelCase",name.as_str()); | |
| let uid_msg = format!( | |
| "'{name}' should be named using UPPER_CASE_WITH_UNDERSCORES \ | |
| or PascalCase/UpperCamelCase", | |
| ); |
| } | ||
|
|
||
| impl TypingVisitorContext for Context<'_> { | ||
| fn visit(&mut self, program: &mut T::Program_) { |
There was a problem hiding this comment.
This should be overriding visit_constant_custom
| @@ -83,6 +85,7 @@ pub enum LinterDiagCategory { | |||
| FreezeWrapped, | |||
| CollectionEquality, | |||
| PublicRandom, | |||
| ConstantNaming, | |||
There was a problem hiding this comment.
We should have a separate category/code system for the linters outside of the sui_mode linters
| const MIN_THRESHOLD: u64 = 10; | ||
| const MIN_U64: u64 = 10; | ||
|
|
||
| // // Incorrectly named constants |
There was a problem hiding this comment.
This says incorrectly named, but they shouldn't trigger a warning? I find that a bit confusing
| // Correctly named constants | ||
| const MAX_LIMIT: u64 = 1000; | ||
| const MIN_THRESHOLD: u64 = 10; | ||
| const MIN_U64: u64 = 10; |
There was a problem hiding this comment.
Could we split this into two separate test files. One with all the valid cases and another with all of the invalid ones?
| @@ -0,0 +1,20 @@ | |||
| module 0x42::M { | |||
There was a problem hiding this comment.
Could make the file something like external-crates/move/crates/move-compiler/tests/linter/constant_naming.move
The change here is changing the dir custom_rules to linter
| public_random::PublicRandomVisitor.visitor(), | ||
| ] | ||
| } | ||
| LintLevel::Default | LintLevel::All => vec
| fn is_valid_name(name: &str) -> bool { | ||
| if name | ||
| .chars() | ||
| .all(|c| c.is_uppercase() || c == '_' || c.is_numeric()) | ||
| { | ||
| return true; | ||
| } | ||
| // Check for PascalCase/UpperCamelCase | ||
| // The string must start with an uppercase letter, and only contain alphanumeric characters, | ||
| // with every new word starting with an uppercase letter. | ||
| let mut chars = name.chars(); | ||
| chars.next().unwrap().is_uppercase() && chars.all(|c| c.is_alphanumeric()) | ||
| } |
There was a problem hiding this comment.
Nit: you can do this in a single pass over the string:
fn is_valid_name(name: &str) -> bool {
let mut chars = name.chars();
let Some(start) = chars.next() else { return false /* ice? */ };
if !start.is_uppercase() { return false }
let mut all_uppers = true;
let mut has_underscore = false;
while let Some(char) = chars.next() {
if char.is_lowercase() {
all_uppers = false;
} else if char == '_' {
has_underscore = true;
} else if !char.is_alphanumeric() {
return false; // bail if it's not alphanumeric ?
}
// We have an underscore but we have non-uppercase letters
if has_underscore && !all_uppers {
return false;
}
}
true
}
There was a problem hiding this comment.
I would prefer if we kept this in the slightly slower implementation that is easier to understand.
|
This needs a test for the |
| .iter() | ||
| .for_each(|(loc, name, _constant)| { | ||
| if !is_valid_name(name.as_str()) { | ||
| let uid_msg = format!("'{}' should be named using UPPER_CASE_WITH_UNDERSCORES or PascalCase/UpperCamelCase",name.as_str()); |
There was a problem hiding this comment.
But we might want to switch this to the following for brevity (and maybe clarity)
format!("'{name}' should be ALL_CAPS. Or for error constants, use PascalCase")
There was a problem hiding this comment.
99% the way there!
Just a few small things:
- A few small nits (see comments)
- I believe the changes to
sui_mode/liters/mod.rscan be reverted - Let's make sure we have a test for the warning suppression, both on the module and constant
- I've kicked off CI and it looks like there are some errors
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| //! `ConstantNamingVisitor` enforces a naming convention for constants in Move programs, | ||
| //! requiring them to follow an ALL_CAPS_SNAKE_CASE format. This lint checks each constant's name |
There was a problem hiding this comment.
| //! requiring them to follow an ALL_CAPS_SNAKE_CASE format. This lint checks each constant's name | |
| //! requiring them to follow an ALL_CAPS_SNAKE_CASE or PascalCase format. This lint checks each constant's name |
| pub const CONSTANT_NAMING_DIAG_CODE: u8 = 2; | ||
| pub const LINTER_DEFAULT_DIAG_CODE: u8 = 1; |
There was a problem hiding this comment.
| pub const CONSTANT_NAMING_DIAG_CODE: u8 = 2; | |
| pub const LINTER_DEFAULT_DIAG_CODE: u8 = 1; | |
| pub const CONSTANT_NAMING_DIAG_CODE: u8 = 1; |
| @@ -73,6 +73,8 @@ pub const RANDOM_MOD_NAME: &str = "random"; | |||
| pub const RANDOM_STRUCT_NAME: &str = "Random"; | |||
There was a problem hiding this comment.
I think we can revert all changes to this file?
| const Maxcount: u64 = 500; // Should not trigger a warning | ||
| const MinValue: u64 = 1; // Should not trigger a warning | ||
|
|
||
| } |
| const JSON_Max_Size: u64 = 1048576; | ||
| const VALUE_MAX: u64 = 200; | ||
| const numItems: u64 = 30; | ||
| } |
There was a problem hiding this comment.
nit, missing trailing newline
There was a problem hiding this comment.
Just one more round should do it :)
The things to fix:
- Tests should test one thing, so remove the unrelated things from incorrect_constant_naming.move
- Let's generalize
suppressed_incorrect_constant_naming.movefor all future lints - We should not emit lints for things that already errors. In this case, that means no lint for constants where the name is invalid. (this should also include restricted names like Self)
| // Should not trigger a warning | ||
| #[allow(lint(constant_naming))] | ||
| const numItems: u64 = 30; |
There was a problem hiding this comment.
| // Should not trigger a warning | |
| #[allow(lint(constant_naming))] | |
| const numItems: u64 = 30; |
Let's remove this. Tests should test one thing, with the suppression, it is testing two: the errors and the suppression of the errors
| @@ -0,0 +1,15 @@ | |||
| #[allow(lint(constant_naming))] | |||
There was a problem hiding this comment.
Nice!
Since there is going to be a lot of these lints coming, let's have one test that has all of the future lint allows in them.
So something like
move-compiler/tests/linter/suppressed_lints.move
And we can cut this test down to one case per lint, so
module 0x42::M {
const Another_BadName: u64 = 42; // Should trigger a warning
}
There was a problem hiding this comment.
Thanks! Let's remove this file as it is now superseded by the other ones
| module 0x42::M { | ||
| // Incorrectly named constants | ||
| const Another_BadName: u64 = 42; // Should trigger a warning | ||
| const YetAnotherName: u64 = 777; // Should not trigger a warning |
There was a problem hiding this comment.
Similarly, remove any valid names from this test
| const minimumValue: u64 = 10; | ||
| const some_important_number: u64 = 55; |
There was a problem hiding this comment.
I should have caught this a lot earlier, sorry.
These constants have invalid names. There is no need to lint against constants where the name is an error.
|
|
||
| #[allow(lint(constant_naming))] | ||
| const Another_BadName: u64 = 42; // Should trigger a warning | ||
| } |
| @@ -0,0 +1,15 @@ | |||
| #[allow(lint(constant_naming))] | |||
There was a problem hiding this comment.
Thanks! Let's remove this file as it is now superseded by the other ones
| CONSTANT_NAMING_DIAG_CODE, | ||
| Some(CONSTANT_NAMING_FILTER_NAME), | ||
| )], | ||
| ) | ||
| } | ||
|
|
||
| pub fn linter_visitors(level: LintLevel) -> Vec<Visitor> { | ||
| match level { | ||
| LintLevel::None => vec![], | ||
| LintLevel::Default | LintLevel::All => { |
There was a problem hiding this comment.
We only want this on for All
| LintLevel::Default | LintLevel::All => { | |
| LintLevel::Default => vec![], | |
| LintLevel::All => { |
## Description - Fixing an issue exposed in #16819. Since Sui lints use the `lint` prefix for suppression, we need to make sure all category/code combos are distinct. - Added new lint categories, with a specific one for Sui lints ## Test plan - Updated tests --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK:
| @@ -0,0 +1,109 @@ | |||
| //! Detect potential overflow scenarios where the number of bits being shifted exceeds the bit width of | |||
There was a problem hiding this comment.
Looks like linter+tests was accidentally brought into this PR last commit. Let's remove it so we can focus on it in its own PR
|
@dzungdinh94 is attempting to deploy a commit to the Mysten Labs Team on Vercel. A member of the Team first needs to authorize it. |
| datatest_stable::harness!(move_check_testsuite, "tests/", r".*\.move$"); | ||
| datatest_stable::harness!(move_check_testsuite, "tests/linter", r".*\.move$"); |
There was a problem hiding this comment.
Are you having trouble running your tests? It should already be picked up via the LINTER_DIR check
There was a problem hiding this comment.
i accidently changes this files. restored
Description
Constant Naming enforces a naming convention for constants in Move programs, requiring them to follow an ALL_CAPS_SNAKE_CASE or PascalCase/UpperCamelCase format. This lint checks each constant's name within a module against this convention.
Run the linter
cargo test move_check_testsuit
Testing
File testing: constant_naming.move