Skip to content

lint: Allow signal names that start with _ to be considered as snake_case #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NathanLovato merged 2 commits into from
Sep 15, 2026
+9 −9
Merged

lint: Allow signal names that start with _ to be considered as snake_case #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88df310
lint: Allow signal names that start with `_` to be considered as snak…
fstxz Sep 14, 2026
03a0677
Add test case for signal with pseudo-private signal with multiple lea…
NathanLovato Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/linter/regex_patterns.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ macro_rules! static_regex {
}

static_regex!(SNAKE_CASE, r"^[a-z][a-z0-9_]*$");
static_regex!(PRIVATE_SNAKE_CASE, r"^_[a-z][a-z0-9_]*$");
static_regex!(PRIVATE_SNAKE_CASE, r"^_+[a-z][a-z0-9_]*$");
static_regex!(PASCAL_CASE, r"^[A-Z][a-zA-Z0-9]*$");
static_regex!(CONSTANT_CASE, r"^[A-Z][A-Z0-9_]*$");
static_regex!(PRIVATE_CONSTANT_CASE, r"^_[A-Z][A-Z0-9_]*$");
static_regex!(PRIVATE_CONSTANT_CASE, r"^_+[A-Z][A-Z0-9_]*$");
4 changes: 2 additions & 2 deletions src/linter/rules/signal_name.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use crate::linter::lib::{get_line_column, get_node_text};
use crate::linter::regex_patterns::SNAKE_CASE;
use crate::linter::regex_patterns::{PRIVATE_SNAKE_CASE, SNAKE_CASE};
use crate::linter::rules::Rule;
use crate::linter::{LintIssue, LintSeverity};
use crate::node_kind::GDScriptNodeKind;
Expand All @@ -8,7 +8,7 @@ pub struct SignalNameRule;

impl SignalNameRule {
fn is_valid_signal_name(name: &str) -> bool {
SNAKE_CASE.is_match(name)
SNAKE_CASE.is_match(name) || PRIVATE_SNAKE_CASE.is_match(name)
}
}

Expand Down
5 changes: 2 additions & 3 deletions tests/lint/expected/signal_name.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
tests/lint/input/signal_name.gd:9:signal-name:error: Signal name 'BadSignal' should be in snake_case format
tests/lint/input/signal_name.gd:10:signal-name:error: Signal name '_bad_signal' should be in snake_case format
tests/lint/input/signal_name.gd:11:signal-name:error: Signal name 'badSignal' should be in snake_case format
tests/lint/input/signal_name.gd:11:signal-name:error: Signal name 'BadSignal' should be in snake_case format
tests/lint/input/signal_name.gd:12:signal-name:error: Signal name 'badSignal' should be in snake_case format
5 changes: 3 additions & 2 deletions tests/lint/input/signal_name.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
#region Good

signal good_signal(var1: int, var2: String)
signal public_signal(var1: int, var2: String)
signal _pseudo_private(var1: int, var2: String)
signal __also_valid_pseudo_private(var1: int, var2: String)

#endregion

#region Bad

signal BadSignal(var1: int, var2: String)
signal _bad_signal(var1: int, var2: String)
signal badSignal(var1: int, var2: String)

#endregion