Rename the argument --enable-global-access-check-files

Summary: Rename the argument from "`--enable-global-access-check`" to "`--enable-global-access-check-files`" (which turns on the checker for the files with the given prefix), such that it can be easily distinguish from another argument "`--enable-global-access-check-functions`" (which turns on the checker for the functions in the given json file) by the name.

Reviewed By: jamesjwu, yuxuanchen1997

Differential Revision: D40035427

fbshipit-source-id: e8b262f069ef0e24869bd709cb4cb88f2a531317

Author: Chaoqiang Deng

hphp/hack/src/hackrs/compare_folded_decls_file.ml

@@ -242,7 +242,7 @@ let () =
       (* The following options do not affect the direct decl parser and can be ignored
          (they are used by hh_single_type_check, and we run hh_single_decl over all of
          the typecheck test cases). *)
-      ignored_arg "--enable-global-access-check";
+      ignored_arg "--enable-global-access-check-files";
       ignored_arg "--enable-global-access-check-functions";
       ignored_flag "--abstract-static-props";
       ignored_arg "--allowed-decl-fixme-codes";

hphp/hack/src/hh_oxidize/convert_toplevel_phrase.ml

@@ -75,8 +75,8 @@ let enum_modules =
     ("error_codes", "NastCheck");
     ("error_codes", "Typing");
     ("error_codes", "Init");
-    (* An optional error set that runs only for arg --enable-global-access-check
-       or --enable-global-access-check-function. *)
+    (* An optional error set that runs only for arg --enable-global-access-check-files
+       or --enable-global-access-check-functions. *)
     ("error_codes", "GlobalWriteCheck");
   ]
 

hphp/hack/src/hh_single_decl.ml

@@ -241,7 +241,7 @@ let () =
       (* The following options do not affect the direct decl parser and can be ignored
          (they are used by hh_single_type_check, and we run hh_single_decl over all of
          the typecheck test cases). *)
-      ignored_arg "--enable-global-access-check";
+      ignored_arg "--enable-global-access-check-files";
       ignored_arg "--enable-global-access-check-functions";
       ignored_flag "--abstract-static-props";
       ignored_arg "--allowed-decl-fixme-codes";

hphp/hack/src/hh_single_type_check.ml

@@ -328,7 +328,7 @@ let parse_options () =
     ref (TypecheckerOptions.profile_top_level_definitions GlobalOptions.default)
   in
   let memtrace = ref None in
-  let enable_global_access_check = ref [] in
+  let enable_global_access_check_files = ref [] in
   let enable_global_access_check_functions = ref SSet.empty in
   let refactor_mode = ref "" in
   let refactor_analysis_mode = ref "" in
@@ -814,14 +814,15 @@ let parse_options () =
         " Sets the amount of fuel that the type printer can use to display an individual type. Default: "
         ^ string_of_int
             (TypecheckerOptions.type_printer_fuel GlobalOptions.default) );
