[flow] Compatibility mode exclusion

Summary:
This diff makes a few changes to the hook compatibility mode:
* It changes the name (internally to flow, and externally in the flowconfig) for the hook compatibility mode from `hooklike_functions` to `hook_compatibility` to better match how we refer to it. `hooklike_functions` still is available in the flowconfig for... compatibility (lol)
* It introduces a new flowconfig option, `experimental.component_syntax.hook_compatibility.excludes`, to disable compatibility mode in a directory. The converse, `experimental.component_syntax.hook_compatibility.includes`, already existed.
* It modifies the behavior of inclusion/exclusion so that files that are included in compatibility mode have their exports behave accordingly: a compatible module that has a function hook export will have that function hook be callable in excluded components.

Reviewed By: alexmckenley

Differential Revision: D55780714

fbshipit-source-id: 83a3a4a69bcaa4161251af39554ca9ff72b99b3e

Author: mvitousek

src/codemods/annotate_exports.ml

@@ -77,7 +77,7 @@ module SignatureVerification = struct
         enable_relay_integration = Options.enable_relay_integration options;
         casting_syntax = Options.casting_syntax options;
         relay_integration_module_prefix = Options.relay_integration_module_prefix options;
-        hooklike_functions = Options.hooklike_functions_in_file options file;
+        hook_compatibility = Options.hook_compatibility_in_file options file;
         for_builtins = false;
         locs_to_dirtify = [];
       }

src/commands/commandUtils.ml

@@ -1379,11 +1379,15 @@ let make_options
     opt_as_const = Base.Option.value ~default:false (FlowConfig.enable_as_const flowconfig);
     opt_component_syntax = FlowConfig.component_syntax flowconfig;
     opt_react_rules = FlowConfig.react_rules flowconfig;
-    opt_hooklike_functions = FlowConfig.hooklike_functions flowconfig;
-    opt_hooklike_functions_includes =
+    opt_hook_compatibility = FlowConfig.hook_compatibility flowconfig;
+    opt_hook_compatibility_includes =
       Base.List.map
         ~f:(Files.expand_project_root_token ~root)
-        (FlowConfig.hooklike_functions_includes flowconfig);
+        (FlowConfig.hook_compatibility_includes flowconfig);
+    opt_hook_compatibility_excludes =
+      Base.List.map
+        ~f:(Files.expand_project_root_token ~root)
+        (FlowConfig.hook_compatibility_excludes flowconfig);
     opt_enable_const_params =
       Base.Option.value (FlowConfig.enable_const_params flowconfig) ~default:false;
     opt_enable_relay_integration = FlowConfig.relay_integration flowconfig;

src/commands/config/flowConfig.ml

@@ -55,8 +55,9 @@ module Opts = struct
     casting_syntax: Options.CastingSyntax.t option;
     channel_mode: [ `pipe | `socket ] option;
     component_syntax: bool;
-    hooklike_functions: bool;
-    hooklike_functions_includes: string list;
+    hook_compatibility: bool;
+    hook_compatibility_includes: string list;
+    hook_compatibility_excludes: string list;
     react_rules: Options.react_rules list;
     emoji: bool option;
     enable_as_const: bool option;
@@ -184,8 +185,9 @@ module Opts = struct
       channel_mode = None;
       casting_syntax = None;
       component_syntax = false;
-      hooklike_functions = true;
-      hooklike_functions_includes = [];
+      hook_compatibility = true;
+      hook_compatibility_includes = [];
+      hook_compatibility_excludes = [];
       react_rules = [];
       emoji = None;
       enable_as_const = None;
@@ -556,14 +558,21 @@ module Opts = struct
       ]
       (fun opts v -> Ok { opts with react_rules = v :: opts.react_rules })
 
-  let hooklike_functions_includes_parser =
+  let hook_compatibility_includes_parser =
     string
-      ~init:(fun opts -> { opts with hooklike_functions_includes = [] })
+      ~init:(fun opts -> { opts with hook_compatibility_includes = [] })
       ~multiple:true
       (fun opts v ->
-        Ok { opts with hooklike_functions_includes = v :: opts.hooklike_functions_includes })
+        Ok { opts with hook_compatibility_includes = v :: opts.hook_compatibility_includes })
 
-  let hooklike_functions_parser = boolean (fun opts v -> Ok { opts with hooklike_functions = v })
+  let hook_compatibility_excludes_parser =
+    string
+      ~init:(fun opts -> { opts with hook_compatibility_excludes = [] })
+      ~multiple:true
+      (fun opts v ->
+        Ok { opts with hook_compatibility_excludes = v :: opts.hook_compatibility_excludes })
+
+  let hook_compatibility_parser = boolean (fun opts v -> Ok { opts with hook_compatibility = v })
 
   let automatic_require_default_parser =
     boolean (fun opts v -> Ok { opts with automatic_require_default = Some v })
