emit all available actions in a comment in applied file

zth · zth · commit 8843b12d0651 · 2025-09-19T21:21:00.000+02:00
diff --git a/compiler/ml/cmt_utils.ml b/compiler/ml/cmt_utils.ml
@@ -15,6 +15,31 @@ type action_type =
 
 type cmt_action = {loc: Location.t; action: action_type; description: string}
 
+let action_to_string = function
+  | ApplyFunction {function_name} ->
+    Printf.sprintf "ApplyFunction(%s)"
+      (Longident.flatten function_name |> String.concat ".")
+  | ApplyCoercion {coerce_to_name} ->
+    Printf.sprintf "ApplyCoercion(%s)"
+      (Longident.flatten coerce_to_name |> String.concat ".")
+  | RemoveSwitchCase -> "RemoveSwitchCase"
+  | RemoveOpen -> "RemoveOpen"
+  | RemoveAwait -> "RemoveAwait"
+  | AddAwait -> "AddAwait"
+  | RewriteObjectToRecord -> "RewriteObjectToRecord"
+  | RewriteArrayToTuple -> "RewriteArrayToTuple"
+  | PrefixVariableWithUnderscore -> "PrefixVariableWithUnderscore"
+  | RemoveUnusedVariable -> "RemoveUnusedVariable"
+  | ReplaceWithVariantConstructor {constructor_name} ->
+    Printf.sprintf "ReplaceWithVariantConstructor(%s)"
+      (constructor_name |> Longident.flatten |> String.concat ".")
+  | ReplaceWithPolymorphicVariantConstructor {constructor_name} ->
+    Printf.sprintf "ReplaceWithPolymorphicVariantConstructor(%s)"
+      constructor_name
+  | RewriteIdent {new_ident} ->
+    Printf.sprintf "RewriteIdent(%s)"
+      (Longident.flatten new_ident |> String.concat ".")
+
 let _add_possible_action : (cmt_action -> unit) ref = ref (fun _ -> ())
 let add_possible_action action = !_add_possible_action action
 
diff --git a/tests/build_tests/actions/expected/Actions_AddAwait_applied.res b/tests/build_tests/actions/expected/Actions_AddAwait_applied.res
@@ -3,3 +3,7 @@ let fn = async () => 12
 let other = async (): int => {
   await fn()
 }
+
+/* === AVAILABLE ACTIONS:
+- AddAwait - Await promise
+*/
diff --git a/tests/build_tests/actions/expected/Actions_ApplyCoercion_applied.res b/tests/build_tests/actions/expected/Actions_ApplyCoercion_applied.res
@@ -3,3 +3,7 @@ type x2 = | ...x1 | Two
 
 let x1: x1 = One
 let x2: x2 = (x1 :> x2)
+
+/* === AVAILABLE ACTIONS:
+- ApplyCoercion(x2) - Coerce to x2
+*/
diff --git a/tests/build_tests/actions/expected/Actions_ApplyConversionFunction_applied.res b/tests/build_tests/actions/expected/Actions_ApplyConversionFunction_applied.res
@@ -1 +1,5 @@
 let x: int = Float.toInt(12.)
+
+/* === AVAILABLE ACTIONS:
+- ApplyFunction(Float.toInt) - Convert to int with Float.toInt
+*/
diff --git a/tests/build_tests/actions/expected/Actions_IdentButDidYouMeanModule_applied.res b/tests/build_tests/actions/expected/Actions_IdentButDidYouMeanModule_applied.res
@@ -0,0 +1,5 @@
+\"Console".log(123)
+
+/* === AVAILABLE ACTIONS:
+- RewriteIdent(Console) - Change to `Console`
+*/
diff --git a/tests/build_tests/actions/expected/Actions_JSXCustomComponentChildren_applied.res b/tests/build_tests/actions/expected/Actions_JSXCustomComponentChildren_applied.res
@@ -22,3 +22,7 @@ module CustomComponent = {
 }
 
 let x = <CustomComponent> {React.float(1.)} </CustomComponent>
