Skip to content
New issue

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

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

Already on GitHub? # to your account

Add property .editorconfig property ktlint_enum_entry_name_casing #2839

Merged
merged 1 commit into from
Oct 20, 2024

Conversation

paul-dingemans
Copy link
Collaborator

Description

This property allows enum entry names to be restricted to:

  • upper_cases: an enum entry may only contain uppercases, and underscores, and digits, and dicritics on letters and strokes
  • camel_cases: an enum entry may only contain CamelCase values, including digits, and dicritics on letters and strokes)
  • upper_or_camel_case: allows both the upper_cases and camel_cases styles as defined in the Kotlin Coding Conventions

Closes #2835

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

  • Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
  • At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
  • Tests are added
  • KtLint format has been applied on source code itself and violations are fixed
  • PR title is short and clear (it is used as description in the release changelog)
  • PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

  • Snapshot documentation in case documentation is to be released together with a code change
  • Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master

This property allows enum entry names to be restricted to:
 * `upper_cases`: an enum entry may only contain uppercases, and underscores, and digits, and dicritics on letters and strokes
  * `camel_cases`: an enum entry may only contain CamelCase values, including digits, and dicritics on letters and strokes)
  * `upper_or_camel_case`: allows both the `upper_cases` and `camel_cases` styles as defined in the Kotlin Coding Conventions

  Closes #2835
@paul-dingemans paul-dingemans added this to the 1.4.0 milestone Oct 19, 2024
@paul-dingemans paul-dingemans merged commit 244aa39 into master Oct 20, 2024
20 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enforce enum names (enhancement)
1 participant