-      ( "--enable-global-access-check",
+      ( "--enable-global-access-check-files",
         Arg.String
-          (fun s -> enable_global_access_check := String_utils.split ',' s),
-        " Run global write checker on any file whose path is prefixed by the argument (use \"\\\" for hh_single_type_check)"
+          (fun s ->
+            enable_global_access_check_files := String_utils.split ',' s),
+        " Run global access checker on any file whose path is prefixed by the argument (use \"\\\" for hh_single_type_check)"
       );
       ( "--enable-global-access-check-functions",
         Arg.String set_enable_global_access_check_functions,
-        " Run global write checker on functions listed in the given JSON file"
+        " Run global access checker on functions listed in the given JSON file"
       );
       ( "--overwrite-loop-iteration-upper-bound",
         Arg.Int (fun u -> loop_iteration_upper_bound := Some u),
@@ -965,7 +966,7 @@ let parse_options () =
           ["/"]
         else
           [])
-      ~tco_global_access_check_enabled:!enable_global_access_check
+      ~tco_global_access_check_files_enabled:!enable_global_access_check_files
       ~tco_global_access_check_functions_enabled:
         !enable_global_access_check_functions
       ~tco_use_direct_decl_parser:!use_direct_decl_parser

hphp/hack/src/options/globalOptions.ml

@@ -128,7 +128,7 @@ type t = {
   po_disallow_inst_meth: bool;
   tco_use_direct_decl_parser: bool;
   tco_ifc_enabled: string list;
-  tco_global_access_check_enabled: string list;
+  tco_global_access_check_files_enabled: string list;
   tco_global_access_check_functions_enabled: SSet.t;
   po_enable_enum_supertyping: bool;
   po_interpret_soft_types_as_like_types: bool;
@@ -268,7 +268,7 @@ let default =
     po_disallow_inst_meth = false;
     tco_use_direct_decl_parser = true;
     tco_ifc_enabled = [];
-    tco_global_access_check_enabled = [];
+    tco_global_access_check_files_enabled = [];
     tco_global_access_check_functions_enabled = SSet.empty;
     po_enable_enum_supertyping = true;
     po_interpret_soft_types_as_like_types = false;
@@ -419,7 +419,8 @@ let make
     ?(po_disallow_inst_meth = default.po_disallow_inst_meth)
     ?(tco_use_direct_decl_parser = default.tco_use_direct_decl_parser)
     ?(tco_ifc_enabled = default.tco_ifc_enabled)
-    ?(tco_global_access_check_enabled = default.tco_global_access_check_enabled)
+    ?(tco_global_access_check_files_enabled =
+      default.tco_global_access_check_files_enabled)
     ?(tco_global_access_check_functions_enabled =
       default.tco_global_access_check_functions_enabled)
     ?(po_enable_enum_supertyping = default.po_enable_enum_supertyping)
@@ -572,7 +573,7 @@ let make
     po_disallow_inst_meth;
     tco_use_direct_decl_parser;
     tco_ifc_enabled;
-    tco_global_access_check_enabled;
+    tco_global_access_check_files_enabled;
     tco_global_access_check_functions_enabled;
     po_enable_enum_supertyping;
     po_interpret_soft_types_as_like_types;

hphp/hack/src/options/globalOptions.mli

@@ -257,11 +257,11 @@ type t = {
      (a list containing the empty string would denote all files,
      an empty list denotes no files) *)
   tco_ifc_enabled: string list;
-  (* Enable global write check on the specified list of path prefixes
+  (* Enable global access check on the specified list of path prefixes
      (a list containing the empty string would denote all files,
      an empty list denotes no files) *)
-  tco_global_access_check_enabled: string list;
-  (* Enable global write check on the spcified set of functions
+  tco_global_access_check_files_enabled: string list;
+  (* Enable global access check on the spcified set of functions
      (Empty denotes no functions) *)
   tco_global_access_check_functions_enabled: SSet.t;
   (* Enables the enum supertyping extension *)
@@ -439,7 +439,7 @@ val make :
   ?po_disallow_inst_meth:bool ->
   ?tco_use_direct_decl_parser:bool ->
   ?tco_ifc_enabled:string list ->
-  ?tco_global_access_check_enabled:string list ->
+  ?tco_global_access_check_files_enabled:string list ->
   ?tco_global_access_check_functions_enabled:SSet.t ->
   ?po_enable_enum_supertyping:bool ->
   ?po_interpret_soft_types_as_like_types:bool ->

hphp/hack/src/options/typecheckerOptions.ml

@@ -155,11 +155,11 @@ let enable_ifc t = GlobalOptions.{ t with tco_ifc_enabled = ["/"] }
 
 let ifc_enabled t = t.GlobalOptions.tco_ifc_enabled
 
-let enable_global_access_check t =
-  GlobalOptions.{ t with tco_global_access_check_enabled = ["/"] }
+let enable_global_access_check_files t =
+  GlobalOptions.{ t with tco_global_access_check_files_enabled = ["/"] }
 
-let global_access_check_enabled t =
-  t.GlobalOptions.tco_global_access_check_enabled
+let global_access_check_files_enabled t =
+  t.GlobalOptions.tco_global_access_check_files_enabled
 
 let global_access_check_functions_enabled t =
   t.GlobalOptions.tco_global_access_check_functions_enabled

hphp/hack/src/oxidized/gen/global_options.rs

@@ -3,7 +3,7 @@
 // This source code is licensed under the MIT license found in the
 // LICENSE file in the "hack" directory of this source tree.
 //
-// @generated SignedSource<<618c9c7aba2f3189646de21f775d6491>>
+// @generated SignedSource<<d412f7aa311a71c04d8bef01eee2b491>>
 //
 // To regenerate this file, run:
 //   hphp/hack/src/oxidized_regen.sh
@@ -133,7 +133,7 @@ pub struct GlobalOptions {
     pub po_disallow_inst_meth: bool,
     pub tco_use_direct_decl_parser: bool,
     pub tco_ifc_enabled: Vec<String>,
-    pub tco_global_access_check_enabled: Vec<String>,
+    pub tco_global_access_check_files_enabled: Vec<String>,
     pub tco_global_access_check_functions_enabled: s_set::SSet,
     pub po_enable_enum_supertyping: bool,
     pub po_interpret_soft_types_as_like_types: bool,

hphp/hack/src/oxidized/manual/global_options_impl.rs

@@ -111,7 +111,7 @@ impl Default for GlobalOptions {
             po_disallow_inst_meth: false,
             tco_use_direct_decl_parser: true,
             tco_ifc_enabled: vec![],
-            tco_global_access_check_enabled: vec![],
+            tco_global_access_check_files_enabled: vec![],
             tco_global_access_check_functions_enabled: s_set::SSet::new(),
             po_enable_enum_supertyping: true,
             po_interpret_soft_types_as_like_types: false,

hphp/hack/src/oxidized_by_ref/gen/global_options.rs

@@ -3,7 +3,7 @@
 // This source code is licensed under the MIT license found in the
 // LICENSE file in the "hack" directory of this source tree.
 //
-// @generated SignedSource<<7f2e8a77347250323dcd3eecaca58989>>
+// @generated SignedSource<<37e03868880ffb01ac0fe62911b0bb79>>
 //
 // To regenerate this file, run:
 //   hphp/hack/src/oxidized_regen.sh
@@ -158,7 +158,7 @@ pub struct GlobalOptions<'a> {
     #[serde(deserialize_with = "arena_deserializer::arena", borrow)]
     pub tco_ifc_enabled: &'a [&'a str],
     #[serde(deserialize_with = "arena_deserializer::arena", borrow)]
-    pub tco_global_access_check_enabled: &'a [&'a str],
+    pub tco_global_access_check_files_enabled: &'a [&'a str],
     #[serde(deserialize_with = "arena_deserializer::arena", borrow)]
     pub tco_global_access_check_functions_enabled: s_set::SSet<'a>,
     pub po_enable_enum_supertyping: bool,

hphp/hack/src/oxidized_by_ref/manual/global_options_impl.rs

@@ -109,7 +109,7 @@ const DEFAULT: GlobalOptions<'_> = GlobalOptions {
     po_disallow_inst_meth: false,
     tco_use_direct_decl_parser: true,
     tco_ifc_enabled: &[],
-    tco_global_access_check_enabled: &[],
+    tco_global_access_check_files_enabled: &[],
     tco_global_access_check_functions_enabled: s_set::SSet::empty(),
     po_enable_enum_supertyping: true,
     po_interpret_soft_types_as_like_types: false,

hphp/hack/src/server/serverArgs.ml

@@ -28,7 +28,7 @@ type options = {
   gen_saved_ignore_type_errors: bool;
   ignore_hh_version: bool;
   enable_ifc: string list;
-  enable_global_access_check: string list;
+  enable_global_access_check_files: string list;
   enable_global_access_check_functions: SSet.t;
   saved_state_ignore_hhconfig: bool;
   json_mode: bool;
@@ -78,11 +78,11 @@ module Messages = struct
   let enable_ifc =
     " run IFC analysis on any file whose path is prefixed by the argument (format: comma separated list of path prefixes)"
 
-  let enable_global_access_check =
-    " run global write checker on any file whose path is prefixed by the argument (format: comma separated list of path prefixes)"
+  let enable_global_access_check_files =
+    " run global access checker on any file whose path is prefixed by the argument (format: comma separated list of path prefixes)"
 
   let enable_global_access_check_functions =
-    " run global write checker on functions listed in the JSON file"
+    " run global access checker on functions listed in the JSON file"
 
   let from = " so we know who's invoking - e.g. nuclide, vim, emacs, vscode"
 
@@ -159,7 +159,7 @@ let parse_options () : options =
   let custom_telemetry_data = ref [] in
   let dump_fanout = ref false in
   let enable_ifc = ref [] in
-  let enable_global_access_check = ref [] in
+  let enable_global_access_check_files = ref [] in
   let enable_global_access_check_functions = ref SSet.empty in
   let from = ref "" in
   let from_emacs = ref false in
@@ -195,8 +195,8 @@ let parse_options () : options =
   let set_with_saved_state s = with_saved_state := Some s in
   let set_write_symbol_info s = write_symbol_info := Some s in
   let set_enable_ifc s = enable_ifc := String_utils.split ',' s in
-  let set_enable_global_access_check s =
-    enable_global_access_check := String_utils.split ',' s
+  let set_enable_global_access_check_files s =
+    enable_global_access_check_files := String_utils.split ',' s
   in
   let set_enable_global_access_check_functions s =
     let json_obj = Hh_json.json_of_file s in
@@ -236,9 +236,9 @@ let parse_options () : options =
       ("--daemon", Arg.Set should_detach, Messages.daemon);
       ("--dump-fanout", Arg.Set dump_fanout, Messages.dump_fanout);
       ("--enable-ifc", Arg.String set_enable_ifc, Messages.enable_ifc);
-      ( "--enable-global-access-check",
-        Arg.String set_enable_global_access_check,
-        Messages.enable_global_access_check );
+      ( "--enable-global-access-check-files",
+        Arg.String set_enable_global_access_check_files,
+        Messages.enable_global_access_check_files );
       ( "--enable-global-access-check-functions",
         Arg.String set_enable_global_access_check_functions,
         Messages.enable_global_access_check_functions );
@@ -355,7 +355,7 @@ let parse_options () : options =
     custom_telemetry_data = !custom_telemetry_data;
     dump_fanout = !dump_fanout;
     enable_ifc = !enable_ifc;
-    enable_global_access_check = !enable_global_access_check;
+    enable_global_access_check_files = !enable_global_access_check_files;
     enable_global_access_check_functions = !enable_global_access_check_functions;
     from = !from;
     gen_saved_ignore_type_errors = !gen_saved_ignore_type_errors;
@@ -391,7 +391,7 @@ let default_options ~root =
     custom_telemetry_data = [];
     dump_fanout = false;
     enable_ifc = [];
-    enable_global_access_check = [];
+    enable_global_access_check_files = [];
     enable_global_access_check_functions = SSet.empty;
     from = "";
     gen_saved_ignore_type_errors = false;
@@ -441,7 +441,8 @@ let dump_fanout options = options.dump_fanout
 
 let enable_ifc options = options.enable_ifc
 
-let enable_global_access_check options = options.enable_global_access_check
+let enable_global_access_check_files options =
+  options.enable_global_access_check_files
 
 let enable_global_access_check_functions options =
   options.enable_global_access_check_functions
@@ -531,7 +532,7 @@ let to_string
       custom_telemetry_data;
       dump_fanout;
       enable_ifc;
-      enable_global_access_check;
+      enable_global_access_check_files;
       enable_global_access_check_functions;
       from;
       gen_saved_ignore_type_errors;
@@ -626,8 +627,10 @@ let to_string
   let enable_ifc_str =
     Printf.sprintf "[%s]" (String.concat ~sep:"," enable_ifc)
   in
-  let enable_global_access_check_str =
-    Printf.sprintf "[%s]" (String.concat ~sep:"," enable_global_access_check)
+  let enable_global_access_check_files_str =
+    Printf.sprintf
+      "[%s]"
+      (String.concat ~sep:"," enable_global_access_check_files)
   in
   let enable_global_access_check_functions_str =
     Printf.sprintf
@@ -663,8 +666,8 @@ let to_string
     "enable_ifc: ";
     enable_ifc_str;
     ", ";
-    "enable_global_access_check: ";
-    enable_global_access_check_str;
+    "enable_global_access_check_files: ";
+    enable_global_access_check_files_str;
     ", ";
     "enable_global_access_check_functions: ";
     enable_global_access_check_functions_str;

hphp/hack/src/server/serverArgs_sig.ml

@@ -48,7 +48,7 @@ module type S = sig
 
   val enable_ifc : options -> string list
 
-  val enable_global_access_check : options -> string list
+  val enable_global_access_check_files : options -> string list
 
   val enable_global_access_check_functions : options -> SSet.t
 

hphp/hack/src/server/serverConfig.ml

@@ -442,8 +442,8 @@ let load ~silent config_filename options : t * ServerLocalConfig.t =
       ~tco_use_direct_decl_parser:
         local_config.ServerLocalConfig.use_direct_decl_parser
       ~tco_ifc_enabled:(ServerArgs.enable_ifc options)
-      ~tco_global_access_check_enabled:
-        (ServerArgs.enable_global_access_check options)
+      ~tco_global_access_check_files_enabled:
+        (ServerArgs.enable_global_access_check_files options)
       ~tco_global_access_check_functions_enabled:
         (ServerArgs.enable_global_access_check_functions options)
       ?po_enable_enum_classes:(bool_opt "enable_enum_classes" config)

hphp/hack/src/typing/tast_check/global_access_check.ml

@@ -13,9 +13,9 @@
  *
  * By default, this checker is turned off.
  * To turn on this checker:
- * - use the argument --enable-global-access-check
+ * - use the argument --enable-global-access-check-files
  *   to specify the prefixes of files to be checked (e.g. "/" for all files).
- * - use the argument --enable-global-access-check-function
+ * - use the argument --enable-global-access-check-functions
  *   to specify a JSON file of functions names to be checked.
  *   Together with --config enable_type_check_filter_files=true, this option
  *   checks specified functions within listed files.
@@ -539,7 +539,9 @@ let visitor =
   end
 
 let global_access_check_enabled_on_file tcopt file =
-  let enabled_paths = TypecheckerOptions.global_access_check_enabled tcopt in
+  let enabled_paths =
+    TypecheckerOptions.global_access_check_files_enabled tcopt
+  in
   let path = "/" ^ Relative_path.suffix file in
   List.exists enabled_paths ~f:(fun prefix ->
       String_utils.string_starts_with path prefix)

hphp/hack/src/typing/tast_check/tast_check.ml

@@ -42,7 +42,7 @@ let visitor ctx =
   let is_global_access_check_enabled =
     0
     <> List.length
-         (TypecheckerOptions.global_access_check_enabled
+         (TypecheckerOptions.global_access_check_files_enabled
             (Provider_context.get_tcopt ctx))
     || 0
        <> SSet.cardinal

hphp/hack/test/typecheck/global_access_check/HH_FLAGS

@@ -1,2 +1,2 @@
---enable-global-access-check "/"
+--enable-global-access-check-files "/"
 --allowed-fixme-codes-strict 11001,11002,11003