Major cleanup.

- Use `irc.foo` notation instead of `irc:foo`. It still
  supports the `irc:foo` usage, but will helpfully issue
  a warning with the location of the offending code.
- Remove unused arguments from functions.

Author: kaeza

.luacheckrc

@@ -1,5 +1,4 @@
 
-unused_args = false
 allow_defined_top = true
 
 read_globals = {
@@ -11,4 +10,5 @@ exclude_files = {
 }
 
 globals = {
+	"irc",
 }

API.md

@@ -13,14 +13,14 @@ to your mod's `depends.txt` file.
 Reference
 ---------
 
-irc:say([name,] message)
+irc.say([name,] message)
 Sends <message> to either the channel (if <name> is nil or not specified),
 or to the given user (if <name> is specified).
 Example:
-	irc:say("Hello, Channel!")
-	irc:say("john1234", "How are you?")
+	irc.say("Hello, Channel!")
+	irc.say("john1234", "How are you?")
 
-irc:register_bot_command(name, cmdDef)
+irc.register_bot_command(name, cmdDef)
 	Registers a new bot command named <name>.
 	When an user sends a private message to the bot with the command name, the
 	command's function is called.
@@ -38,7 +38,7 @@ irc:register_bot_command(name, cmdDef)
 			end,
 		};
 	Example:
