[RFC] Generic JSX transform (#6565)

* rename, config, etc * generalize more * allow simplified @@jsxConfig * move to support react.component and generic jsx.component only * Revert "allow simplified @@jsxConfig" This reverts commit 7dcd211. * move fn * better name * changelog
rescript-lang · Jan 29, 2024 · b88e74f · b88e74f
1 parent 28b3b9a
commit b88e74f
Show file tree

Hide file tree

Showing 13 changed files with 177 additions and 134 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,8 @@
 
 #### :rocket: New Feature
 
-- experimental support of tagged template literals, eg ```sql`select * from ${table}```. https://github.com/rescript-lang/rescript-compiler/pull/6250
+- Experimental support of tagged template literals, eg ```sql`select * from ${table}```. https://github.com/rescript-lang/rescript-compiler/pull/6250
+- Experimental support for generic/custom JSX transforms. https://github.com/rescript-lang/rescript-compiler/pull/6565
 
 #### :bug: Bug Fix
 

diff --git a/jscomp/bsb/bsb_jsx.ml b/jscomp/bsb/bsb_jsx.ml
@@ -1,5 +1,5 @@
 type version = Jsx_v3 | Jsx_v4
-type module_ = React
+type module_ = React | Generic of {moduleName: string}
 type mode = Classic | Automatic
 type dependencies = string list
 
@@ -15,7 +15,7 @@ let encode_no_nl jsx =
   | None -> ""
   | Some Jsx_v3 -> "3"
   | Some Jsx_v4 -> "4")
-  ^ (match jsx.module_ with None -> "" | Some React -> "React")
+  ^ (match jsx.module_ with None -> "" | Some React -> "React" | Some Generic {moduleName} -> moduleName)
   ^
   match jsx.mode with
   | None -> ""