@@ -896,9 +905,19 @@ module Opts = struct
         boolean (fun opts v -> Ok { opts with enable_const_params = Some v })
       );
       ("experimental.component_syntax", component_syntax_parser);
-      ("experimental.component_syntax.hooklike_functions", hooklike_functions_parser);
+      ("experimental.component_syntax.hook_compatibility", hook_compatibility_parser);
+      ("experimental.component_syntax.hooklike_functions", hook_compatibility_parser);
+      ( "experimental.component_syntax.hook_compatibility.includes",
+        hook_compatibility_includes_parser
+      );
       ( "experimental.component_syntax.hooklike_functions.includes",
-        hooklike_functions_includes_parser
+        hook_compatibility_includes_parser
+      );
+      ( "experimental.component_syntax.hook_compatibility.excludes",
+        hook_compatibility_excludes_parser
+      );
+      ( "experimental.component_syntax.hooklike_functions.excludes",
+        hook_compatibility_excludes_parser
       );
       ("experimental.react_rule", react_rules_parser);
       ("experimental.facebook_module_interop", facebook_module_interop_parser);
@@ -1552,9 +1571,11 @@ let channel_mode c = c.options.Opts.channel_mode
 
 let component_syntax c = c.options.Opts.component_syntax
 
-let hooklike_functions_includes c = c.options.Opts.hooklike_functions_includes
+let hook_compatibility_includes c = c.options.Opts.hook_compatibility_includes
+
+let hook_compatibility_excludes c = c.options.Opts.hook_compatibility_excludes
 
-let hooklike_functions c = c.options.Opts.hooklike_functions
+let hook_compatibility c = c.options.Opts.hook_compatibility
 
 let react_rules c = c.options.Opts.react_rules
 

src/commands/config/flowConfig.mli

@@ -88,9 +88,11 @@ val channel_mode : config -> [ `pipe | `socket ] option
 
 val component_syntax : config -> bool
 
-val hooklike_functions_includes : config -> string list
+val hook_compatibility_excludes : config -> string list
 
-val hooklike_functions : config -> bool
+val hook_compatibility_includes : config -> string list
+
+val hook_compatibility : config -> bool
 
 val react_rules : config -> Options.react_rules list
 

src/common/options.ml

