Update require syntax and add require guards

Author: raiguard

README.md

@@ -12,7 +12,7 @@ creating Factorio mods.
 Download the latest release from the
 [mod portal](https://mods.factorio.com/mod/flib) unzip it, and put it in your
 mods directory. You can access libraries provided by flib with
-`require("__flib__/position")`, etc.
+`require("__flib__.position")`, etc.
 
 Add the flib directory to your language server's library. We recommend
 installing the [Factorio modding

area.lua

@@ -1,3 +1,7 @@
+if ... ~= "__flib__.area" then
+  return require("__flib__.area")
+end
+
 --- @diagnostic disable
 --- @deprecated Use `bounding-box` instead.
 local flib_area = {}

bounding-box.lua

@@ -1,10 +1,14 @@
-local position = require("__flib__/position")
+if ... ~= "__flib__.bounding-box" then
+  return require("__flib__.bounding-box")
+end
+
+local position = require("__flib__.position")
 
 --- Utilities for manipulating bounding boxes. All functions support both the shorthand and explicit syntaxes for boxes
 --- and positions, and will preserve the syntax that was passed in. Boxes are considered immutable; all functions will
 --- return new boxes.
 --- ```lua
---- local flib_bounding_box = require("__flib__/bounding-box")
+--- local flib_bounding_box = require("__flib__.bounding-box")
 --- ```
 --- @class flib_bounding_box
 local flib_bounding_box = {}
@@ -64,8 +68,10 @@ end
 function flib_bounding_box.contains_position(box, pos)
   local box = flib_bounding_box.ensure_explicit(box)
   local pos = position.ensure_explicit(pos)
-  return
-    box.left_top.x <= pos.x and box.left_top.y <= pos.y and box.right_bottom.x >= pos.x and box.right_bottom.y >= pos.y
+  return box.left_top.x <= pos.x
+    and box.left_top.y <= pos.y
+    and box.right_bottom.x >= pos.x
+    and box.right_bottom.y >= pos.y
 end
 
 --- Return the box in explicit form.
@@ -219,11 +225,10 @@ end
 function flib_bounding_box.intersects_box(box1, box2)
   local box1 = flib_bounding_box.ensure_explicit(box1)
   local box2 = flib_bounding_box.ensure_explicit(box2)
-  return
-    box1.left_top.x < box2.right_bottom.x
-      and box2.left_top.x < box1.right_bottom.x
-      and box1.left_top.y < box2.right_bottom.y
-      and box2.left_top.y < box1.right_bottom.y
+  return box1.left_top.x < box2.right_bottom.x
+    and box2.left_top.x < box1.right_bottom.x
+    and box1.left_top.y < box2.right_bottom.y
+    and box2.left_top.y < box1.right_bottom.y
 end
 
 --- Return a new box with  the same dimensions, moved by the given delta.

changelog.txt

@@ -6,6 +6,7 @@ Date: ????
     - Added `gui-templates` module for building various common and/or annoying GUI components, including technology slots.
     - Added `technology` module with various runtime technology-related utilities.
     - Added technology slot styles.
+    - Added require guards to allow requiring flib modules with any syntax without breaking upvalues.
   Bugfixes:
     - Fixed `data_util.get_energy_value` not accepting capital `K` as a unit suffix. (#59)
 ---------------------------------------------------------------------------------------------------

data-util.lua

@@ -1,6 +1,10 @@
+if ... ~= "__flib__.data-util" then
+  return require("__flib__.data-util")
+end
+
 --- Utilities for data stage prototype manipulation.
 --- ```lua
---- local flib_data_util = require("__flib__/data-util")
+--- local flib_data_util = require("__flib__.data-util")
 --- ```
 --- @class flib_data_util
 local flib_data_util = {}

data.lua

@@ -1,3 +1,3 @@
-require("prototypes/sprite")
-require("prototypes/style")
-require("prototypes/technology-slot-style")
+require("prototypes.sprite")
+require("prototypes.style")
+require("prototypes.technology-slot-style")

dictionary-lite.lua

@@ -1,6 +1,10 @@
-local gui = require("__flib__/gui-lite")
-local mod_gui = require("__core__/lualib/mod-gui")
-local table = require("__flib__/table")
+if ... ~= "__flib__.dictionary-lite" then
+  return require("__flib__.dictionary-lite")
+end
+
+local gui = require("__flib__.gui-lite")
+local mod_gui = require("__core__.lualib.mod-gui")
+local table = require("__flib__.table")
 
 --- @class FlibDictionaryGlobal
 --- @field init_ran boolean
@@ -25,7 +29,7 @@ local table = require("__flib__/table")
 
 --- Utilities for creating dictionaries of localised string translations.
 --- ```lua
---- local flib_dictionary = require("__flib__/dictionary-lite")
+--- local flib_dictionary = require("__flib__.dictionary-lite")
 --- ```
 --- @class flib_dictionary
 local flib_dictionary = {}

dictionary.lua

@@ -1,6 +1,10 @@
-local gui = require("__flib__/gui-lite")
-local mod_gui = require("__core__/lualib/mod-gui")
-local table = require("__flib__/table")
+if ... ~= "__flib__.dictionary" then
+  return require("__flib__.dictionary")
+end
+
+local gui = require("__flib__.gui-lite")
+local mod_gui = require("__core__.lualib.mod-gui")
+local table = require("__flib__.table")
 
 --- @diagnostic disable
 --- @deprecated Use 'dictionary-lite' instead.

direction.lua

@@ -1,8 +1,12 @@
-local flib_math = require("__flib__/math")
+if ... ~= "__flib__.direction" then
+  return require("__flib__.direction")
+end
+
+local flib_math = require("__flib__.math")
 
 --- Functions for working with directions.
 --- ```lua
---- local flib_direction = require("__flib__/direction")
+--- local flib_direction = require("__flib__.direction")
 --- ```
 --- @class flib_direction
 local flib_direction = {}

event.lua

@@ -1,3 +1,7 @@
+if ... ~= "__flib__.event" then
+  return require("__flib__.event")
+end
+
 --- @diagnostic disable
 --- @deprecated use `script` directly
 local flib_event = {}