Flatten lib namespace

Move all functions and classes currently available through lib/name and
libName to be under a single flat namespace in lib.  This make
reorganising the lib namespace much simpler as the location of symbols
can move without breaking the consumers of lib.

The multi-entrypoint design was already problematic for the web plugin
system which couldn't effectively use it due to how webpack's shared
module system is awkward to set up with multiple entrypoints per package.
This commit is contained in:
Hornwitser committed 2023-07-28 16:03:29 +02:00
1 parent bb58670597
commit bfe119eaa3
143 files changed
+1798 -1918

No files matched your search

+3 -3
View File
@@ -324,7 +324,7 @@ function readMapSettings(state) {
}
/**
* @typedef {object} module:lib/factorio.MapExchangeResult
* @typedef {object} module:lib.MapExchangeResult
* @property {array} version -
* Version of Factorio the string was created with.
* @property {object} map_gen_settings -
@@ -344,8 +344,8 @@ function readMapSettings(state) {
* save to set the map gen settings and the map settings for the save.
*
* @param {string} exchangeString - Max Exchange String to parse.
* @returns {module:lib/factorio.MapExchangeResult} Parsed result.
* @memberof module:lib/factorio
* @returns {module:lib.MapExchangeResult} Parsed result.
* @memberof module:lib
*/
function readMapExchangeString(exchangeString) {
exchangeString = exchangeString.replace(/[ \t\n\r]+/g, "");
+10 -10
View File
@@ -16,9 +16,9 @@ const libZipOps = require("../zip_ops");
* the server given, with dependencies generated for all the mods present in
* the server's mods folder.
*
* @param {module:lib/factorio.FactorioServer} server -
* @param {module:lib.FactorioServer} server -
* The server to generate the export mod for.
* @memberof module:lib/factorio
* @memberof module:lib
*/
async function generateExportMod(server) {
let dependencies = [];
@@ -63,12 +63,12 @@ async function loadZip(server, modVersions, mod) {
/**
* Load the given Factorio file path into a Buffer
*
* @param {module:lib/factorio.FactorioServer} server -
* @param {module:lib.FactorioServer} server -
* The server to load the file from.
* @param {Map<string, string>} modVersions - Mapping of mod to version used.
* @param {string} modPath - Factorio style path to the file to load.
* @returns {Promise<?Buffer>} The content of the file or null if not found.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -250,14 +250,14 @@ function filterItems(prototypes) {
* Assembles and packs the icons for the item prototypes given into a single
* spritesheet and json file with meta data.
*
* @param {module:lib/factorio.FactorioServer} server -
* @param {module:lib.FactorioServer} server -
* The server to generate the export mod for.
* @param {Map<string, string>} modVersions -
* Mapping of mod name to versions to get icons from.
* @param {Array<Object>} items - Array of item prototypes.
* @return {Promise<{itemSheet: Jimp, itemData: Map<string,Object>}>}
* Item spritesheet and metadata.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -321,14 +321,14 @@ async function exportItems(server, modVersions, items) {
* Parses and merges all the locales for the all the mods given through
* `modVersions` and `modOrder`.
*
* @param {module:lib/factorio.FactorioServer} server -
* @param {module:lib.FactorioServer} server -
* The server to export the locale from.
* @param {Map<string, string>} modVersions -
* Mapping of mod name to version to export locale from.
* @param {Array<string>} modOrder - Load order of the mods.
* @param {string} languageCode - Language to export locale for.
* @returns {Promise<Map<string, string>>} merged locale information
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -377,10 +377,10 @@ async function exportLocale(server, modVersions, modOrder, languageCode) {
/**
* Export the locale and item icons for the given factorio server
*
* @param {module:lib/factorio.FactorioServer} server -
* @param {module:lib.FactorioServer} server -
* The server to export the data from.
* @returns {Promise<JSZip>} zip file with exported data.
* @memberof module:lib/factorio
* @memberof module:lib
*/
async function exportData(server) {
await generateExportMod(server);
+3 -3
View File
@@ -27,7 +27,7 @@ const knownScenarios = {
*
* @param {Object} patchInfo - The patch info files's json content
* @returns {string} Generated control.lua code.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -77,7 +77,7 @@ function generateLoader(patchInfo) {
* their dependents. Throws an error if this is not possible.
*
* @param {Array<Object>} modules - Array of modules to reorder
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -175,7 +175,7 @@ function reorderDependencies(modules) {
*
* @param {string} savePath - Path to the Factorio save to patch.
* @param {Array<Object>} modules - Description of the modules to patch.
* @memberof module:lib/factorio
* @memberof module:lib
*/
async function patch(savePath, modules) {
let zip = await JSZip.loadAsync(await fs.readFile(savePath));
+7 -7
View File
@@ -21,7 +21,7 @@ const { LineSplitter } = require("../stream");
* reading the changelog.txt in it.
*
* @param {string} changelogPath - Path to changelog.txt.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -55,7 +55,7 @@ async function getVersion(changelogPath) {
* @param {string} a - Version to compare.
* @param {string} b - Version to compare.
* @returns {number} 1 if a < b, 0 if a = b and -1 if a > b.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -87,7 +87,7 @@ function versionOrder(a, b) {
* Version to look for, supports the special value "latest" for the
* latest version available.
* @returns {Promise<Array>} Array with path to data dir and version found.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -145,7 +145,7 @@ async function findVersion(factorioDir, targetVersion) {
* RFC 6335.
*
* @return {number} a number in the range 49152 to 65535.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -164,7 +164,7 @@ function randomDynamicPort() {
*
* @param {number} length - the length of the password to generate.
* @return {Promise<string>} password of the given length
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -207,7 +207,7 @@ async function generatePassword(length) {
* @param {string} source - Passed into the output structure as source
*
* @returns {object} - An object with interpeted data.
* @memberof module:lib/factorio
* @memberof module:lib
* @private
* @inner
*/
@@ -412,7 +412,7 @@ const outputHeuristics = [
* - save-finished - invoked when the server has finished a manual save
* - exit - invoked when the sterver has exited
* @extends events.EventEmitter
* @memberof module:lib/factorio
* @memberof module:lib
*/
class FactorioServer extends events.EventEmitter {
/**