+
+/* === AVAILABLE ACTIONS:
+- ApplyFunction(React.float) - Convert to float with React.float
+*/
diff --git a/tests/build_tests/actions/expected/Actions_PrefixUnusedVarUnderscore_applied.res b/tests/build_tests/actions/expected/Actions_PrefixUnusedVarUnderscore_applied.res
@@ -3,3 +3,7 @@ let f = () => {
   let _x = 1
   12
 }
+
+/* === AVAILABLE ACTIONS:
+- PrefixVariableWithUnderscore - Prefix with `_`
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RemoveAwait_applied.res b/tests/build_tests/actions/expected/Actions_RemoveAwait_applied.res
@@ -1,2 +1,6 @@
 let f = 12
 let x = f
+
+/* === AVAILABLE ACTIONS:
+- RemoveAwait - Remove await
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RemoveUnusedVar_applied.res b/tests/build_tests/actions/expected/Actions_RemoveUnusedVar_applied.res
@@ -2,3 +2,7 @@
 let f = () => {
   12
 }
+
+/* === AVAILABLE ACTIONS:
+- RemoveUnusedVariable - Remove unused variable
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RewriteArrayToTuple2_applied.res b/tests/build_tests/actions/expected/Actions_RewriteArrayToTuple2_applied.res
@@ -3,3 +3,7 @@ let doStuff = ((one, two)) => {
 }
 
 let x = doStuff(("hello", "world"))
+
+/* === AVAILABLE ACTIONS:
+- RewriteArrayToTuple - Rewrite to tuple
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RewriteArrayToTuple_applied.res b/tests/build_tests/actions/expected/Actions_RewriteArrayToTuple_applied.res
@@ -1 +1,6 @@
 let x = (1, 2, "hello")
+
+/* === AVAILABLE ACTIONS:
+- ApplyFunction(Int.fromString) - Convert to int with Int.fromString
+- RewriteArrayToTuple - Rewrite to tuple
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RewriteIdent_applied.res b/tests/build_tests/actions/expected/Actions_RewriteIdent_applied.res
@@ -1 +1,5 @@
 Console.log("hello")
+
+/* === AVAILABLE ACTIONS:
+- RewriteIdent(Console.log) - Rewrite to use Console.log
+*/
diff --git a/tests/build_tests/actions/expected/Actions_RewriteObjectToRecord_applied.res b/tests/build_tests/actions/expected/Actions_RewriteObjectToRecord_applied.res
@@ -2,3 +2,7 @@ type x = {one: bool}
 type xx = array<x>
 
 let x: xx = [{one: true}]
+
+/* === AVAILABLE ACTIONS:
+- RewriteObjectToRecord - Rewrite object to record
+*/
diff --git a/tests/build_tests/actions/expected/Actions_SpellcheckIdent_applied.res b/tests/build_tests/actions/expected/Actions_SpellcheckIdent_applied.res
@@ -1,2 +1,6 @@
 let aaaaa = 10
 let b = aaaaa
