Update to 0.2.1

ZwerOxotnik · ZwerOxotnik · commit a10c8157be1e · 2021-06-14T14:04:39.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,121 @@
+# OS #
+######
+.DS_Store
+
+# Git #
+#######
+*.orig
+itory
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Node & Bower & JSPM #
+#######################
+node_modules
+bower_components
+jspm_packages
+
+# NetBeans specific #
+#####################
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.nb-gradle/
+nbactions.xml
+nb-configuration.xml
+
+# KomodoEdit #
+##############
+*.komodoproject
+.komodotools
+
+# Cloud9 #
+##########
+.c9revisions
+.c9
+
+# Notepad++ backups #
+#####################
+*.bak
+
+# Linux #
+#########
+*~
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+# KDE directory preferences
+.directory
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# Node #
+########
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+# Coverage directory used by tools like istanbul
+coverage
+# nyc test coverage
+.nyc_output
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+# Bower dependency directory (https://bower.io/)
+bower_components
+# node-waf configuration
+.lock-wscript
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+# Dependency directories
+node_modules/
+jspm_packages/
+# TypeScript v1 declaration files
+typings/
+# Optional npm cache directory
+.npm
+# Optional eslint cache
+.eslintcache
+# Optional REPL history
+.node_repl_history
+# Output of 'npm pack'
+*.tgz
+# Yarn Integrity file
+.yarn-integrity
+# dotenv environment variables file
+.env
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+# next.js build output
+.next
+# nuxt.js build output
+.nuxt
+# vuepress build output
+.vuepress/dist
+# Serverless directories
+.serverless
+# VS Code stuff
+.vscode/launch.json
diff --git a/README.md b/README.md
@@ -60,6 +60,7 @@ What it can do
 
 * Filter parameters of commands
 * Add switchable commands via map settings
+* Double check of commands
 * Use built-in error handling of commands
 * Use modular structure
 * Remotely and safely disable your mod
@@ -92,11 +93,12 @@ Stuff used
 How to start?
 ------------
 
+* Change [info.json](info.json), [defines.lua](defines.lua)
 * Replace my nickname, this project in links with your stuff almost everywhere
