typed-factorio 1.3.1 → 1.5.0

package/generated/global-functions.d.ts

@@ -0,0 +1,33 @@
+// This is an auto-generated file. Do not edit directly!
+
+/** @noSelfInFile */
+
+/**
+ * `log()` can print {@link LocalisedString LocalisedStrings} to the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
+ * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
+ */
+declare function log(string: LocalisedString): void
+
+/**
+ * `localised_print()` allows printing {@link LocalisedString} to stdout without polluting the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
+ * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
+ */
+declare function localised_print(string: LocalisedString): void
+
+/**
+ * Factorio provides the `table_size()` function as a simple way to determine the size of tables with non-continuous keys, as the standard `#` operator does not work correctly for these. The function is a C++ implementation of the following Lua code, which is faster than doing the same in Lua:
+ *
+ * ```
+ * local function size(t)
+ *     local count = 0
+ *     for k,v in pairs(t) do
+ *         count = count + 1
+ *     end
+ *     return count
+ * end
+ * ```
+ *
+ * Note that `table_size()` does not work correctly for {@link LuaCustomTable}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length} instead.
+ * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
+ */
+declare function table_size(table: table): uint

package/generated/global-objects.d.ts

@@ -4,49 +4,42 @@
 
 /**
  * This is the main object, through which most of the API is accessed. It is, however, not available inside handlers registered with {@link LuaBootstrap#on_load LuaBootstrap::on_load}.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const game: LuaGameScript
 
 /**
  * Provides an interface for registering event handlers.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const script: LuaBootstrap
 
 /**
  * Allows inter-mod communication by way of providing a repository of interfaces that is shared by all mods.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const remote: LuaRemote
 
 /**
  * Allows registering custom commands for the in-game console accessible via the grave key.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const commands: LuaCommandProcessor
 
 /**
  * Allows reading the current mod settings.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const settings: LuaSettings
 
 /**
  * Allows printing messages to the calling RCON instance if any.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const rcon: LuaRCON
 
 /**
  * Allows rendering of geometric shapes, text and sprites in the game world.
- *
- * {@link https://lua-api.factorio.com/latest/ View documentation}
+ * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
  */
 declare const rendering: LuaRendering

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -27,29 +27,30 @@
   },
   "peerDependencies": {
     "lua-types": "^2.11.0",
-    "typescript-to-lua": "^1.3.1"
+    "typescript-to-lua": "^1.6.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.3",
-    "@types/node": "^16.11.12",
-    "@types/prettier": "^2.4.2",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "chalk": "^3.0.0",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.25.3",
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.6.2",
+    "@types/prettier": "^2.6.4",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
+    "chalk": "^4.1.2",
+    "eslint": "^8.20.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-import-resolver-typescript": "^3.3.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-promise": "^5.2.0",
-    "jest": "^27.4.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "jest": "^28.1.3",
     "lua-types": "^2.11.0",
-    "prettier": "^2.5.1",
-    "ts-jest": "^27.1.0",
-    "ts-node": "^10.4.0",
-    "typescript": "4.5.2",
-    "typescript-to-lua": "^1.3.1"
+    "prettier": "^2.7.1",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4",
+    "typescript-to-lua": "^1.7.1"
   }
 }

package/runtime/index.d.ts

@@ -3,6 +3,7 @@
 // generated
 /// <reference path="../generated/builtin-types.d.ts" />
 /// <reference path="../generated/global-objects.d.ts" />
+/// <reference path="../generated/global-functions.d.ts" />
 /// <reference path="../generated/defines.d.ts" />
 /// <reference path="../generated/events.d.ts" />
 /// <reference path="../generated/classes.d.ts" />

package/runtime/librariesAndFunctions.d.ts

@@ -89,35 +89,3 @@ declare namespace serpent {
    */
   function load<T>(str: string, options?: { safe?: boolean }): LuaMultiReturn<[true, T] | [false, string]>
 }
-
-/**
- * This function allows to log {@link LocalisedString} to the Factorio
- * {@link https://wiki.factorio.com/Log_file log file}. This, in combination with serpent, makes debugging in the data
- * stage easier, because it allows to simply inspect entire prototype tables. For example, this allows to see all
- * properties of the sulfur item prototype: `log(serpent.block(data.raw["item"]["sulfur"]))`
- */
-declare function log(ls: LocalisedString): void
-
-/**
- * This function allows printing {@link LocalisedString}s to stdout without polluting the logfile. This is primarily
- * useful for communicating with external tools that launch Factorio as a child process.
- */
-declare function localised_print(ls: LocalisedString): void
-
-/**
- * Factorio provides the function `table_size()` as a simple way to find the size of tables with non-continuous keys,
- * because the standard `#` does not work correctly for these. The function is a C++-side implementation of the
- * following Lua code, thus it is faster than using this code in Lua:
- *
- *     local function size(t)
- *       local count = 0
- *        for k,v in pairs(t) do
- *         count = count + 1
- *       end
- *       return count
- *     end
- *
- * Note that `table_size()` does not work correctly for {@link LuaCustomTable}s, their size has to be determined with
- * {@link LuaCustomTable.length LuaCustomTable::operator #} instead.
- */
-declare function table_size(tbl: table): number