Skip to content

CFE-4667: Improve error message from cfbs about illegal characters in module names #317

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
olehermanse merged 1 commit into from
Jun 12, 2026
+11 −3
Merged

CFE-4667: Improve error message from cfbs about illegal characters in module names #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 11 additions & 3 deletions cfbs/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,18 +274,26 @@ def validate_module_name_content(name):
"Module name proper is empty",
)

# build a suggested fix for the module name:
suggested_proper_name = re.sub(r"[^a-z0-9]+", "-", proper_name.lower()).strip("-")
if suggested_proper_name and re.fullmatch(r, suggested_proper_name):
suggestion = " Consider renaming it to '{}'.".format(suggested_proper_name)
else:
suggestion = ""

if proper_name[0] not in "abcdefghijklmnopqrstuvwxyz":
raise CFBSValidationError(
name,
"Module name must start with a lowercase ASCII letter ('{}' starts with '{}')".format(
proper_name, proper_name[0]
"Module name must start with a lowercase ASCII letter ('{}' starts with '{}'){}".format(
proper_name, proper_name[0], suggestion
),
)

if not re.fullmatch(r, proper_name):
raise CFBSValidationError(
name,
"Module name contains illegal characters (only lowercase ASCII alphanumeric characters and single dash separators are allowed)",
"Module name contains illegal characters (only lowercase ASCII alphanumeric characters and single dash separators are allowed)"
+ suggestion,
)

log.debug("Successfully validated name of module %s" % name)
Expand Down
Loading