Prefix clusterio/lib imports with lib

Use lib* prefix for the modules impored from the lib package to help
distinguish them more from ordinary variables.  Fix up the naming
convention for files to be consistently lowercase_underscore for
JavaScript files.
This commit is contained in:
Hornwitser committed 2020-10-23 21:22:43 +02:00
1 parent fbbaf3dd3a
commit 24397b75cc
55 files changed
+692 -668

No files matched your search

+7 -5
View File
@@ -1,11 +1,13 @@
"use strict";
const plugin = require("@clusterio/lib/plugin");
const libPlugin = require("@clusterio/lib/plugin");
const info = require("./info");
const command = require("@clusterio/lib/command");
const libCommand = require("@clusterio/lib/command");
const globalChatCommands = new command.CommandTree({ name: "global-chat", description: "Global Chat plugin commands" });
globalChatCommands.add(new command.Command({
const globalChatCommands = new libCommand.CommandTree({
name: "global-chat", description: "Global Chat plugin commands",
});
globalChatCommands.add(new libCommand.Command({
definition: ["shout <message>", "Send message to all instances", (yargs) => {
yargs.positional("message", { describe: "message to send", type: "string" });
}],
@@ -17,7 +19,7 @@ globalChatCommands.add(new command.Command({
},
}));
class ControlPlugin extends plugin.BaseControlPlugin {
class ControlPlugin extends libPlugin.BaseControlPlugin {
async addCommands(rootCommand) {
rootCommand.add(globalChatCommands);
}
+2 -3
View File
@@ -1,6 +1,5 @@
"use strict";
let link = require("@clusterio/lib/link");
let plugin = require("@clusterio/lib/plugin");
let libLink = require("@clusterio/lib/link");
module.exports = {
name: "global_chat",
@@ -10,7 +9,7 @@ module.exports = {
controlEntrypoint: "control",
messages: {
chat: new link.Event({
chat: new libLink.Event({
type: "global_chat:chat",
links: ["instance-slave", "slave-master", "master-slave", "slave-instance", "control-master"],
forwardTo: "master",
+4 -4
View File
@@ -2,8 +2,8 @@
* @module
*/
"use strict";
const plugin = require("@clusterio/lib/plugin");
const luaTools = require("@clusterio/lib/luaTools");
const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools");
/**
@@ -16,7 +16,7 @@ function removeTags(content) {
return content.replace(/(\[gps=-?\d+,-?\d+\]|\[train=\d+\])/g, "");
}
class InstancePlugin extends plugin.BaseInstancePlugin {
class InstancePlugin extends libPlugin.BaseInstancePlugin {
async init() {
this.messageQueue = [];
}
@@ -33,7 +33,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
async chatEventHandler(message) {
// TODO check if cross server chat is enabled
let content = `[${message.data.instance_name}] ${removeTags(message.data.content)}`;
await this.instance.server.sendRcon(`/sc game.print('${luaTools.escapeString(content)}')`, true);
await this.instance.server.sendRcon(`/sc game.print('${libLuaTools.escapeString(content)}')`, true);
}
sendChat(message) {
+5 -5
View File
@@ -1,5 +1,5 @@
"use strict";
const link = require("@clusterio/lib/link");
const libLink = require("@clusterio/lib/link");
// schema used for syncing technologies to and from the master
@@ -26,7 +26,7 @@ module.exports = {
masterEntrypoint: "master",
messages: {
contribution: new link.Event({
contribution: new libLink.Event({
type: "research_sync:contribution",
links: ["instance-slave", "slave-master"],
forwardTo: "master",
@@ -36,7 +36,7 @@ module.exports = {
"contribution": { type: "number" },
},
}),
progress: new link.Event({
progress: new libLink.Event({
type: "research_sync:progress",
links: ["master-slave", "slave-instance"],
broadcastTo: "instance",
@@ -55,7 +55,7 @@ module.exports = {
},
},
}),
finished: new link.Event({
finished: new libLink.Event({
type: "research_sync:finished",
links: ["instance-slave", "slave-master", "master-slave", "slave-instance"],
forwardTo: "master",
@@ -65,7 +65,7 @@ module.exports = {
"level": { type: "integer" },
},
}),
syncTechnologies: new link.Request({
syncTechnologies: new libLink.Request({
type: "research_sync:sync_technologies",
links: ["instance-slave", "slave-master"],
forwardTo: "master",
+6 -6
View File
@@ -1,6 +1,6 @@
"use strict";
const plugin = require("@clusterio/lib/plugin");
const luaTools = require("@clusterio/lib/luaTools");
const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools");
function unexpectedError(err) {
@@ -9,7 +9,7 @@ function unexpectedError(err) {
console.log(err);
}
class InstancePlugin extends plugin.BaseInstancePlugin {
class InstancePlugin extends libPlugin.BaseInstancePlugin {
async init() {
if (!this.instance.config.get("factorio.enable_save_patching")) {
throw new Error("research_sync plugin requires save patching.");
@@ -28,7 +28,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
}
async progressEventHandler(message) {
let techsJson = luaTools.escapeString(JSON.stringify(message.data.technologies));
let techsJson = libLuaTools.escapeString(JSON.stringify(message.data.technologies));
await this.instance.server.sendRcon(`/sc research_sync.update_progress("${techsJson}")`, true);
}
@@ -39,7 +39,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
async finishedEventHandler(message) {
let { name, level, researched } = message.data;
await this.instance.server.sendRcon(
`/sc research_sync.research_technology("${luaTools.escapeString(name)}", ${level})`, true
`/sc research_sync.research_technology("${libLuaTools.escapeString(name)}", ${level})`, true
);
}
@@ -73,7 +73,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
}
if (techsToSync.length) {
let syncJson = luaTools.escapeString(JSON.stringify(techsToSync));
let syncJson = libLuaTools.escapeString(JSON.stringify(techsToSync));
await this.instance.server.sendRcon(`/sc research_sync.sync_technologies("${syncJson}")`, true);
}
}
+2 -2
View File
@@ -2,10 +2,10 @@
const fs = require("fs-extra");
const path = require("path");
const plugin = require("@clusterio/lib/plugin");
const libPlugin = require("@clusterio/lib/plugin");
class MasterPlugin extends plugin.BaseMasterPlugin {
class MasterPlugin extends libPlugin.BaseMasterPlugin {
async init() {
this.technologies = await loadTechnologies(this.master.config);
this.lastProgressBroadcast = Date.now();
-1
View File
@@ -1,5 +1,4 @@
"use strict";
let link = require("@clusterio/lib/link");
module.exports = {
name: "statistics_exporter",
+2 -2
View File
@@ -1,5 +1,5 @@
"use strict";
const plugin = require("@clusterio/lib/plugin");
const libPlugin = require("@clusterio/lib/plugin");
const { Gauge } = require("@clusterio/lib/prometheus");
@@ -21,7 +21,7 @@ const instanceGameFlowStatistics = new Gauge(
);
class InstancePlugin extends plugin.BaseInstancePlugin {
class InstancePlugin extends libPlugin.BaseInstancePlugin {
async init() {
if (!this.instance.config.get("factorio.enable_save_patching")) {
throw new Error("statistics_exporter plugin requires save patching.");
+3 -3
View File
@@ -1,15 +1,15 @@
"use strict";
const doleNN = require("./dole_nn_base");
const prometheus = require("@clusterio/lib/prometheus");
const { Gauge } = require("@clusterio/lib/prometheus");
const prometheusNNDoleGauge = new prometheus.Gauge(
const prometheusNNDoleGauge = new Gauge(
"clusterio_subspace_storage_nn_dole_gauge",
"Current demand being supplied by Neural Network ; 1 means all demand covered, 0.5 means about half of each supply is covered, 0 means no items are given",
{ labels: ["resource"] }
);
const prometheusDoleFactorGauge = new prometheus.Gauge(
const prometheusDoleFactorGauge = new Gauge(
"clusterio_subspace_storage_dole_factor_gauge",
"The current dole division factor for this resource",
{ labels: ["resource"] }
+8 -8
View File
@@ -1,8 +1,8 @@
"use strict";
const link = require("@clusterio/lib/link");
const config = require("@clusterio/lib/config");
const libLink = require("@clusterio/lib/link");
const libConfig = require("@clusterio/lib/config");
class MasterConfigGroup extends config.PluginConfigGroup {}
class MasterConfigGroup extends libConfig.PluginConfigGroup {}
MasterConfigGroup.groupName = "subspace_storage";
MasterConfigGroup.define({
name: "autosave_interval",
@@ -28,7 +28,7 @@ MasterConfigGroup.define({
});
MasterConfigGroup.finalize();
class InstanceConfigGroup extends config.PluginConfigGroup {}
class InstanceConfigGroup extends libConfig.PluginConfigGroup {}
InstanceConfigGroup.groupName = "subspace_storage";
InstanceConfigGroup.define({
name: "log_item_transfers",
@@ -65,7 +65,7 @@ module.exports = {
messages: {
// XXX this should be a request to be reliable
place: new link.Event({
place: new libLink.Event({
type: "subspace_storage:place",
links: ["instance-slave", "slave-master"],
forwardTo: "master",
@@ -74,7 +74,7 @@ module.exports = {
"items": items,
},
}),
remove: new link.Request({
remove: new libLink.Request({
type: "subspace_storage:remove",
links: ["instance-slave", "slave-master"],
forwardTo: "master",
@@ -86,7 +86,7 @@ module.exports = {
"items": items,
},
}),
getStorage: new link.Request({
getStorage: new libLink.Request({
type: "subspace_storage:get_storage",
links: ["instance-slave", "slave-master"],
forwardTo: "master",
@@ -94,7 +94,7 @@ module.exports = {
"items": items,
},
}),
updateStorage: new link.Event({
updateStorage: new libLink.Event({
type: "subspace_storage:update_storage",
links: ["master-slave", "slave-instance"],
broadcastTo: "instance",
+6 -6
View File
@@ -1,8 +1,8 @@
"use strict";
const fs = require("fs-extra");
const plugin = require("@clusterio/lib/plugin");
const luaTools = require("@clusterio/lib/luaTools");
const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools");
function unexpectedError(err) {
console.log("Unexpected error in subspace_storage");
@@ -10,7 +10,7 @@ function unexpectedError(err) {
console.log(err);
}
class InstancePlugin extends plugin.BaseInstancePlugin {
class InstancePlugin extends libPlugin.BaseInstancePlugin {
async init() {
this.instance.server.on("ipc-subspace_storage:output", (output) => {
this.provideItems(output).catch(unexpectedError);
@@ -29,7 +29,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
let response = await this.info.messages.getStorage.send(this.instance);
// TODO Diff with dump of invdata produce minimal command to sync
let itemsJson = luaTools.escapeString(JSON.stringify(response.items));
let itemsJson = libLuaTools.escapeString(JSON.stringify(response.items));
await this.instance.server.sendRcon(`/sc __subspace_storage__ UpdateInvData("${itemsJson}", true)`, true);
}
@@ -67,7 +67,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
console.log(response.items);
}
let itemsJson = luaTools.escapeString(JSON.stringify(response.items));
let itemsJson = libLuaTools.escapeString(JSON.stringify(response.items));
await this.instance.server.sendRcon(`/sc __subspace_storage__ Import("${itemsJson}")`, true);
}
@@ -86,7 +86,7 @@ class InstancePlugin extends plugin.BaseInstancePlugin {
// XXX this should be moved to instance/clusterio api
items.push(["signal-unixtime", Math.floor(Date.now()/1000)]);
let itemsJson = luaTools.escapeString(JSON.stringify(items));
let itemsJson = libLuaTools.escapeString(JSON.stringify(items));
await this.instance.server.sendRcon(`/sc __subspace_storage__ UpdateInvData("${itemsJson}")`, true);
}
}
+9 -9
View File
@@ -2,32 +2,32 @@
const fs = require("fs-extra");
const path = require("path");
const database = require("@clusterio/lib/database");
const plugin = require("@clusterio/lib/plugin");
const prometheus = require("@clusterio/lib/prometheus");
const libDatabase = require("@clusterio/lib/database");
const libPlugin = require("@clusterio/lib/plugin");
const { Counter, Gauge } = require("@clusterio/lib/prometheus");
const routes = require("./routes");
const dole = require("./dole");
const exportCounter = new prometheus.Counter(
const exportCounter = new Counter(
"clusterio_subspace_storage_export_total",
"Resources exported by instance",
{ labels: ["instance_id", "resource"] }
);
const importCounter = new prometheus.Counter(
const importCounter = new Counter(
"clusterio_subspace_storage_import_total",
"Resources imported by instance",
{ labels: ["instance_id", "resource"] }
);
const masterInventoryGauge = new prometheus.Gauge(
const masterInventoryGauge = new Gauge(
"clusterio_subspace_storage_master_inventory",
"Amount of resources stored on master",
{ labels: ["resource"] }
);
class MasterPlugin extends plugin.BaseMasterPlugin {
class MasterPlugin extends libPlugin.BaseMasterPlugin {
async init() {
this.items = await loadDatabase(this.master.config);
@@ -175,12 +175,12 @@ async function loadDatabase(config) {
console.log(`Loading ${itemsPath}`);
try {
let content = await fs.readFile(itemsPath);
return new database.ItemDatabase(JSON.parse(content));
return new libDatabase.ItemDatabase(JSON.parse(content));
} catch (err) {
if (err.code === "ENOENT") {
console.log("Creating new item database");
return new database.ItemDatabase();
return new libDatabase.ItemDatabase();
} else {
throw err;
-2
View File
@@ -1,8 +1,6 @@
"use strict";
const path = require("path");
const prometheus = require("@clusterio/lib/prometheus");
function addApiRoutes(app, items, endpointHitCounter) {