Suppress remove curly braces from template #157 #263

AleksandrSl · 2018-07-30T20:44:03Z

No description provided.

AleksandrSl · 2018-10-05T23:17:51Z

Hi! What about this one, should I modify something?

AleksandrSl · 2019-05-02T11:57:14Z

Hi @shashachu, is this issue still needed to be done? If so I can resolve merge conflicts, otherwise I think it's time to close PR and issue)

shashachu · 2019-05-02T15:00:26Z

Hi, sorry about that. Can you resolve the conflicts and then I or someone else here will take a look.

NightlyNexus

looks good after conflicts are resolved

ktlint-ruleset-standard/src/test/resources/spec/string-template/lint.kt.spec

AleksandrSl · 2019-05-16T07:38:07Z

@NightlyNexus I think all work is done, any other comments?

ktlint-ruleset-standard/src/test/resources/spec/string-template/lint.kt.spec

AleksandrSl · 2019-08-30T20:20:01Z

Hi, sorry to bother you again) Is there a reason that prevents PR from being merged?

shashachu · 2019-08-30T22:40:37Z

Hi, sorry to bother you again) Is there a reason that prevents PR from being merged?

Hi! No, this PR just fell through the cracks.

shashachu · 2019-08-30T22:41:01Z

Hi, sorry to bother you again) Is there a reason that prevents PR from being merged?

Hi! No, this PR just fell through the cracks.

Can you rebase and just make sure the build still passes? I can merge after.

AleksandrSl · 2019-08-31T07:42:17Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

