Merge pull request #4700 from rescript-lang/clean_up_attributes

smooth transition between bs.inline and inline

Author: bobzhang

jscomp/ext/literals.ml

@@ -61,8 +61,8 @@ let fn_method = "fn_method"
 let fn_mk = "fn_mk"
 (*let js_fn_runmethod = "js_fn_runmethod"*)
 
-let bs_deriving = "bs.deriving"
-let bs_deriving_dot = "bs.deriving."
+
+
 
 
 (** nodejs *)

jscomp/main/js_main.ml

@@ -538,7 +538,7 @@ let _ : unit =
     exit 2
   | x -> 
     begin
-#if undefined BS_RELEASE_BUILD then      
+#if false (* undefined BS_RELEASE_BUILD *) then      
       Ext_obj.bt ();
 #end
       Location.report_exception ppf x;

jscomp/reserved_attributs.md

@@ -0,0 +1,49 @@
+
+
+This is a list of reserved attributes, we may use such information
+to detect unused attributes in the future
+
+
+get
+set
+this
+meth
+open -- not decided
+inline -- 
+    this would conflict exist one or not?
+    invalid payload in bs.inline
+    seems that we need loose the check
+deriving
+string
+int
+ignore
+unwrap
+uncurry
+as
+optional
+get_index
+return
+config
+obj
+raw -- not needed
+re -- not needed
+external -- not needed
+time   -- not needed
+node   -- not needed
+debugger -- not needed
+val
+module
+scope
+splice -- deprecated, use variadic
+variadic
+send
+send.pipe -- deprecated, no short-cut
+new
+set_index
+
+debugger.chrome -- deprecated
+
+keywords is okay `[@open]` is a valid syntax
+
+mark_used_bs_attribute - 
+may mark attributes including `inline`

jscomp/syntax/ast_attributes.ml

@@ -134,24 +134,16 @@ let external_needs_to_be_encoded (attrs : t)=
     (fun {txt} ->
        Ext_string.starts_with txt "bs." || txt = Literals.gentype_import) 
 
-let has_inline_in_stru (attrs : t) : bool =
-  Ext_list.exists attrs (fun 
-    (({txt;},_) as attr) -> 
-    if txt = "bs.inline" then
-      (Bs_ast_invariant.mark_used_bs_attribute attr;
-      true)
-    else false)       
-
-let has_inline_payload_in_sig (attrs : t)  = 
-  Ext_list.find_first attrs 
-    (fun (({txt},_) as attr) ->
-       if txt = "bs.inline" then
-       begin
-        Bs_ast_invariant.mark_used_bs_attribute attr;
-        true
-       end 
-       else false
-    ) 
+let is_inline : attr -> bool =        
+  (fun 
+    (({txt;},_)) -> 
+     txt = "bs.inline" || txt = "inline" 
+  )  
+  
+
+let has_inline_payload (attrs : t)  = 
+  Ext_list.find_first attrs is_inline
+    
 
 type derive_attr = {
   bs_deriving : Ast_payload.action list option

jscomp/syntax/ast_attributes.mli

@@ -50,11 +50,8 @@ val process_bs :
 val external_needs_to_be_encoded :
   t -> bool
 
-val has_inline_in_stru : 
-  t -> 
-  bool
 
-val has_inline_payload_in_sig :
+val has_inline_payload :
   t ->
   attr option 
 

jscomp/syntax/ast_derive.ml

@@ -65,15 +65,7 @@ let gen_signature
        (Ast_payload.table_dispatch !derive_table action).signature_gen
          tdcls explict_nonrec) 
 
-(** used for cases like [%sexp] *)         
-let gen_expression ({Asttypes.txt ; loc}) typ =
-  let txt = Ext_string.tail_from txt (String.length Literals.bs_deriving_dot) in 
-  match (Ast_payload.table_dispatch !derive_table 
-           ({txt ; loc}, None)).expression_gen with 
-  | None ->
-    Bs_syntaxerr.err loc (Unregistered txt)
 
-  | Some f -> f typ
 
 open Ast_helper  
 let gen_structure_signature 