-* **Change** settings in [models/command-wrapper/control.lua](models/command-wrapper/control.lua)
 * Remove unnecessary code, files in /models and create a file there with similar structure in the folder
 * Handle files in [control.lua](control.lua)
 * **Change or delete** .github/ISSUE_TEMPLATE/*
+* Change settings in [models/command-wrapper/control.lua](models/command-wrapper/control.lua) if you want
 
 Notes
 -----
diff --git a/changelog.txt b/changelog.txt
@@ -1,4 +1,12 @@
 ﻿---------------------------------------------------------------------------------------------------
+Version: 0.2.0
+Date: 2021-06-14
+  Changes:
+    - Refactored
+    - Improved command-wrapper
+  Bugfixes:
+    - Fixed switchable commands
+---------------------------------------------------------------------------------------------------
 Version: 0.1.0
 Date: 2021-06-13
   Notes:
diff --git a/control.lua b/control.lua
@@ -2,7 +2,7 @@
 -- Don't init if it's a campaign
 if script.level.campaign_name then return end
 
-
+require("defines")
 local event_handler = require("event_handler")
 local modules = {}
 modules.command_wrapper = require("models/command-wrapper/control")
diff --git a/data-final-fixes.lua b/data-final-fixes.lua
@@ -0,0 +1,3 @@
+-- Prototypes: https://wiki.factorio.com/Prototype
+
+require("defines")
diff --git a/data-updates.lua b/data-updates.lua
@@ -0,0 +1,3 @@
+-- Prototypes: https://wiki.factorio.com/Prototype
+
+require("defines")
diff --git a/data.lua b/data.lua
@@ -1 +1,3 @@
 -- Prototypes: https://wiki.factorio.com/Prototype
+
+require("defines")
diff --git a/defines.lua b/defines.lua
@@ -0,0 +1,6 @@
+-- change this \/ in your mod!
+
+MOD_NAME = "example-mod"
+
+-- Don't use symbols like '-' etc (it'll break pattern of regular expressions)
+MOD_SHORT_NAME = "em_"
diff --git a/info.json b/info.json
@@ -1,6 +1,6 @@
 {
 	"name": "example-mod",
-	"version": "0.1.0",
+	"version": "0.2.1",
 	"factorio_version": "1.1",
 	"title": "Example mod",
 	"author": "Put your nickname",
diff --git a/models/command-wrapper/README.md b/models/command-wrapper/README.md
@@ -15,4 +15,5 @@ What it can do
 * Filter parameters of commands
 * Add switchable commands via map settings
 * Use built-in error handling of commands
+* Double check of commands
 * Has simple integration (4+ lines)
diff --git a/models/command-wrapper/control.lua b/models/command-wrapper/control.lua
@@ -3,24 +3,58 @@
 local all_commands = {} -- commands from other modules
 local module = {} -- this module
 
--- change this \/ in your mod!
--- Don't use symbols like '-' etc (it'll break pattern of regular expressions)
-local MOD_SHORT_NAME = "em_"
 local MAX_INPUT_LENGTH = 500 -- set any number
-local SWITCHABLE_COMMANDS = require("const-commands")
-local CONST_COMMANDS = require("switchable-commands")
+local CONST_COMMANDS = require("const-commands")
+local SWITCHABLE_COMMANDS = require("switchable-commands")
 
 
 local function trim(s)
 	return s:match'^%s*(.*%S)' or ''
 end
 
+local function remove_command(command_name)
+	local is_deleted = commands.remove_command(MOD_SHORT_NAME .. command_name)
+		if is_deleted == false then
+			commands.remove_command(command_name)
+		end
+end
+
 -- Sends message to a player or server
 local function print_to_caller(message, player_index)
-	if player_index == 0 then
+	if game == nil or player_index == nil or player_index == 0 then
 		print(message) -- this message for server
 	else
-		game.get_player(player_index).print(message)
+		local player = game.get_player(player_index)
+		if player and player.valid then
+			player.print(message)
+		end
+	end
+end
+
+local function disable_setting(error_message, player_index, key_command)
+	print_to_caller(error_message, player_index)
+
+	local is_message_sended = false
+	if game then
+		for _, player in pairs(game.connected_players) do
+			if player.valid and player.admin then
+				player.print(error_message)
+				is_message_sended = true
+			end
+		end
+	end
+	if is_message_sended == false then
+		log(error_message)
+	end
+
+	-- Turns off the command
+	if key_command then
+		local setting_name = MOD_SHORT_NAME .. key_command
+		if settings.global[setting_name] then
+			settings.global[setting_name] = {
+				value = false
+			}
+		end
 	end
 end
 
@@ -34,9 +68,15 @@ local function add_custom_command(command_settings, original_func, key_command)
 	local input_type = input_types[command_settings.input_type]
 	local is_allowed_empty_args = command_settings.is_allowed_empty_args
 	local command_name = command_settings.name
-	local command_description = command_settings.description
+	if commands.commands[command_name] then
+		command_name = MOD_SHORT_NAME .. command_name
+		if commands.commands[command_name] then
+			return false
+		end
+	end
 
-	commands.add_command(command_settings.name, command_description, function(cmd)
+	local command_description = command_settings.description
+	commands.add_command(command_name, command_description, function(cmd)
 		if cmd.player_index == 0 then
 			if command_settings.allow_for_server == false then
 				print({"prohibited-server-command"})
@@ -91,30 +131,14 @@ local function add_custom_command(command_settings, original_func, key_command)
 
 		-- error handling
 		local is_ok, error_message = pcall(original_func, cmd)
-		if is_ok then return end
-		print_to_caller(error_message, cmd.player_index)
-
-		local is_message_sended = false
-		for _, player in pairs(game.connected_players) do
-			if player.valid and player.admin then
-				player.print(error_message)
-				is_message_sended = true
-			end
-		end
-		if is_message_sended == false then
-			log(error_message)
-		end
-
-		-- Turns off the command
-		if key_command then
-			local setting_name = MOD_SHORT_NAME .. key_command
-			if settings.global[setting_name] then
-				settings.global[setting_name] = {
-					value = false
-				}
-			end
+		if is_ok then
+			return
+		else
+			disable_setting(error_message, cmd.player_index, key_command)
 		end
 	end)
+
+	return true
 end
 
 module.handle_custom_commands = function(module)
@@ -140,11 +164,18 @@ module.handle_custom_commands = function(module)
 		end
 
 		if setting == nil then
-			add_custom_command(command_settings, func)
+			local is_added = add_custom_command(command_settings, func)
+			if is_added == false then
+				log(script.level.mod_name .. " can't add command \"" .. command_settings.name .. "\"")
+			end
 		elseif setting.value then
-			add_custom_command(command_settings, func, key)
+			local is_added = add_custom_command(command_settings, func, key)
+			if is_added == false then
+				local message = script.level.mod_name .. " can't add command \"" .. command_settings.name .. "\""
+				disable_setting(message, nil, key)
+			end
 		else
-			commands.remove_command(command_settings.name)
+			remove_command(command_settings.name)
 		end
 	end
 
@@ -172,17 +203,24 @@ local function on_runtime_mod_setting_changed(event)
 	local command_settings = SWITCHABLE_COMMANDS[command_name] or {}
 	local state = settings.global[event.setting].value
 	command_settings.name = command_settings.name or command_name
-	if state then
-		game.print("Added command: " .. command_settings.name or command_name)
-		add_custom_command(command_settings, func, command_name)
+	if state == true then
+		local is_added = add_custom_command(command_settings, func, command_name)
+		if is_added then
+			game.print("Added command: " .. command_settings.name or command_name)
+		else
+			local message = script.level.mod_name .. " can't add command \"" .. command_settings.name .. "\""
+			disable_setting(message, nil, command_name)
+		end
 	else
+		remove_command(command_settings.name or command_name)
 		game.print("Removed command: " .. command_settings.name or command_name)
-		commands.remove_command(command_settings.name or command_name)
 	end
+
+	return true
 end
 
 -- Adds settings for commands, so we can disable commands by settings
-module.set_settings = function()
+module.create_settings = function()
 	local new_settings = {}
 	for key, command in pairs(SWITCHABLE_COMMANDS) do
 		local command_name = command.name or key
diff --git a/settings-final-fixes.lua b/settings-final-fixes.lua
@@ -0,0 +1,3 @@
+-- See https://wiki.factorio.com/Tutorial:Mod_settings#Reading_settings
+
+require("defines")
diff --git a/settings-updates.lua b/settings-updates.lua
@@ -0,0 +1,3 @@
+-- See https://wiki.factorio.com/Tutorial:Mod_settings#Reading_settings
+
+require("defines")
diff --git a/settings.lua b/settings.lua
@@ -1,6 +1,7 @@
 -- See https://wiki.factorio.com/Tutorial:Mod_settings#Reading_settings
 
-require("models/command-wrapper/control").set_settings() -- Adds switchable commands
+require("defines")
+require("models/command-wrapper/control").create_settings() -- Adds switchable commands
 
 -- Just an example
 -- data:extend({

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+-- Prototypes: https://wiki.factorio.com/Prototype`
	`2`	`+`
	`3`	`+require("defines")`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`-- Prototypes: https://wiki.factorio.com/Prototype`
	`2`	`+`
	`3`	`+require("defines")`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "example-mod",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.2.1",`
`4`	`4`	`"factorio_version": "1.1",`
`5`	`5`	`"title": "Example mod",`
`6`	`6`	`"author": "Put your nickname",`