Skip to content
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.

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

Suppress function-naming based on annotations #2275

Merged
merged 4 commits into from
Sep 23, 2023

Conversation

paul-dingemans
Copy link
Collaborator

Description

Add .editorconfig property ktlint_function_naming_ignore_when_annotated_with.

When using Compose, set property ktlint_function_naming_ignore_when_annotated_with=Composable to suppress the function-naming rule for functions annotated with @Composable. A dedicated ktlint ruleset like Compose Rules can be used for checking naming conventions for such Composable functions.

Closes #2259

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
  • CHANGELOG.md is updated
  • PR description added

Documentation is updated. See difference between snapshot and release documentation

…tated_with`

When using Compose, set property `ktlint_function_naming_ignore_when_annotated_with=Composable` to suppress the `function-naming` rule for functions annotated with `@Composable`. A dedicated ktlint ruleset like [Compose Rules](https://mrmans0n.github.io/compose-rules/ktlint/) can be used for checking naming conventions for such Composable functions.
…tated_with`

When using Compose, set property `ktlint_function_naming_ignore_when_annotated_with=Composable` to suppress the `function-naming` rule for functions annotated with `@Composable`. A dedicated ktlint ruleset like [Compose Rules](https://mrmans0n.github.io/compose-rules/ktlint/) can be used for checking naming conventions for such Composable functions.

Closes #2259
@paul-dingemans paul-dingemans added this to the 1.0.1 milestone Sep 23, 2023
@paul-dingemans paul-dingemans merged commit cdd5904 into master Sep 23, 2023
22 checks passed
@paul-dingemans paul-dingemans deleted the 2259-function-naming-composable branch September 23, 2023 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

standard:function-naming on composables
1 participant