jscomp/syntax/ast_derive.mli

@@ -52,12 +52,6 @@ val gen_signature:
   Ast_signature.t
 
 
-val gen_expression : 
-  string Asttypes.loc -> 
-  Parsetree.core_type -> 
-  Parsetree.expression
-
-
 
 val gen_structure_signature :  
   Location.t -> 

jscomp/syntax/ast_derive_abstract.ml

@@ -50,7 +50,7 @@ let  isAbstract (xs :Ast_payload.action list) =
       match txt with 
       | "abstract" -> 
         Location.raise_errorf ~loc 
-          "bs.deriving abstract does not work with any other deriving"
+          "deriving abstract does not work with any other deriving"
       | _ -> ()
     ) ;
     Not_abstract

jscomp/syntax/ast_exp_extension.ml

@@ -28,7 +28,7 @@ open Ast_helper
 
 
 let handle_extension record_as_js_object e (self : Bs_ast_mapper.mapper)
-    (({txt ; loc} as lid , payload) : Parsetree.extension) = 
+    (({txt ; loc}  , payload) : Parsetree.extension) = 
   begin match txt with
     | "bs.raw" | "raw" -> 
        Ast_exp_handle_external.handle_raw ~kind:Raw_exp loc payload      
@@ -141,10 +141,6 @@ let handle_extension record_as_js_object e (self : Bs_ast_mapper.mapper)
         | _ -> Location.raise_errorf ~loc "Expect an expression here"
       end
     | _ ->