-		irc:register_bot_command("hello", {
+		irc.register_bot_command("hello", {
 			params = "",
 			description = "Greet user",
 			func = function(user, param)
@@ -55,12 +55,12 @@ irc.joined_players[name]
 		-- Joe is talking on IRC
 	end
 
-irc:register_hook(name, func)
+irc.register_hook(name, func)
 	Registers a function to be called when an event happens. <name> is the name
 	of the event, and <func> is the function to be called. See HOOKS below
 	for more information
 	Example:
-	irc:register_hook("OnSend", function(line)
+	irc.register_hook("OnSend", function(line)
 		print("SEND: "..line)
 	end)
 
@@ -83,7 +83,7 @@ not modify these settings at runtime or you might crash the server!
 Hooks
 -----
 
-The `irc:register_hook` function can register functions to be called
+The `irc.register_hook` function can register functions to be called
 when some events happen. The events supported are the same as the LuaIRC
 ones with a few added (mostly for internal use).
 See src/LuaIRC/doc/irc.luadoc for more information.

botcmds.lua

@@ -15,7 +15,7 @@ local function nickequals(nick1, nick2)
 	return irclower(nick1) == irclower(nick2)
 end
 
-function irc:check_botcmd(msg)
+function irc.check_botcmd(msg)
 	local prefix = irc.config.command_prefix
 	local nick = irc.conn.nick
 	local text = msg.args[2]
@@ -25,34 +25,34 @@ function irc:check_botcmd(msg)
 	-- First check for a nick prefix
 	if nickequals(nickpart, nick)
 			and (suffix == ": " or suffix == ", ") then
-		self:bot_command(msg, text:sub(#nick + 3))
+		irc.bot_command(msg, text:sub(#nick + 3))
 		return true
 	-- Then check for the configured prefix
 	elseif prefix and text:sub(1, #prefix):lower() == prefix:lower() then
-		self:bot_command(msg, text:sub(#prefix + 1))
+		irc.bot_command(msg, text:sub(#prefix + 1))
 		return true
 	end
 	return false
 end
 
 
-function irc:bot_command(msg, text)
+function irc.bot_command(msg, text)
 	-- Remove leading whitespace
 	text = text:match("^%s*(.*)")
 	if text:sub(1, 1) == "@" then
 		local _, _, player_to, message = text:find("^.([^%s]+)%s(.+)$")
 		if not player_to then
 			return
 		elseif not minetest.get_player_by_name(player_to) then
-			irc:reply("User '"..player_to.."' is not in the game.")
+			irc.reply("User '"..player_to.."' is not in the game.")
 			return
 		elseif not irc.joined_players[player_to] then
-			irc:reply("User '"..player_to.."' is not using IRC.")
+			irc.reply("User '"..player_to.."' is not using IRC.")
 			return
 		end
 		minetest.chat_send_player(player_to,
 				"PM from "..msg.user.nick.."@IRC: "..message, false)
-		irc:reply("Message sent!")
+		irc.reply("Message sent!")
 		return
 	end
 	local pos = text:find(" ", 1, true)
@@ -65,36 +65,36 @@ function irc:bot_command(msg, text)
 		args = ""
 	end
 
-	if not self.bot_commands[cmd] then
-		self:reply("Unknown command '"..cmd.."'. Try 'help'."
+	if not irc.bot_commands[cmd] then
+		irc.reply("Unknown command '"..cmd.."'. Try 'help'."
 			.." Or use @playername <message> to send a private message")
 		return
 	end
 
-	local _, message = self.bot_commands[cmd].func(msg.user, args)
+	local _, message = irc.bot_commands[cmd].func(msg.user, args)
 	if message then
-		self:reply(message)
+		irc.reply(message)
 	end
 end
 
 
-function irc:register_bot_command(name, def)
+function irc.register_bot_command(name, def)
 	if (not def.func) or (type(def.func) ~= "function") then
 		error("Erroneous bot command definition. def.func missing.", 2)
 	elseif name:sub(1, 1) == "@" then
 		error("Erroneous bot command name. Command name begins with '@'.", 2)
 	end
-	self.bot_commands[name] = def
+	irc.bot_commands[name] = def
 end
 
 
-irc:register_bot_command("help", {
+irc.register_bot_command("help", {
 	params = "<command>",
 	description = "Get help about a command",
-	func = function(user, args)
+	func = function(_, args)
 		if args == "" then
 			local cmdlist = { }
-			for name, cmd in pairs(irc.bot_commands) do
+			for name in pairs(irc.bot_commands) do
 				cmdlist[#cmdlist+1] = name
 			end
 			return true, "Available commands: "..table.concat(cmdlist, ", ")
@@ -116,20 +116,20 @@ irc:register_bot_command("help", {
 })
 
 
-irc:register_bot_command("list", {
+irc.register_bot_command("list", {
 	params = "",
 	description = "List available commands.",
-	func = function(user, args)
+	func = function()
 		return false, "The `list` command has been merged into `help`."
 				.." Use `help` with no arguments to get a list."
 	end
 })
 
 
-irc:register_bot_command("whereis", {
+irc.register_bot_command("whereis", {
 	params = "<player>",
 	description = "Tell the location of <player>",
-	func = function(user, args)
+	func = function(_, args)
 		if args == "" then
 			return false, "Player name required."
 		end
@@ -145,9 +145,9 @@ irc:register_bot_command("whereis", {
 
 
 local starttime = os.time()
-irc:register_bot_command("uptime", {
+irc.register_bot_command("uptime", {
 	description = "Tell how much time the server has been up",
-	func = function(user, args)
+	func = function()
 		local cur_time = os.time()
 		local diff = os.difftime(cur_time, starttime)
 		local fmt = "Server has been running for %d:%02d:%02d"
@@ -160,9 +160,9 @@ irc:register_bot_command("uptime", {
 })
 
 
-irc:register_bot_command("players", {
+irc.register_bot_command("players", {
 	description = "List the players on the server",
-	func = function(user, args)
+	func = function()
 		local players = minetest.get_connected_players()
 		local names = {}
 		for _, player in pairs(players) do

callback.lua

@@ -5,15 +5,15 @@
 minetest.register_on_joinplayer(function(player)
 	local name = player:get_player_name()
 	if irc.connected and irc.config.send_join_part then
-		irc:say("*** "..name.." joined the game")
+		irc.say("*** "..name.." joined the game")
 	end
 end)
 
 
 minetest.register_on_leaveplayer(function(player, timed_out)
 	local name = player:get_player_name()
 	if irc.connected and irc.config.send_join_part then
-		irc:say("*** "..name.." left the game"..
+		irc.say("*** "..name.." left the game"..
 				(timed_out and " (Timed out)" or ""))
 	end
 end)
@@ -31,11 +31,11 @@ minetest.register_on_chat_message(function(name, message)
 	if nl then
 		message = message:sub(1, nl - 1)
 	end
-	irc:say(irc:playerMessage(name, message))
+	irc.say(irc.playerMessage(name, message))
 end)
 
 
 minetest.register_on_shutdown(function()
-	irc:disconnect("Game shutting down.")
+	irc.disconnect("Game shutting down.")
 end)
 

chatcmds.lua

@@ -20,7 +20,7 @@ minetest.register_chatcommand("irc_msg", {
 		local toname_l = toname:lower()
 		local validNick = false
 		local hint = "They have to be in the channel"
-		for nick, user in pairs(irc.conn.channels[irc.config.channel].users) do
+		for nick in pairs(irc.conn.channels[irc.config.channel].users) do
 			if nick:lower() == toname_l then
 				validNick = true
 				break
@@ -33,7 +33,7 @@ minetest.register_chatcommand("irc_msg", {
 		if not validNick then
 			return false, "You can not message that user. ("..hint..")"
 		end
-		irc:say(toname, irc:playerMessage(name, message))
+		irc.say(toname, irc.playerMessage(name, message))
 		return true, "Message sent!"
 	end
 })
@@ -42,13 +42,13 @@ minetest.register_chatcommand("irc_msg", {
 minetest.register_chatcommand("irc_names", {
 	params = "",
 	description = "List the users in IRC.",
-	func = function(name, params)
+	func = function()
 		if not irc.connected then
 			return false, "Not connected to IRC. Use /irc_connect to connect."
 		end
 		local users = { }
-		for k, v in pairs(irc.conn.channels[irc.config.channel].users) do
-			table.insert(users, k)
+		for nick in pairs(irc.conn.channels[irc.config.channel].users) do
+			table.insert(users, nick)
 		end
 		return true, "Users in IRC: "..table.concat(users, ", ")
 	end
@@ -58,12 +58,12 @@ minetest.register_chatcommand("irc_names", {
 minetest.register_chatcommand("irc_connect", {
 	description = "Connect to the IRC server.",
 	privs = {irc_admin=true},
-	func = function(name, param)
+	func = function(name)
 		if irc.connected then
 			return false, "You are already connected to IRC."
 		end
 		minetest.chat_send_player(name, "IRC: Connecting...")
-		irc:connect()
+		irc.connect()
 	end
 })
 
@@ -79,21 +79,21 @@ minetest.register_chatcommand("irc_disconnect", {
 		if param == "" then
 			param = "Manual disconnect by "..name
 		end
-		irc:disconnect(param)
+		irc.disconnect(param)
 	end
 })
 
 
 minetest.register_chatcommand("irc_reconnect", {
 	description = "Reconnect to the IRC server.",
 	privs = {irc_admin=true},
-	func = function(name, param)
+	func = function(name)
 		if not irc.connected then
 			return false, "Not connected to IRC. Use /irc_connect to connect."
 		end
 		minetest.chat_send_player(name, "IRC: Reconnecting...")
-		irc:disconnect("Reconnecting...")
-		irc:connect()
+		irc.disconnect("Reconnecting...")
+		irc.connect()
 	end
 })
 
@@ -106,7 +106,7 @@ minetest.register_chatcommand("irc_quote", {
 		if not irc.connected then
 			return false, "Not connected to IRC. Use /irc_connect to connect."
 		end
-		irc:queue(param)
+		irc.queue(param)
 		minetest.chat_send_player(name, "Command sent!")
 	end
 })
@@ -115,7 +115,7 @@ minetest.register_chatcommand("irc_quote", {
 local oldme = minetest.chatcommands["me"].func
 -- luacheck: ignore
 minetest.chatcommands["me"].func = function(name, param, ...)
-	irc:say(("* %s %s"):format(name, param))
+	irc.say(("* %s %s"):format(name, param))
 	return oldme(name, param, ...)
 end
 
@@ -127,7 +127,7 @@ if irc.config.send_kicks and minetest.chatcommands["kick"] then
 		if not plname then
 			return false, "Usage: /kick player [reason]"
 		end
-		irc:say(("*** Kicked %s.%s"):format(name,
+		irc.say(("*** Kicked %s.%s"):format(name,
 				reason~="" and " Reason: "..reason or ""))
 		return oldkick(name, param, ...)
 	end