Skip to content

refactor: symbol names cleanup#11

Merged
jconzatti merged 16 commits intomainfrom
gui/names-prefix-refactor
Jan 29, 2026
Merged

refactor: symbol names cleanup#11
jconzatti merged 16 commits intomainfrom
gui/names-prefix-refactor

Conversation

@graduenz
Copy link
Contributor

@graduenz graduenz commented Jan 29, 2026

This pull request focuses on standardizing and simplifying parameter naming throughout the codebase, primarily replacing verbose or prefixed parameter names with shorter, clearer ones. It also updates related documentation, test code, and interface definitions to maintain consistency and improve readability.

The most important changes are:

Parameter Naming Standardization and Interface Simplification:

  • Replaced prefixed parameter names (e.g., pTableName, pColumnsValues, pSQLCommand) with shorter, more descriptive names (e.g., table, columns, values, sql, args) throughout the DDLSQLBuilder and DMLSQLBuilder interfaces and their implementations in builder.go and dialects/postgresql/builder.go. This change also updates function signatures and documentation examples accordingly. [1] [2]
  • Updated the DatabaseDriver interface to use concise parameter names (params, db) instead of prefixed ones, and refactored the OpenDatabase function and its usage to match the new naming convention in database.go. [1] [2]

Test Code Refactoring:

  • Refactored all test code in builder_test.go and database_test.go to use the new parameter names and local variable conventions, ensuring consistency with the production code changes. [1] [2]

Migration Example Consistency:

  • Updated migration code examples in README.md to use table instead of tableName for variable names, aligning with the new naming conventions. [1] [2]

To ensure no more prefixes are present, perform a search with the following regular expression:

\b[plr][A-Z][a-zA-Z0-9_]*\b

Resolves #8

@sonarqubecloud
Copy link

@jconzatti jconzatti merged commit cc771b1 into main Jan 29, 2026
3 checks passed
@jconzatti jconzatti deleted the gui/names-prefix-refactor branch January 29, 2026 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor: remove prefixes from variables and parameters

2 participants