-      match payload with
-      | PTyp typ when Ext_string.starts_with txt Literals.bs_deriving_dot ->
-        self.expr self (Ast_derive.gen_expression lid typ)
-      | _ ->  
         e (* For an unknown extension, we don't really need to process further*)
         (* Exp.extension ~loc ~attrs:e.pexp_attributes (
             self.extension self extension) *)

jscomp/syntax/bs_builtin_ppx.ml

@@ -60,7 +60,12 @@ let () =
   Ast_derive_js_mapper.init ()
 
 
-
+let succeed attr attrs = 
+  match attrs with 
+  | [ _ ] -> ()
+  | _ -> 
+    Bs_ast_invariant.mark_used_bs_attribute attr;  
+    Bs_ast_invariant.warn_discarded_unused_attributes attrs 
 
 type mapper = Bs_ast_mapper.mapper
 let default_mapper = Bs_ast_mapper.default_mapper
@@ -243,14 +248,14 @@ let signature_item_mapper (self : mapper) (sigi : Parsetree.signature_item) =
           Ast_external.handleExternalInSig self value_desc sigi
         else 
           (match 
-           Ast_attributes.has_inline_payload_in_sig
+           Ast_attributes.has_inline_payload
            pval_attributes with 
-         | Some ({loc},PStr [{pstr_desc = Pstr_eval ({pexp_desc },_)}]) ->
+         | Some ((_,PStr [{pstr_desc = Pstr_eval ({pexp_desc },_)}]) as attr) ->
            begin match pexp_desc with
              | Pexp_constant (
                Pconst_string
                (s,dec)) -> 
-               Bs_ast_invariant.warn_discarded_unused_attributes pval_attributes;
+               succeed attr pval_attributes;
                { sigi with 
                  psig_desc = Psig_value
                      { 
@@ -260,8 +265,8 @@ let signature_item_mapper (self : mapper) (sigi : Parsetree.signature_item) =
                      }}
              | Pexp_constant(
                Pconst_integer (s,None)
-               ) ->         
-               Bs_ast_invariant.warn_discarded_unused_attributes pval_attributes;
+               ) ->       
+               succeed attr pval_attributes;  
                let s = Int32.of_string s in  
                { sigi with 
                  psig_desc = Psig_value
@@ -273,22 +278,22 @@ let signature_item_mapper (self : mapper) (sigi : Parsetree.signature_item) =
              | Pexp_constant(Pconst_integer (s, Some 'L'))
                -> 
                let s = Int64.of_string s in  
-               Bs_ast_invariant.warn_discarded_unused_attributes pval_attributes; 
+               succeed attr pval_attributes;
                {sigi with psig_desc = Psig_value  {
                     value_desc with 
                     pval_prim = External_ffi_types.inline_int64_primitive s;
                     pval_attributes = [];
                   } }
               | Pexp_constant (Pconst_float(s,None)) -> 
-                Bs_ast_invariant.warn_discarded_unused_attributes pval_attributes; 
+                succeed attr pval_attributes;
                 {sigi with psig_desc = Psig_value  {
                     value_desc with 
                     pval_prim = External_ffi_types.inline_float_primitive s;
                     pval_attributes = [];
                   } }
               | Pexp_construct ({txt = Lident ("true" | "false" as txt)}, None)       
                 -> 
-                Bs_ast_invariant.warn_discarded_unused_attributes pval_attributes;
+                succeed attr pval_attributes;
                 { sigi with 
                  psig_desc = Psig_value
                      { 
@@ -297,12 +302,11 @@ let signature_item_mapper (self : mapper) (sigi : Parsetree.signature_item) =
                        pval_attributes = []
                      }}
               | _ -> 
-                Location.raise_errorf ~loc "invalid payload in bs.inline"
+                default_mapper.signature_item self sigi
            end 
-         | Some ({loc}, _) ->                  
-           Location.raise_errorf ~loc "invalid payload in bs.inline"
+         | Some  _            
          | None ->
-          default_mapper.signature_item self sigi
+         default_mapper.signature_item self sigi
           )
       | _ -> default_mapper.signature_item self sigi
 
@@ -327,66 +331,64 @@ let structure_item_mapper (self : mapper) (str : Parsetree.structure_item) =
     ->   
     let pvb_expr = self.expr self pvb_expr in 
     let pvb_attributes = self.attributes self pvb_attributes in 
-    let has_inline_property = Ast_attributes.has_inline_in_stru pvb_attributes in
-    if has_inline_property then
-      begin match pvb_expr.pexp_desc with 
-        | Pexp_constant(
-            Pconst_string
-              (s,dec))
-          ->      
-          Bs_ast_invariant.warn_discarded_unused_attributes pvb_attributes; 
-          {str with pstr_desc = Pstr_primitive  {
-               pval_name = pval_name ;
-               pval_type = Ast_literal.type_string (); 
-               pval_loc = pvb_loc;
-               pval_attributes = [];
-               pval_prim = External_ffi_types.inline_string_primitive s dec
-             } } 
-        | Pexp_constant(Pconst_integer (s,None))
-          -> 
-          let s = Int32.of_string s in  
-          Bs_ast_invariant.warn_discarded_unused_attributes pvb_attributes; 
-          {str with pstr_desc = Pstr_primitive  {
-               pval_name = pval_name ;
-               pval_type = Ast_literal.type_int (); 
-               pval_loc = pvb_loc;
-               pval_attributes = [];
-               pval_prim = External_ffi_types.inline_int_primitive s
-             } }
-        | Pexp_constant(Pconst_integer (s, Some 'L'))
-          -> 
-          let s = Int64.of_string s in  
-          Bs_ast_invariant.warn_discarded_unused_attributes pvb_attributes; 
-          {str with pstr_desc = Pstr_primitive  {
-               pval_name = pval_name ;
-               pval_type = Ast_literal.type_int64; 
-               pval_loc = pvb_loc;
-               pval_attributes = [];
-               pval_prim = External_ffi_types.inline_int64_primitive s
-             } }             
-        | Pexp_constant(Pconst_float (s, None))
-          ->
-          Bs_ast_invariant.warn_discarded_unused_attributes pvb_attributes; 
-          {str with pstr_desc = Pstr_primitive  {
-               pval_name = pval_name ;
-               pval_type = Ast_literal.type_float; 
-               pval_loc = pvb_loc;
-               pval_attributes = [];
-               pval_prim = External_ffi_types.inline_float_primitive s
-             } }                 
-        | Pexp_construct ({txt = Lident ("true" | "false" as txt) },None) -> 
-          Bs_ast_invariant.warn_discarded_unused_attributes pvb_attributes; 
-          {str with pstr_desc = Pstr_primitive  {
-               pval_name = pval_name ;
-               pval_type = Ast_literal.type_bool (); 
-               pval_loc = pvb_loc;
-               pval_attributes = [];
-               pval_prim = External_ffi_types.inline_bool_primitive (txt = "true")
-             } }
-        | _ -> Location.raise_errorf ~loc:pvb_loc "invalid payload in bs.inline"
-      end 
-    else      
-      { str with pstr_desc =  Pstr_value(Nonrecursive, [{pvb_pat ; pvb_expr; pvb_attributes; pvb_loc}])}
+    let has_inline_property = Ast_attributes.has_inline_payload pvb_attributes in    
+    begin match has_inline_property, pvb_expr.pexp_desc with 
+      | Some attr, Pexp_constant(
+          Pconst_string
+            (s,dec))
+        ->      
+        succeed attr pvb_attributes; 
+        {str with pstr_desc = Pstr_primitive  {
+             pval_name = pval_name ;
+             pval_type = Ast_literal.type_string (); 
+             pval_loc = pvb_loc;
+             pval_attributes = [];
+             pval_prim = External_ffi_types.inline_string_primitive s dec
+           } } 
+      | Some attr, Pexp_constant(Pconst_integer (s,None))
+        -> 
+        let s = Int32.of_string s in  
+        succeed attr pvb_attributes; 
+        {str with pstr_desc = Pstr_primitive  {
+             pval_name = pval_name ;
+             pval_type = Ast_literal.type_int (); 
+             pval_loc = pvb_loc;
+             pval_attributes = [];
+             pval_prim = External_ffi_types.inline_int_primitive s
+           } }
+      | Some attr, Pexp_constant(Pconst_integer (s, Some 'L'))
+        -> 
+        let s = Int64.of_string s in  
+        succeed attr pvb_attributes; 
+        {str with pstr_desc = Pstr_primitive  {
+             pval_name = pval_name ;
+             pval_type = Ast_literal.type_int64; 
+             pval_loc = pvb_loc;
+             pval_attributes = [];
+             pval_prim = External_ffi_types.inline_int64_primitive s
+           } }             
+      | Some attr, Pexp_constant(Pconst_float (s, None))
+        ->
+        succeed attr pvb_attributes; 
+        {str with pstr_desc = Pstr_primitive  {
+             pval_name = pval_name ;
+             pval_type = Ast_literal.type_float; 
+             pval_loc = pvb_loc;
+             pval_attributes = [];
+             pval_prim = External_ffi_types.inline_float_primitive s
+           } }                 
+      | Some attr, Pexp_construct ({txt = Lident ("true" | "false" as txt) },None) -> 
+        succeed attr pvb_attributes; 
+        {str with pstr_desc = Pstr_primitive  {
+             pval_name = pval_name ;
+             pval_type = Ast_literal.type_bool (); 
+             pval_loc = pvb_loc;
+             pval_attributes = [];
+             pval_prim = External_ffi_types.inline_bool_primitive (txt = "true")
+           } }
+      | _ ->
+        { str with pstr_desc =  Pstr_value(Nonrecursive, [{pvb_pat ; pvb_expr; pvb_attributes; pvb_loc}])}
+    end
   | Pstr_attribute({txt = "bs.config" },_)  -> str      
   | _ -> default_mapper.structure_item self str
 
@@ -431,10 +433,6 @@ let rec
   | [] -> []  
   | item::rest -> 
     match item.pstr_desc with 
-    | Pstr_extension (({txt = ("bs.debugger.chrome" | "debugger.chrome") ;loc}, _),_)
-      -> 
-      Location.prerr_warning loc (Preprocessor "this extension can be safely removed");
-      structure_mapper self rest
     | Pstr_extension ( ({txt = ("bs.raw"| "raw") ; loc}, payload), _attrs)
       ->
       Ast_exp_handle_external.handle_raw_structure loc payload :: structure_mapper self rest