Go Cleanup Built-in Rules #265

dvmarcilio · 2022-11-10T18:03:26Z

Ongoing work on writing built-in cleanup rules for Go.

polyglot/piranha/Cargo.toml

polyglot/piranha/README.md

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-11-30T14:31:58Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+    (binary_expression
+        left: [(true) (parenthesized_expression (true))]
+        operator:"&&"
+        right : (_)* @rhs


Why do we need * ? There has to be one RHS in the binary expression right?

Done. Thanks!

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-11-30T14:35:47Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+(
+    (binary_expression
+        left: (
+            [


What if we just use a wildcard for @lhs and @rhs ?

Done. Thanks!

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-11-30T14:37:33Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+replace = "@nested.statements"
+replace_node = "nested.block"
+
+# This rule is not deleting multiple statements after return.


IS that some issue with the grammar? Can we look into it ?

We can now successfully match all statements after return_statement in a similar way as e.g., Java and Javascript.
Accounting for the \nterminator did the trick:

(((statement) "\\n"?)+ @post)

However, replace is only working for the first statement. This is also happening in Java (draft PR #284).
The self-edge makes it work for the current implementation.

use dummy node

Introduced dummy node return_cleanup and now we have a cycle

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-12-06T16:47:58Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+query = """
+(
+    (binary_expression
+        left : (_)* @lhs


Suggested change

left : (_)* @lhs

left : (_) @lhs

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-12-06T17:21:44Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+)
+"""
+queries = [
+"""


Add more constraints.

Delete var declaration if all assignments' rhs eq init of var decl;
Delete all assignments if no var decl exists in scope

It turns out that this delete_parent_assignment rule was doing nothing. I removed it, and everything is working as expected.
Well-spotted that the constraint was not working.

polyglot/piranha/src/cleanup_rules/go/rules.toml

ketkarameya · 2022-12-08T15:04:09Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+#
+# Note that this rule *won't* rewrite when @lhs is a call.
+[[rules]]
+groups = ["boolean_expression_simplify"]


We have to think of a strategy to prevent it from simplifying after <something> || true

@ketkarameya should we deal with this in this PR? or do we open a new issue after this is accepted?

i think a follow up would be ok. We can address this alongside the fix for java/kt

ketkarameya · 2022-12-08T15:05:06Z

polyglot/piranha/src/cleanup_rules/go/rules.toml

+#####
+# Dummy rule to introduce a cycle for `delete_statement_after_return`
+[[rules]]
+name = "return_cleanup"


I think there is some naming convention for dummy rules in the readme

Renamed to return_statement_cleanup

ketkarameya · 2022-12-11T16:51:31Z

...ot/piranha/test-resources/go/feature_flag/system_1/const_same_file/configurations/rules.toml

+holes = ["stale_flag_name"]
+
+[[rules]]
+name = "replace_identifier_with_str_literal"


what is the purpose of this rule (And the above one)?

Thanks for the review, @ketkarameya. I agree that this rule is just noise. I restructured this test to have two rules:

find_const_str_literal: finds a constant (@const_id with a value equal to stale_flag_name piranha_argument.

false_flag: replaces with false calls to BoolValue() with an identifier argument equal to @const_id (hole).

Now the test doesn't remove the constant declaration.

ketkarameya

I have left a small comment on the tests. Otherwise this PR looks good to me.

...ot/piranha/test-resources/go/feature_flag/system_1/const_same_file/configurations/rules.toml

- Having the `\n` terminator reproduces the exact matching as languages such as Java and JavaScript

- `@treated` for flag value - `groups` in the end of rule definition - rule that matches first declared first - `false_flag` -> `update_feature_flag_api`

dvmarcilio requested a review from ketkarameya November 10, 2022 18:03

dvmarcilio changed the title ~~Go Cleanup Built-in Rules~~ [WIP] Go Cleanup Built-in Rules Nov 10, 2022

dvmarcilio force-pushed the go_develop branch 3 times, most recently from ee5aa14 to 1db699d Compare November 18, 2022 18:12

dvmarcilio added the polyglot-piranha label Nov 23, 2022

dvmarcilio force-pushed the go_develop branch from 1db699d to df23eba Compare November 23, 2022 14:54

ketkarameya reviewed Nov 30, 2022

View reviewed changes

polyglot/piranha/Cargo.toml Outdated Show resolved Hide resolved

ketkarameya reviewed Nov 30, 2022

View reviewed changes

dvmarcilio force-pushed the go_develop branch 2 times, most recently from c10f4a8 to 50e4937 Compare December 2, 2022 12:10

dvmarcilio mentioned this pull request Dec 2, 2022

Failing test for Java delete_all_statements_after_return #284

Draft

dvmarcilio requested a review from ketkarameya December 2, 2022 12:37

ketkarameya reviewed Dec 6, 2022

View reviewed changes

polyglot/piranha/src/cleanup_rules/go/rules.toml Show resolved Hide resolved

ketkarameya reviewed Dec 6, 2022

View reviewed changes

polyglot/piranha/src/cleanup_rules/go/rules.toml Outdated Show resolved Hide resolved

ketkarameya reviewed Dec 6, 2022

View reviewed changes

polyglot/piranha/src/cleanup_rules/go/rules.toml Outdated Show resolved Hide resolved

ketkarameya reviewed Dec 6, 2022

View reviewed changes

polyglot/piranha/src/cleanup_rules/go/rules.toml Show resolved Hide resolved

ketkarameya reviewed Dec 6, 2022

View reviewed changes

polyglot/piranha/src/cleanup_rules/go/rules.toml Outdated Show resolved Hide resolved

dvmarcilio force-pushed the go_develop branch from 50e4937 to db4c6e6 Compare December 7, 2022 11:10

dvmarcilio marked this pull request as ready for review December 7, 2022 13:40

dvmarcilio changed the title ~~[WIP] Go Cleanup Built-in Rules~~ Go Cleanup Built-in Rules Dec 7, 2022

dvmarcilio requested a review from ketkarameya December 7, 2022 20:13

ketkarameya reviewed Dec 8, 2022

View reviewed changes

ketkarameya mentioned this pull request Dec 11, 2022

Does Piranha support scala projects #199

Open

ketkarameya reviewed Dec 11, 2022

View reviewed changes

...ot/piranha/test-resources/go/feature_flag/system_1/const_same_file/configurations/rules.toml Outdated Show resolved Hide resolved

dvmarcilio added 22 commits December 18, 2022 20:01

Go simplify_identity: wildcard for lhs and rhs

a6255e2

Go: test for simplify if false with no alternative

d049ed8

Removing .s from delete_parent_assignment

8a24525

* and + rules with \n terminator

fcb1c48

- Having the `\n` terminator reproduces the exact matching as languages such as Java and JavaScript

Go grammar: branch on Uber tree-sitter-go repo

9439bca

return_cleanup <-> delete_stmt_after_return

533a1be

Go: removing * from lhs|rhs captures

8dba1a2

constraint for replace_identifier_with_value

e2c14ec

simplify_something_or_true excluding calls

7dbde04

simplify_something_and_false excluding calls

2fbd662

Removing 'delete_parent_assignment' !

5224867

Adding Go in PiranhaLanguage

189990c

dummy 'return_cleanup' -> 'return_statement_cleanup

171d4dc

Simplifying rules for test "const_same_file"

7759e90

const_same_file tests following conventions

fb72b1f

- `@treated` for flag value - `groups` in the end of rule definition - rule that matches first declared first - `false_flag` -> `update_feature_flag_api`

Removing empty edges.toml

9e8faf3

test_piranha_go: Adding needed import

67b509a

Using treated/treated_complement as arguments in test

1f93f33

Fix .toml formatting

8cbbe3c

cleaning remove_unnecessary_nested_block

0a1d8da

Cleaning delete_statement_after_return

bea7f6f

add missing license

4ce2547

dvmarcilio force-pushed the go_develop branch from ab1c9fb to 4ce2547 Compare December 18, 2022 20:27

dvmarcilio requested a review from ketkarameya December 18, 2022 20:41

ketkarameya approved these changes Dec 19, 2022

View reviewed changes

dvmarcilio added 3 commits December 19, 2022 18:11

README: checkmarks for Go

2b584aa

TODO on Cargo.toml to change tree-sitter-go dependency

c8f9942

Merge branch 'master' into go_develop

f0b1f55

dvmarcilio merged commit e2c9338 into master Dec 19, 2022

dvmarcilio deleted the go_develop branch December 19, 2022 18:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Go Cleanup Built-in Rules #265

Go Cleanup Built-in Rules #265

dvmarcilio commented Nov 10, 2022

ketkarameya Nov 30, 2022

dvmarcilio Dec 2, 2022

ketkarameya Nov 30, 2022

dvmarcilio Dec 2, 2022

ketkarameya Nov 30, 2022

dvmarcilio Dec 2, 2022 •

edited

ketkarameya Dec 6, 2022

dvmarcilio Dec 7, 2022

ketkarameya Dec 6, 2022

dvmarcilio Dec 7, 2022

ketkarameya Dec 6, 2022

dvmarcilio Dec 7, 2022

ketkarameya Dec 8, 2022

dvmarcilio Dec 8, 2022

ketkarameya Dec 8, 2022

ketkarameya Dec 8, 2022

dvmarcilio Dec 8, 2022

ketkarameya Dec 11, 2022 •

edited

dvmarcilio Dec 11, 2022

ketkarameya left a comment •

edited

Go Cleanup Built-in Rules #265

Go Cleanup Built-in Rules #265

Conversation

dvmarcilio commented Nov 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dvmarcilio Dec 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ketkarameya Dec 11, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ketkarameya left a comment • edited

Choose a reason for hiding this comment

dvmarcilio Dec 2, 2022 •

edited

ketkarameya Dec 11, 2022 •

edited

ketkarameya left a comment •

edited