var-naming: regex support for custom package naming conventions by Acollie · Pull Request #1592 · mgechev/revive

Acollie · 2025-11-28T10:06:59Z

✅ Tests for new feature
✅ All current tests are passing

Copilot

Pull request overview

This PR adds support for custom package naming conventions through regex patterns in the var-naming rule. Users can now specify a validPackageRule parameter with a regex pattern to enforce their own package naming standards, which takes precedence over the default checks when configured.

Key changes:

Added validPackageNameRegex field to VarNamingRule struct to store the compiled regex pattern
Implemented regex-based package name validation that short-circuits default checks when configured
Added comprehensive test coverage with positive and negative test cases

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
rule/var_naming.go	Added regex configuration parsing, compilation, and validation logic for custom package naming rules
test/var_naming_test.go	Added test cases for valid and invalid package names using regex patterns
testdata/var_naming_valid_package_name_by_regex.go	Test data with a camelCase package name that passes the regex validation
testdata/var_naming_invalid_package_name_by_regex.go	Test data with an underscore-containing package name that fails regex validation
RULES_DESCRIPTIONS.md	Added detailed documentation for the new `validPackageRule` configuration option with examples
README.md	Added usage example showing how to configure custom package naming with regex patterns

Comments suppressed due to low confidence (1)

rule/var_naming.go:146

The skipPackageNameCollisionWithGoStd check is placed outside the switch statement, which means it will execute for every iteration of the loop regardless of the key. This should be a case within the switch statement to only execute when the key matches. This causes the check to run for unrelated option keys like validPackageRule, extraBadPackageNames, etc.

			if isRuleOption(k, "skipPackageNameCollisionWithGoStd") {
				r.skipPackageNameCollisionWithGoStd = true
			}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/var_naming_test.go

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

alexandear

Please resolve conflicts.

alexandear · 2025-12-01T12:31:28Z

rule/var_naming.go

 					}
 					r.extraBadPackageNames[strings.ToLower(n)] = struct{}{}
 				}
+			case isRuleOption(k, "validPackageRule"):


I propose naming the option packageNamePattern. What do you think?

Sure happy with that :)

alexandear · 2025-12-01T12:32:39Z

README.md

+This rule accepts two slices of strings, an allowlist and a blocklist of
+initialisms. By default, the rule behaves exactly as the alternative
+in `golint` but optionally, you can relax it
+(see [golint/lint/issues/89](https://github.com/golang/lint/issues/89))


Please do not modify lines that are not related to the PR.

Sorry about this I must have been trying to fix the markdown linter

README.md

RULES_DESCRIPTIONS.md

chavacava

Thanks for the PR, I've left some comments.

rule/var_naming.go

README.md

# Conflicts: # rule/var_naming.go

Co-authored-by: chavacava <salvadorcavadini+github@gmail.com>

…nto feat/1588-package-name-regex # Conflicts: # README.md

Acollie · 2025-12-05T14:38:05Z

Sorry for the delay, I have been ill. Thanks for the reviews @alexandear & @chavacava I have updated PR now

chavacava

Good to merge

alexandear · 2025-12-06T18:38:47Z

Let's wait before merging. I think we should move the package-naming-related checks out of the var-naming rule.

We already have #1603, and this PR will further complicate var-naming.

Give me three or four days to think about what we should do.

chavacava · 2025-12-06T18:47:00Z

Let's wait before merging. I think we should move the package-naming-related checks out of the var-naming rule.

Agree. But the new rule will be a mix of golint checks and new checks. Do we abandon the "golint drop-in replacement" promise? Do we make the new rule to do golint-checks by default but add a conf flag to activate newer checks?

denisvmedia · 2025-12-15T19:12:41Z

Do we still need to follow the drop-in replacement promise? It can be the right time to diverge and go our own way ;)

Acollie · 2025-12-19T15:20:15Z

@chavacava Should I close this PR?

chavacava · 2025-12-20T18:00:13Z

@chavacava Should I close this PR?

Hi @Acollie, no need to close the PR. Thanks for the work and the patience.

Acollie · 2025-12-20T20:59:53Z

@chavacava Should I close this PR?

Hi @Acollie, no need to close the PR. Thanks for the work and the patience.

No problem happy to migrate to a new rule if needed :)

Acollie · 2026-01-03T12:22:09Z

Happy new year! What do you want me todo with this PR?
@chavacava

…ame-regex

FEAT: Add regex support for custom package naming conventions

f435f42

Acollie mentioned this pull request Nov 28, 2025

package-naming rule #1588

Open

FEAT: Add regex support for custom package naming conventions

2a9a002

alexandear requested review from alexandear and Copilot November 28, 2025 18:12

Copilot started reviewing on behalf of alexandear November 28, 2025 18:12 View session

Copilot finished reviewing on behalf of alexandear November 28, 2025 18:14

Copilot AI reviewed Nov 28, 2025

View reviewed changes

test/var_naming_test.go Outdated Show resolved Hide resolved

Update var_naming_test.go

fece3f9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

alexandear changed the title ~~FEAT: Add regex support for custom package naming conventions~~ var-naming: regex support for custom package naming conventions Dec 1, 2025

alexandear requested changes Dec 1, 2025

View reviewed changes

chavacava reviewed Dec 1, 2025

View reviewed changes

rule/var_naming.go Outdated Show resolved Hide resolved

rule/var_naming.go Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Acollie and others added 13 commits December 5, 2025 13:57

Merge branch 'master' into feat/1588-package-name-regex

2eee1ad

# Conflicts: # rule/var_naming.go

FIX: merge with master

c5fb77f

FIX: update docs

0925136

Update README.md

5a149ac

Co-authored-by: chavacava <salvadorcavadini+github@gmail.com>

Update rule/var_naming.go

8488c5c

Co-authored-by: chavacava <salvadorcavadini+github@gmail.com>

Update rule/var_naming.go

3582835

Co-authored-by: chavacava <salvadorcavadini+github@gmail.com>

Merge remote-tracking branch 'acollie/feat/1588-package-name-regex' i…

51f2940

…nto feat/1588-package-name-regex # Conflicts: # README.md

FIX: rename rule argument

910364f

Fix markdown

bef5eea

Fix markdown

31c4695

Fix tests and rules from PR comments

cfe0dbc

Fix tests and rules from PR comments

39dabc5

Fix tests and rules from PR comments

f2582e0

Refactor package name validation logic to streamline regex check

76e8085

Acollie requested review from alexandear and chavacava December 5, 2025 14:46

chavacava approved these changes Dec 6, 2025

View reviewed changes

Merge remote-tracking branch 'origin/master' into feat/1588-package-n…

259bad0

…ame-regex

Conversation

Acollie commented Nov 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

alexandear left a comment

Choose a reason for hiding this comment

Uh oh!

alexandear Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

Acollie Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

alexandear Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

Acollie Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chavacava left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Acollie commented Dec 5, 2025

Uh oh!

chavacava left a comment

Choose a reason for hiding this comment

Uh oh!

alexandear commented Dec 6, 2025

Uh oh!

chavacava commented Dec 6, 2025

Uh oh!

denisvmedia commented Dec 15, 2025

Uh oh!

Acollie commented Dec 19, 2025

Uh oh!

chavacava commented Dec 20, 2025

Uh oh!

Acollie commented Dec 20, 2025

Uh oh!

Acollie commented Jan 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants