treefmt-nix icon indicating copy to clipboard operation
treefmt-nix copied to clipboard

Naming consistency in Nix module options

Open anntnzrb opened this issue 6 months ago • 0 comments

Is your feature request related to a problem? Please describe.

No. Upon revising the codebase, I first noticed some naming inconsistencies in the shfmt.nix file in comparison to others. This became more apparent when I compared it to other files like ruff.nix and prettier.nix. The inconsistencies involve the use of different naming conventions such as camelCase, snake_case, and kebab-case for module options. While this might seem like a minor issue, it could potentially lead to confusion or errors in the future.

Describe the solution you'd like

There should be a standard naming convention adopted for module options, especially for newer contributions. This standardization will help maintain consistency across the codebase and make it easier for developers to understand and contribute.

Describe alternatives you've considered

N/A

Additional context

There would be a significant amount of module renaming involved, so I'm curious how we would approach this process. How can we implement these changes efficiently and ensure a smooth transition without disrupting the current functionality?

Looking forward to thoughts and suggestions.

Greetings.

anntnzrb avatar Jul 31 '24 15:07 anntnzrb