@@ -490,6 +515,12 @@ object KtLint {
                comment.replace(Regex("\\s"), " ").replace(" {2,}", " ").split(" ")

            private fun <T> List<T>.tail() = this.subList(1, this.size)
+
+            private val suppressAnnotationRuleMap = mapOf(


I think this map could be moved to some config file, to ease addition of new suppression
rules

I am not sure about having this mapping:

"RemoveCurlyBracesFromTemplate" just becomes an alias to "string-template" rule

This alias is detached from the rule itself

Overall this PR goes into direction of adding another way for suppress rules

To be consistent, I would propose to use following approach:

@Suppress("ktlint-string-template")

to disable rule for the block of code and remove this map.

I agree that this map looks weird, however original purpose for this PR was to respect annotations like @Suppress("RemoveCurlyBracesFromTemplate") to disable both IntellijIDEA and ktlint checks at the same time. Otherwise we will have to add both annotations

@Suppress("ktlint-string-template") @Suppress("RemoveCurlyBracesFromTemplate") println("Not found: ${notFound}")

and this way all sense in introduction of support for @Suppress annotation seems lost to me, cause it becomes specific for ktlint, and as you mentioned we already have ways to suppress ktlint checks

I agree that this map looks weird, however original purpose for this PR was to respect annotations like @Suppress("RemoveCurlyBracesFromTemplate") to disable both IntellijIDEA and ktlint checks at the same time.

Sorry, missed that. Then, as intermediate step, having this map looks ok. In the future would be better that rule provides a list of suppress names aliases.

AleksandrSl · 2019-08-31T07:42:39Z

Done!

Tapchicoma · 2019-11-05T20:05:29Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

+                    // Extract all Suppress annotations and create SuppressionHints
+                    val psi = node.psi
+                    if (psi is KtAnnotated) {
+                        psi.annotationEntries
+                            .filter {
+                                it.calleeExpression?.constructorReferenceExpression
+                                    ?.getReferencedName() in suppressAnnotations
+                            }.flatMap(KtAnnotationEntry::getValueArguments)
+                            .mapNotNull { it.getArgumentExpression()?.text?.removeSurrounding("\"") }
+                            .mapNotNull(suppressAnnotationRuleMap::get)
+                            .let { suppressedRules ->
+                                if (suppressedRules.isNotEmpty()) {
+                                    result.add(
+                                        SuppressionHint(
+                                            IntRange(psi.startOffset, psi.endOffset),
+                                            suppressedRules.toSet()
+                                        )
+                                    )
+                                }
+                            }
+                    }


nit: could you move this to some private method for better readability?

Tapchicoma · 2019-11-05T20:24:16Z

ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

@@ -490,6 +515,12 @@ object KtLint {
                comment.replace(Regex("\\s"), " ").replace(" {2,}", " ").split(" ")

            private fun <T> List<T>.tail() = this.subList(1, this.size)
+
+            private val suppressAnnotationRuleMap = mapOf(


I am not sure about having this mapping:

"RemoveCurlyBracesFromTemplate" just becomes an alias to "string-template" rule

This alias is detached from the rule itself

Overall this PR goes into direction of adding another way for suppress rules

To be consistent, I would propose to use following approach:

@Suppress("ktlint-string-template")

to disable rule for the block of code and remove this map.

Try top down approach. I need line numbers for suppression, it's not so trivial. Why not use offset for suppression?

Current flow is that all string-template errors are suppressed by RemoveCurlyBracesFromTemplate.

@Suppress

It turned out that @Suppress with arrayOf and [] are compile errors, and can be used only with destructuring.

Add more test for different annotations use sites.

Shame on me, forgot to remove "debugging" code

Distinct is redundant, cause toSet is called on the list afterwards.

…ons processing

Tapchicoma

Thank you for your contribution!

AleksandrSl mentioned this pull request Jan 30, 2019

Respect @Suppress("RemoveCurlyBracesFromTemplate") #157

Closed

NightlyNexus reviewed May 2, 2019

View reviewed changes

ktlint-ruleset-standard/src/test/resources/spec/string-template/lint.kt.spec Outdated Show resolved Hide resolved

AleksandrSl force-pushed the feature/suppress-remove-curly-braces-from-template branch from 611efb7 to c66826e Compare May 3, 2019 13:00

NightlyNexus approved these changes May 16, 2019

View reviewed changes

ktlint-ruleset-standard/src/test/resources/spec/string-template/lint.kt.spec Outdated Show resolved Hide resolved

AleksandrSl force-pushed the feature/suppress-remove-curly-braces-from-template branch from fa3f64b to 68866bd Compare August 31, 2019 07:32

AleksandrSl commented Aug 31, 2019

View reviewed changes

Tapchicoma reviewed Nov 5, 2019

View reviewed changes

AleksandrSl and others added 11 commits November 7, 2019 10:01

WIP

5ec6dbd

WIP

035685f

Try top down approach. I need line numbers for suppression, it's not so trivial. Why not use offset for suppression?

Implement top-down scenario

ef90195

Current flow is that all string-template errors are suppressed by RemoveCurlyBracesFromTemplate.

Fix cherry-pick consequences

ca32657

Simplify code

bb39bde

It turned out that @Suppress with arrayOf and [] are compile errors, and can be used only with destructuring.

Regard SuppressWarnings also

fca3b6c

Add more test for different annotations use sites.

Clean tests

b7733b5

Shame on me, forgot to remove "debugging" code

Remove unused import from KtLint.kt

a2a4ab1

Cleanup suppress annotations related code

0f000f9

Distinct is redundant, cause toSet is called on the list afterwards.

Clarify test meaning for suppress annotations

fe8e310

Fix typo in comments

4ee8253

AleksandrSl force-pushed the feature/suppress-remove-curly-braces-from-template branch from 68866bd to 4ee8253 Compare November 7, 2019 07:02

Improve code readability by extracting function for suppress annotati…

a0f3a4b

…ons processing

Tapchicoma approved these changes Nov 11, 2019

View reviewed changes

Tapchicoma merged commit baac14c into pinterest:master Nov 11, 2019

sjcqs mentioned this pull request Jun 4, 2020

Make ktlint follow @Suppress/@SuppressWarning annotations #765

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suppress remove curly braces from template #157 #263

Suppress remove curly braces from template #157 #263

AleksandrSl commented Jul 30, 2018

AleksandrSl commented Oct 5, 2018

AleksandrSl commented May 2, 2019

shashachu commented May 2, 2019

NightlyNexus left a comment

AleksandrSl commented May 16, 2019

AleksandrSl commented Aug 30, 2019

shashachu commented Aug 30, 2019

shashachu commented Aug 30, 2019

AleksandrSl Aug 31, 2019

Tapchicoma Nov 5, 2019

AleksandrSl Nov 6, 2019 •

edited

Loading

Tapchicoma Nov 6, 2019

AleksandrSl commented Aug 31, 2019

Tapchicoma Nov 5, 2019

Tapchicoma Nov 5, 2019

Tapchicoma left a comment

Suppress remove curly braces from template #157 #263

Suppress remove curly braces from template #157 #263

Conversation

AleksandrSl commented Jul 30, 2018

AleksandrSl commented Oct 5, 2018

AleksandrSl commented May 2, 2019

shashachu commented May 2, 2019

NightlyNexus left a comment

Choose a reason for hiding this comment

AleksandrSl commented May 16, 2019

AleksandrSl commented Aug 30, 2019

shashachu commented Aug 30, 2019

shashachu commented Aug 30, 2019

AleksandrSl Aug 31, 2019

Choose a reason for hiding this comment

Tapchicoma Nov 5, 2019

Choose a reason for hiding this comment

AleksandrSl Nov 6, 2019 • edited Loading

Choose a reason for hiding this comment

Tapchicoma Nov 6, 2019

Choose a reason for hiding this comment

AleksandrSl commented Aug 31, 2019

Tapchicoma Nov 5, 2019

Choose a reason for hiding this comment

Tapchicoma Nov 5, 2019

Choose a reason for hiding this comment

Tapchicoma left a comment

Choose a reason for hiding this comment

AleksandrSl Nov 6, 2019 •

edited

Loading