@@ -55,10 +55,10 @@ let from_map map =
        `Obj
          (fun m ->
            match m.?(Bsb_build_schemas.jsx_module) with
-           | Some (Str { loc; str }) -> (
+           | Some (Str { str }) -> (
                match str with
                | "react" -> module_ := Some React
-               | _ -> Bsb_exception.errorf ~loc "Unsupported jsx module %s" str)
+               | moduleName -> module_ := Some (Generic {moduleName}))
            | Some x ->
                Bsb_exception.config_error x
                  "Unexpected input (jsx module name) for jsx module"

diff --git a/jscomp/bsb/bsb_ninja_rule.ml b/jscomp/bsb/bsb_ninja_rule.ml
@@ -169,7 +169,8 @@ let make_custom_rules ~(gentype_config : Bsb_config_types.gentype_config)
     | None, None -> ());
     (match jsx.module_ with
     | None -> ()
-    | Some React -> Ext_buffer.add_string buf " -bs-jsx-module react");
+    | Some React -> Ext_buffer.add_string buf " -bs-jsx-module react"
+    | Some Generic {moduleName} -> Ext_buffer.add_string buf (" -bs-jsx-module " ^ moduleName));
     (match jsx.mode with
     | None -> ()
     | Some Classic -> Ext_buffer.add_string buf " -bs-jsx-mode classic"

diff --git a/jscomp/bsc/rescript_compiler_main.ml b/jscomp/bsc/rescript_compiler_main.ml
@@ -251,7 +251,6 @@ let buckle_script_flags : (string * Bsc_args.spec * string) array =
     "*internal* Set jsx version";
 
     "-bs-jsx-module", string_call (fun i ->
-      (if i <> "react" then Bsc_args.bad_arg (" Not supported jsx-module : " ^ i));
       Js_config.jsx_module := Js_config.jsx_module_of_string i),
     "*internal* Set jsx module";
 

diff --git a/jscomp/common/js_config.ml b/jscomp/common/js_config.ml
@@ -25,7 +25,7 @@
 (** Browser is not set via command line only for internal use *)
 
 type jsx_version = Jsx_v3 | Jsx_v4
-type jsx_module = React
+type jsx_module = React | Generic of {moduleName: string}
 type jsx_mode = Classic | Automatic
 
 let no_version_header = ref false
@@ -64,6 +64,7 @@ let int_of_jsx_version = function
 
 let string_of_jsx_module = function
 | React -> "react"
+| Generic {moduleName} -> moduleName
 
 let string_of_jsx_mode = function
 | Classic -> "classic"
@@ -76,7 +77,7 @@ let jsx_version_of_int = function
 
 let jsx_module_of_string = function
 | "react" -> React
-| _ -> React
+| moduleName -> Generic {moduleName}
 
 let jsx_mode_of_string = function
 | "classic" -> Classic

diff --git a/jscomp/common/js_config.mli b/jscomp/common/js_config.mli
@@ -23,7 +23,7 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 
 type jsx_version = Jsx_v3 | Jsx_v4
-type jsx_module = React
+type jsx_module = React | Generic of {moduleName: string}
 type jsx_mode = Classic | Automatic
 
 (* val get_packages_info :

diff --git a/jscomp/frontend/ppx_entry.ml b/jscomp/frontend/ppx_entry.ml
@@ -35,7 +35,7 @@ let rewrite_signature (ast : Parsetree.signature) : Parsetree.signature =
       let jsxVersion = int_of_jsx_version jsxVersion in
       let jsxModule = string_of_jsx_module !jsx_module in
       let jsxMode = string_of_jsx_mode !jsx_mode in
-      Reactjs_jsx_ppx.rewrite_signature ~jsxVersion ~jsxModule ~jsxMode ast
+      Jsx_ppx.rewrite_signature ~jsxVersion ~jsxModule ~jsxMode ast
   in
   if !Js_config.no_builtin_ppx then ast
   else
@@ -55,7 +55,7 @@ let rewrite_implementation (ast : Parsetree.structure) : Parsetree.structure =
       let jsxVersion = int_of_jsx_version jsxVersion in
       let jsxModule = string_of_jsx_module !jsx_module in
       let jsxMode = string_of_jsx_mode !jsx_mode in
-      Reactjs_jsx_ppx.rewrite_implementation ~jsxVersion ~jsxModule ~jsxMode ast
+      Jsx_ppx.rewrite_implementation ~jsxVersion ~jsxModule ~jsxMode ast
   in
   if !Js_config.no_builtin_ppx then ast
   else

diff --git a/jscomp/syntax/cli/res_cli.ml b/jscomp/syntax/cli/res_cli.ml
@@ -284,7 +284,7 @@ module CliArgProcessor = struct
         else exit 1)
       else
         let parsetree =
-          Reactjs_jsx_ppx.rewrite_signature ~jsxVersion ~jsxModule ~jsxMode
+          Jsx_ppx.rewrite_signature ~jsxVersion ~jsxModule ~jsxMode
             parseResult.parsetree
         in
         printEngine.printInterface ~width ~filename
@@ -300,7 +300,7 @@ module CliArgProcessor = struct
         else exit 1)
       else
         let parsetree =
-          Reactjs_jsx_ppx.rewrite_implementation ~jsxVersion ~jsxModule ~jsxMode
+          Jsx_ppx.rewrite_implementation ~jsxVersion ~jsxModule ~jsxMode
             parseResult.parsetree
         in
         printEngine.printImplementation ~width ~filename

diff --git a/jscomp/syntax/src/react_jsx_common.ml → jscomp/syntax/src/jsx_common.ml b/jscomp/syntax/src/react_jsx_common.ml → jscomp/syntax/src/jsx_common.ml
@@ -6,11 +6,14 @@ type jsxConfig = {
   mutable module_: string;
   mutable mode: string;
   mutable nestedModules: string list;
-  mutable hasReactComponent: bool;
+  mutable hasComponent: bool;
 }
 
 (* Helper method to look up the [@react.component] attribute *)
-let hasAttr (loc, _) = loc.txt = "react.component"
+let hasAttr (loc, _) =
+  match loc.txt with
+  | "react.component" | "jsx.component" -> true
+  | _ -> false
 
 (* Iterate over the attributes and try to find the [@react.component] attribute *)
 let hasAttrOnBinding {pvb_attributes} =
@@ -20,7 +23,7 @@ let coreTypeOfAttrs attributes =
   List.find_map
     (fun ({txt}, payload) ->
       match (txt, payload) with
-      | "react.component", PTyp coreType -> Some coreType
+      | ("react.component" | "jsx.component"), PTyp coreType -> Some coreType
       | _ -> None)
     attributes
 
@@ -37,7 +40,7 @@ let typVarsOfCoreType {ptyp_desc} =
 
 let raiseError ~loc msg = Location.raise_errorf ~loc msg
 
-let raiseErrorMultipleReactComponent ~loc =
+let raiseErrorMultipleComponent ~loc =
   raiseError ~loc
     "Only one component definition is allowed for each module. Move to a \
      submodule or other file if necessary."

diff --git a/jscomp/syntax/src/reactjs_jsx_ppx.ml → jscomp/syntax/src/jsx_ppx.ml b/jscomp/syntax/src/reactjs_jsx_ppx.ml → jscomp/syntax/src/jsx_ppx.ml
@@ -50,8 +50,8 @@ let updateConfig config payload =
   let fields = getPayloadFields payload in
   (match getInt ~key:"version" fields with
   | None -> ()
-  | Some i -> config.React_jsx_common.version <- i);
-  (match getString ~key:"module" fields with
+  | Some i -> config.Jsx_common.version <- i);
+  (match getString ~key:"module_" fields with
   | None -> ()
   | Some s -> config.module_ <- s);
   match getString ~key:"mode" fields with
@@ -68,7 +68,7 @@ let getMapper ~config =
     Reactjs_jsx_v3.jsxMapper ~config
   in
   let expr4, module_binding4, transformSignatureItem4, transformStructureItem4 =
-    Reactjs_jsx_v4.jsxMapper ~config
+    Jsx_v4.jsxMapper ~config
   in
 
   let expr mapper e =
@@ -89,18 +89,18 @@ let getMapper ~config =
       version = config.version;
       module_ = config.module_;
       mode = config.mode;
-      hasReactComponent = config.hasReactComponent;
+      hasComponent = config.hasComponent;
     }
   in
   let restoreConfig oldConfig =
-    config.version <- oldConfig.React_jsx_common.version;
+    config.version <- oldConfig.Jsx_common.version;
     config.module_ <- oldConfig.module_;
     config.mode <- oldConfig.mode;
-    config.hasReactComponent <- oldConfig.hasReactComponent
+    config.hasComponent <- oldConfig.hasComponent
   in
   let signature mapper items =
     let oldConfig = saveConfig () in
-    config.hasReactComponent <- false;
+    config.hasComponent <- false;
     let result =
       List.map
         (fun item ->
@@ -119,7 +119,7 @@ let getMapper ~config =
   in
   let structure mapper items =
     let oldConfig = saveConfig () in
-    config.hasReactComponent <- false;
+    config.hasComponent <- false;
     let result =
       List.map
         (fun item ->
@@ -143,11 +143,11 @@ let rewrite_implementation ~jsxVersion ~jsxModule ~jsxMode
     (code : Parsetree.structure) : Parsetree.structure =
   let config =
     {
-      React_jsx_common.version = jsxVersion;
+      Jsx_common.version = jsxVersion;
       module_ = jsxModule;
       mode = jsxMode;
       nestedModules = [];
-      hasReactComponent = false;
+      hasComponent = false;
     }
   in
   let mapper = getMapper ~config in
@@ -157,11 +157,11 @@ let rewrite_signature ~jsxVersion ~jsxModule ~jsxMode
     (code : Parsetree.signature) : Parsetree.signature =
   let config =
     {
-      React_jsx_common.version = jsxVersion;
+      Jsx_common.version = jsxVersion;
       module_ = jsxModule;
       mode = jsxMode;
       nestedModules = [];
-      hasReactComponent = false;
+      hasComponent = false;
     }
   in
   let mapper = getMapper ~config in

diff --git a/jscomp/syntax/src/reactjs_jsx_ppx.mli → jscomp/syntax/src/jsx_ppx.mli b/jscomp/syntax/src/reactjs_jsx_ppx.mli → jscomp/syntax/src/jsx_ppx.mli