@@ -82,8 +82,9 @@ type t = {
   opt_casting_syntax: CastingSyntax.t;
   opt_channel_mode: [ `pipe | `socket ];
   opt_component_syntax: bool;
-  opt_hooklike_functions_includes: string list;
-  opt_hooklike_functions: bool;
+  opt_hook_compatibility_includes: string list;
+  opt_hook_compatibility_excludes: string list;
+  opt_hook_compatibility: bool;
   opt_react_rules: react_rules list;
   opt_debug: bool;
   opt_enable_const_params: bool;
@@ -190,20 +191,33 @@ let channel_mode opts = opts.opt_channel_mode
 
 let component_syntax opts = opts.opt_component_syntax
 
-let hooklike_functions opts = opts.opt_hooklike_functions
-
-let hooklike_functions_includes opts = opts.opt_hooklike_functions_includes
-
-let hooklike_functions_in_file opts file =
-  hooklike_functions opts
-  || begin
-       match hooklike_functions_includes opts with
-       | [] -> false
-       | dirs ->
-         let filename = File_key.to_string file in
-         let normalized_filename = Sys_utils.normalize_filename_dir_sep filename in
-         List.exists (fun str -> Base.String.is_prefix ~prefix:str normalized_filename) dirs
-     end
+let hook_compatibility opts = opts.opt_hook_compatibility
+
+let hook_compatibility_includes opts = opts.opt_hook_compatibility_includes
+
+let hook_compatibility_excludes opts = opts.opt_hook_compatibility_excludes
+
+let hook_compatibility_in_file opts file =
+  let included =
+    hook_compatibility opts
+    || begin
+         match hook_compatibility_includes opts with
+         | [] -> false
+         | dirs ->
+           let filename = File_key.to_string file in
+           let normalized_filename = Sys_utils.normalize_filename_dir_sep filename in
+           List.exists (fun str -> Base.String.is_prefix ~prefix:str normalized_filename) dirs
+       end
+  in
+  let excluded =
+    match hook_compatibility_excludes opts with
+    | [] -> false
+    | dirs ->
+      let filename = File_key.to_string file in
+      let normalized_filename = Sys_utils.normalize_filename_dir_sep filename in
+      List.exists (fun str -> Base.String.is_prefix ~prefix:str normalized_filename) dirs
+  in
+  included && not excluded
 
 let typecheck_component_syntax_in_file opts file =
   component_syntax opts || File_key.is_lib_file file

src/flow_dot_js.ml

@@ -94,7 +94,7 @@ let load_lib_files files =
       enable_component_syntax = true;
       component_syntax_enabled_in_config = true;
       enable_ts_syntax = true;
-      hooklike_functions = true;
+      hook_compatibility = true;
       casting_syntax = Options.CastingSyntax.Both;
       for_builtins = true;
       locs_to_dirtify = [];
@@ -120,8 +120,9 @@ let stub_metadata ~root ~checked =
     babel_loose_array_spread = false;
     casting_syntax = Options.CastingSyntax.Both;
     component_syntax = true;
-    hooklike_functions = true;
-    hooklike_functions_includes = [];
+    hook_compatibility = true;
+    hook_compatibility_includes = [];
+    hook_compatibility_excludes = [];
     react_rules =
       Options.
         [ValidateRefAccessDuringRender; DeepReadOnlyProps; DeepReadOnlyHookReturns; RulesOfHooks];

src/parser_utils/exports/__tests__/exports_tests.ml

@@ -59,7 +59,7 @@ let sig_opts =
     enable_component_syntax = true;
     component_syntax_enabled_in_config = true;
     enable_ts_syntax = true;
-    hooklike_functions = true;
+    hook_compatibility = true;
     enable_relay_integration = false;
     casting_syntax = Options.CastingSyntax.Colon;
     relay_integration_module_prefix = None;

src/parser_utils/type_sig/__tests__/type_sig_tests.ml

@@ -216,7 +216,7 @@ let sig_options
     ?(enable_enums = true)
     ?(enable_component_syntax = true)
     ?(enable_ts_syntax = true)
-    ?(hooklike_functions = true)
+    ?(hook_compatibility = true)
     ?(enable_relay_integration = false)
     ?(casting_syntax = Options.CastingSyntax.Colon)
     ?relay_integration_module_prefix
@@ -234,7 +234,7 @@ let sig_options
     enable_component_syntax;
     component_syntax_enabled_in_config = true;
     enable_ts_syntax;
-    hooklike_functions;
+    hook_compatibility;
     enable_relay_integration;
     casting_syntax;
     relay_integration_module_prefix;

src/parser_utils/type_sig/type_sig_options.ml

@@ -16,7 +16,7 @@ type t = {
   enable_component_syntax: bool;
   component_syntax_enabled_in_config: bool;
   enable_ts_syntax: bool;
-  hooklike_functions: bool;
+  hook_compatibility: bool;
   casting_syntax: Options.CastingSyntax.t;
   enable_relay_integration: bool;
   relay_integration_module_prefix: string option;
@@ -51,7 +51,7 @@ let of_options options docblock locs_to_dirtify file =
     enable_relay_integration;
     relay_integration_module_prefix;
     locs_to_dirtify;
-    hooklike_functions = Options.hooklike_functions options;
+    hook_compatibility = Options.hook_compatibility_in_file options file;
     suppress_types = Options.suppress_types options;
     facebook_fbt = Options.facebook_fbt options;
     max_literal_len = Options.max_literal_length options;
@@ -82,7 +82,7 @@ let builtin_options options =
     enable_component_syntax = true;
     component_syntax_enabled_in_config = Options.component_syntax options;
     enable_ts_syntax = false;
-    hooklike_functions = Options.hooklike_functions options;
+    hook_compatibility = Options.hook_compatibility options;
     casting_syntax = Options.casting_syntax options;
     for_builtins = true;
     locs_to_dirtify = [];

src/parser_utils/type_sig/type_sig_parse.ml

@@ -3555,7 +3555,7 @@ and function_def_helper =
       match id with
       | _ when hook -> HookDecl fun_loc
       | Some (_, { Ast.Identifier.name; _ })
-        when opts.hooklike_functions && Flow_ast_utils.hook_name name ->
+        when opts.hook_compatibility && Flow_ast_utils.hook_name name ->
         AnyHook
       | _ -> NonHook
     in
@@ -4516,7 +4516,7 @@ let declare_function_decl opts scope tbls decl =
                  HookAnnot
                else if
                  opts.component_syntax_enabled_in_config
-                 && opts.hooklike_functions
+                 && opts.hook_compatibility
                  && Flow_ast_utils.hook_name name
                then
                  AnyHook

src/services/code_action/__tests__/refactor_extract_utils_tests.ml

@@ -37,8 +37,9 @@ let stub_metadata ~root ~checked =
     babel_loose_array_spread = false;
     casting_syntax = Options.CastingSyntax.Colon;
     component_syntax = false;
-    hooklike_functions_includes = [];
-    hooklike_functions = true;
+    hook_compatibility_excludes = [];
+    hook_compatibility_includes = [];
+    hook_compatibility = true;
     react_rules = [];
     react_rules_always = false;
     enable_as_const = false;

src/typing/__tests__/type_hint_test.ml

@@ -29,8 +29,9 @@ let metadata =
     babel_loose_array_spread = false;
     casting_syntax = Options.CastingSyntax.Colon;
     component_syntax = true;
-    hooklike_functions_includes = [];
-    hooklike_functions = true;
+    hook_compatibility_excludes = [];
+    hook_compatibility_includes = [];
+    hook_compatibility = true;
     react_rules = [];
     react_rules_always = false;
     enable_as_const = false;
@@ -197,7 +198,7 @@ end = struct
         enable_component_syntax = true;
         component_syntax_enabled_in_config = true;
         enable_ts_syntax = true;
-        hooklike_functions = true;
+        hook_compatibility = true;
         casting_syntax = Options.CastingSyntax.Both;
         for_builtins = true;
         locs_to_dirtify = [];

src/typing/__tests__/typed_ast_test.ml

@@ -27,8 +27,9 @@ let metadata =
     babel_loose_array_spread = false;
     casting_syntax = Options.CastingSyntax.Colon;
     component_syntax = true;
-    hooklike_functions_includes = [];
-    hooklike_functions = true;
+    hook_compatibility_excludes = [];
+    hook_compatibility_includes = [];
+    hook_compatibility = true;
     react_rules = [];
     react_rules_always = false;
     enable_as_const = false;

src/typing/context.ml

@@ -38,8 +38,9 @@ type metadata = {
   babel_loose_array_spread: bool;
   casting_syntax: Options.CastingSyntax.t;
   component_syntax: bool;
-  hooklike_functions_includes: string list;
-  hooklike_functions: bool;
+  hook_compatibility_excludes: string list;
+  hook_compatibility_includes: string list;
+  hook_compatibility: bool;
   react_rules: Options.react_rules list;
   react_rules_always: bool;
   enable_as_const: bool;
@@ -254,8 +255,9 @@ let metadata_of_options options =
     babel_loose_array_spread = Options.babel_loose_array_spread options;
     casting_syntax = Options.casting_syntax options;
     component_syntax = Options.component_syntax options;
-    hooklike_functions_includes = Options.hooklike_functions_includes options;
-    hooklike_functions = Options.hooklike_functions options;
+    hook_compatibility_excludes = Options.hook_compatibility_excludes options;
+    hook_compatibility_includes = Options.hook_compatibility_includes options;
+    hook_compatibility = Options.hook_compatibility options;
     react_rules = Options.react_rules options;
     react_rules_always = false;
     enable_as_const = Options.as_const options;
@@ -455,8 +457,9 @@ let casting_syntax cx = cx.metadata.casting_syntax
 
 let component_syntax cx = cx.metadata.component_syntax || File_key.is_lib_file cx.file
 
-let hooklike_functions cx =
-  cx.metadata.hooklike_functions || in_dirlist cx cx.metadata.hooklike_functions_includes
+let hook_compatibility cx =
+  (cx.metadata.hook_compatibility || in_dirlist cx cx.metadata.hook_compatibility_includes)
+  && not (in_dirlist cx cx.metadata.hook_compatibility_excludes)
 
 let react_rules_always cx = cx.metadata.react_rules_always
 

src/typing/context.mli

@@ -75,8 +75,9 @@ type metadata = {
   babel_loose_array_spread: bool;
   casting_syntax: Options.CastingSyntax.t;
   component_syntax: bool;
-  hooklike_functions_includes: string list;
-  hooklike_functions: bool;
+  hook_compatibility_excludes: string list;
+  hook_compatibility_includes: string list;
+  hook_compatibility: bool;
   react_rules: Options.react_rules list;
   react_rules_always: bool;
   enable_as_const: bool;
@@ -160,7 +161,7 @@ val casting_syntax : t -> Options.CastingSyntax.t
 
 val component_syntax : t -> bool
 
-val hooklike_functions : t -> bool
+val hook_compatibility : t -> bool
 
 val react_rule_enabled : t -> Options.react_rules -> bool
 

src/typing/env_resolution.ml

@@ -55,7 +55,7 @@ let expression cx ?cond exp =
   t
 
 let make_hooklike cx t =
-  if Context.hooklike_functions cx then
+  if Context.hook_compatibility cx then
     Flow_js.mk_possibly_evaluated_destructor
       cx
       unknown_use