+
+/* === AVAILABLE ACTIONS:
+- RewriteIdent(aaaaa) - Change to `aaaaa`
+*/
diff --git a/tests/build_tests/actions/expected/Actions_StringConstantToPolyvariantConstructor_applied.res b/tests/build_tests/actions/expected/Actions_StringConstantToPolyvariantConstructor_applied.res
@@ -6,3 +6,7 @@ let doStuff = (a: int, b: [#ONE | #TWO]) => {
 }
 
 let x = doStuff(1, #ONE)
+
+/* === AVAILABLE ACTIONS:
+- ReplaceWithPolymorphicVariantConstructor(ONE) - Replace with polymorphic variant constructor ONE
+*/
diff --git a/tests/build_tests/actions/expected/Actions_StringConstantToVariantConstructor_applied.res b/tests/build_tests/actions/expected/Actions_StringConstantToVariantConstructor_applied.res
@@ -9,3 +9,7 @@ let processStatus = (s: status) => {
 }
 
 let result = processStatus(Active)
+
+/* === AVAILABLE ACTIONS:
+- ReplaceWithVariantConstructor(Active) - Replace with variant constructor Active
+*/
diff --git a/tests/build_tests/actions/expected/Actions_UnusedOpen_applied.res b/tests/build_tests/actions/expected/Actions_UnusedOpen_applied.res
@@ -1,3 +1,7 @@
 module X = {
   let doStuff = s => Console.log(s)
 }
+
+/* === AVAILABLE ACTIONS:
+- RemoveOpen - Remove open
+*/
diff --git a/tests/build_tests/actions/expected/Actions_UnusedSwitchCase_applied.res b/tests/build_tests/actions/expected/Actions_UnusedSwitchCase_applied.res
@@ -3,3 +3,7 @@ let x1 = switch Some(true) {
 | Some(false) => 2
 | None => 3
 }
+
+/* === AVAILABLE ACTIONS:
+- RemoveSwitchCase - Remove switch case
+*/
diff --git a/tests/build_tests/actions/fixtures/Actions_IdentButDidYouMeanModule.res b/tests/build_tests/actions/fixtures/Actions_IdentButDidYouMeanModule.res
@@ -0,0 +1 @@
+console.log(123)
diff --git a/tools/src/tools.ml b/tools/src/tools.ml
@@ -1584,7 +1584,15 @@ module Actions = struct
                    List.mem "RemoveUnusedVariable" filter)
       in
       match applyActionsToFile path possible_actions with
-      | Ok applied -> print_endline applied
+      | Ok applied ->
+        print_endline applied;
+        print_endline "/* === AVAILABLE ACTIONS:";
+        possible_actions
+        |> List.iter (fun (action : Cmt_utils.cmt_action) ->
+               Printf.printf "- %s - %s\n"
+                 (Cmt_utils.action_to_string action.action)
+                 action.description);
+        print_endline "*/"
       | Error e ->
         print_endline e;
         exit 1)

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,7 @@ let fn = async () => 12`
`3`	`3`	`let other = async (): int => {`
`4`	`4`	`await fn()`
`5`	`5`	`}`
	`6`	`+`
	`7`	`+/* === AVAILABLE ACTIONS:`
	`8`	`+- AddAwait - Await promise`
	`9`	`+*/`
Original file line number	Diff line number	Diff line change
`@@ -22,3 +22,7 @@ module CustomComponent = {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`let x = <CustomComponent> {React.float(1.)} </CustomComponent>`
	`25`	`+`
	`26`	`+/* === AVAILABLE ACTIONS:`
	`27`	`+- ApplyFunction(React.float) - Convert to float with React.float`
	`28`	`+*/`
Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,7 @@ let f = () => {`
`3`	`3`	`let _x = 1`
`4`	`4`	`12`
`5`	`5`	`}`
	`6`	`+`
	`7`	`+/* === AVAILABLE ACTIONS:`
	`8`	+- PrefixVariableWithUnderscore - Prefix with `_`
	`9`	`+*/`
Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,7 @@`
`2`	`2`	`let f = () => {`
`3`	`3`	`12`
`4`	`4`	`}`
	`5`	`+`
	`6`	`+/* === AVAILABLE ACTIONS:`
	`7`	`+- RemoveUnusedVariable - Remove unused variable`
	`8`	`+*/`
Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,7 @@ let doStuff = ((one, two)) => {`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`let x = doStuff(("hello", "world"))`
	`6`	`+`
	`7`	`+/* === AVAILABLE ACTIONS:`
	`8`	`+- RewriteArrayToTuple - Rewrite to tuple`
	`9`	`+*/`