add severity levels and fix some issues with path not being correct in diagnostics

Author: CapsAdmin

nattlua/analyzer/base/error_handling.lua

@@ -1,4 +1,5 @@
 local table = _G.table
+local table_insert = table.insert
 local type = type
 local ipairs = ipairs
 local tostring = tostring
@@ -89,7 +90,8 @@ return function(META--[[#: any]])
 
 	function META:ReportDiagnostic(
 		msg--[[#: {reasons = {[number] = string}} | {[number] = string}]],
-		severity--[[#: "warning" | "error"]],
+		severity--[[#: "warning" | "error" | "fatal"]],
+		level--[[#: number | nil]],
 		node--[[#: any]],
 		code--[[#: any]],
 		start--[[#: number]],
@@ -109,6 +111,18 @@ return function(META--[[#: any]])
 
 		local msg_str = error_messages.ErrorMessageToString(msg)
 
+		if
+			not _G.TEST and
+			severity == "error" and
+			(
+				msg_str:find("does not exist", nil, true) or
+				msg_str:find("has no key", nil, true)
+			)
+		then
+			severity = "warning"
+			level = 1
+		end
+
 		if self.processing_deferred_calls then
 			msg_str = "DEFERRED CALL: " .. msg_str
 		end
@@ -129,7 +143,16 @@ return function(META--[[#: any]])
 		end
 
 		do
-			local key = msg_str .. "-" .. "severity" .. start .. "-" .. stop
+			local key = msg_str .. "-" .. (
+					severity or
+					"error"
+				) .. "-" .. (
+					start or
+					0
+				) .. "-" .. (
+					stop or
+					0
+				)
 			self.diagnostics_map = self.diagnostics_map or {}
 
 			if self.diagnostics_map[key] then return end
@@ -138,10 +161,10 @@ return function(META--[[#: any]])
 		end
 
 		if self.OnDiagnostic and not self:IsTypeProtectedCall() then
-			self:OnDiagnostic(code, msg_str, severity, start, stop, node)
+			self:OnDiagnostic(code, msg_str, severity, start, stop, node, level)
 		end
 
-		table.insert(
+		table_insert(
 			self.diagnostics,
 			{
 				node = node,
@@ -150,6 +173,7 @@ return function(META--[[#: any]])
 				stop = stop,
 				msg = msg_str,
 				severity = severity,
+				level = level,
 				traceback = callstack.traceback(),
 				protected_call = self:IsTypeProtectedCall(),
 			}
@@ -172,19 +196,55 @@ return function(META--[[#: any]])
 		end
 	end
 
-	function META:Error(msg, node)
+	function META:Error(msg, level_or_node, node)
+		local level
+
+		if type(level_or_node) == "number" then
+			level = level_or_node
+		else
+			node = level_or_node
+		end
+
 		node = node or self:GetCurrentExpression() or self:GetCurrentStatement()
-		self:ReportDiagnostic(msg, "error", node, node.Code, node:GetStartStop())
+		local start, stop = 0, 0
+
+		if node then start, stop = node:GetStartStop() end
+
+		self:ReportDiagnostic(msg, "error", level, node, node and node.Code, start, stop)
 	end
 
-	function META:Warning(msg, node)
+	function META:Warning(msg, level_or_node, node)
+		local level
+
+		if type(level_or_node) == "number" then
+			level = level_or_node
+		else
+			node = level_or_node
+		end
+
 		node = node or self:GetCurrentExpression() or self:GetCurrentStatement()
-		self:ReportDiagnostic(msg, "warning", node, node.Code, node:GetStartStop())
+		local start, stop = 0, 0
+
+		if node then start, stop = node:GetStartStop() end
+
+		self:ReportDiagnostic(msg, "warning", level, node, node and node.Code, start, stop)
 	end
 
-	function META:FatalError(msg)
-		local node = self:GetCurrentExpression() or self:GetCurrentStatement()
-		self:ReportDiagnostic(msg, "fatal", node, node.Code, node:GetStartStop())
+	function META:FatalError(msg, level_or_node, node)
+		local level
+
+		if type(level_or_node) == "number" then
+			level = level_or_node
+		else
+			node = level_or_node
+		end
+
+		local node = node or self:GetCurrentExpression() or self:GetCurrentStatement()
+		local start, stop = 0, 0
+
+		if node then start, stop = node:GetStartStop() end
+
+		self:ReportDiagnostic(msg, "fatal", level, node, node and node.Code, start, stop)
 		error(msg, 2)
 	end
 

nattlua/analyzer/operators/function_call_body.lua

@@ -476,14 +476,14 @@ return function(self, obj, input)
 					local node = function_node.identifiers[i + 1]
 
 					if node and not node.type_expression then
-						self:Warning(error_messages.untyped_argument(), node.type_expression)
+						self:Warning(error_messages.untyped_argument(), 2, node.type_expression or node)
 					end
 				elseif
 					function_node.identifiers[i] and
 					not function_node.identifiers[i].type_expression
 				then
 					if not obj:IsInputArgumentsInferred() then
-						self:Warning(error_messages.untyped_argument(), function_node.identifiers[i])
+						self:Warning(error_messages.untyped_argument(), 2, function_node.identifiers[i])
 					end
 				end
 			end

nattlua/cli/init.lua

@@ -30,8 +30,6 @@ local function parse_args(args, allowed_options)
 				val = loadstring("return " .. exp)()
 			end
 
-			print(arg, val)
-
 			if allowed_options and options[option] == nil then
 				error("unknown option " .. option)
 			end
@@ -100,6 +98,7 @@ config.commands["check"] = {
 	options = {
 		{name = "profile", description = "Run with profiler"},
 		{name = "error-only", description = "Only print errors, not warnings"},
+		{name = "show-severity", description = "Show severity level for warnings"},
 	},
 	cb = function(args, options, config, cli)
 		if options.profile then require("test.helpers.profiler").Start() end
@@ -108,6 +107,8 @@ config.commands["check"] = {
 		local cmp = {}
 		local entry_point = nil
 
+		if options["show-severity"] then config.analyzer.show_severity = true end
+
 		if #args == 1 and args[1] == "-" then
 			cmp[1] = Compiler.New(assert(io.read("*all")), "stdin-", config)
 		elseif #args == 0 and config.entry_point then
@@ -124,9 +125,9 @@ config.commands["check"] = {
 		for _, cmp in ipairs(cmp) do
 			if options["error-only"] then
 				local original_OnDiagnostic = cmp.OnDiagnostic
-				cmp.OnDiagnostic = function(self, code, msg, severity, ...)
+				cmp.OnDiagnostic = function(self, code, msg, severity, start, stop, node, level)
 					if severity == "error" or severity == "fatal" then
-						return original_OnDiagnostic(self, code, msg, severity, ...)
+						return original_OnDiagnostic(self, code, msg, severity, start, stop, node, level)
 					end
 				end
 			end

nattlua/compiler.lua

@@ -64,12 +64,10 @@ function META:__tostring()
 	return str
 end
 
-function META:OnDiagnostic(code, msg, severity, start, stop, node, ...)
-	local t = 0
+function META:OnDiagnostic(code, msg, severity, start, stop, node, level, ...)
+	local t = #self.errors + 1
 	msg = stringx.replace(msg, " because ", "\nbecause ")
-
-	if t > 0 then msg = "\n" .. msg end
-
+	msg = formating.FormatMessage(msg, ...)
 	local messages = {}
 
 	if self.analyzer then
@@ -90,19 +88,44 @@ function META:OnDiagnostic(code, msg, severity, start, stop, node, ...)
 					table.insert(messages, path .. ":" .. info.line_start .. ":" .. info.character_start)
 				else
 					for k, v in pairs(v.obj) do
-						print(k, v)
+
+					-- print(k, v)
 					end
 				end
 			end
 		end
 	end
 
-	table.insert(messages, formating.FormatMessage(msg, ...))
-	local msg = formating.BuildSourceCodePointMessage2(
-			code:GetString(),
+	local title = severity
+
+	if
+		level and
+		self.Config and
+		self.Config.analyzer and
+		self.Config.analyzer.show_severity
+	then
+		title = severity .. "(" .. level .. ")"
+	end
+
+	table.insert(messages, msg)
+	local str_code = "unknown code"
+	local path = "unknown path"
+
+	if code then
+		str_code = code:GetString()
+		path = code:GetName()
+	end
+
+	msg = formating.BuildSourceCodePointMessage2(
+			str_code,
 			start,
 			stop,
-			{path = code:GetName(), messages = messages, surrounding_line_count = 1}
+			{
+				path = path,
+				messages = messages,
+				surrounding_line_count = 1,
+				title = title,
+			}
 		) .. "\n"
 
 	if not NATTLUA_MARKDOWN_OUTPUT then
@@ -178,7 +201,7 @@ end
 function META:Lex()
 	local lexer = Lexer(self.Code, self.Config and self.Config.lexer)
 	lexer.OnError = function(lexer, code, msg, start, stop, ...)
-		self:OnDiagnostic(code, msg, "fatal", start, stop, nil, ...)
+		self:OnDiagnostic(code, msg, "fatal", start, stop, nil, nil, ...)
 	end
 	local ok, tokens = xpcall(function()
 		return lexer:GetTokens()
@@ -201,7 +224,7 @@ function META:Parse()
 
 	local parser = Parser(self.Tokens, self.Code, self.Config and self.Config.parser)
 	parser.OnError = function(parser, code, msg, start, stop, ...)
-		self:OnDiagnostic(code, msg, "fatal", start, stop, nil, ...)
+		self:OnDiagnostic(code, msg, "fatal", start, stop, nil, nil, ...)
 	end
 	parser.OnPreCreateNode = function(_, node)
 		self:OnPreCreateNode(node)
@@ -239,8 +262,8 @@ function META:Analyze(analyzer, ...)
 	analyzer = analyzer or Analyzer(self.Config and self.Config.analyzer)
 	analyzer.compiler = self
 	self.analyzer = analyzer
-	analyzer.OnDiagnostic = function(analyzer, ...)
-		self:OnDiagnostic(...)
+	analyzer.OnDiagnostic = function(analyzer, code, msg, severity, start, stop, node, level)
+		self:OnDiagnostic(code, msg, severity, start, stop, node, level)
 	end
 
 	if self.default_environment then
@@ -288,7 +311,7 @@ function META.New(
 	config--[[#: CompilerConfig]],
 	level--[[#: number | nil]]
 )
-	local path, line, name = callstack.get_path_line(level or 2)
+	local path, line, parent_name = callstack.get_path_line(level or 2)
 	path = path or "unknown name"
 	line = line or "unknown line"
 	name = name or path .. ":" .. line
@@ -305,7 +328,7 @@ function META.New(
 	return META.NewObject(
 		{
 			Code = Code(lua_code, name),
-			ParentSourceLine = parent_line,
+			ParentSourceLine = line,
 			ParentSourceName = parent_name,
 			Config = config or false,
 			Tokens = false,

nattlua/other/formating.lua

@@ -421,19 +421,17 @@ function formating.BuildSourceCodePointMessage2(
 			if #v > longest_line then longest_line = #v end
 		end
 
+		local total_len = longest_line - number_length - #SEPARATOR
+		local title = config.title or ""
+
+		if title ~= "" then title = "__" .. title .. "__" end
+
 		annotated[1] = (
 				" "
-			):rep(number_length + #SEPARATOR) .. (
+			):rep(number_length + #SEPARATOR) .. title .. (
 				"_"
-			):rep(longest_line - number_length - #SEPARATOR)
-		table.insert(
-			annotated,
-			(
-					" "
-				):rep(number_length + #SEPARATOR) .. (
-					"-"
-				):rep(longest_line - number_length - #SEPARATOR)
-		)
+			):rep(math.max(0, total_len - #title))
+		table.insert(annotated, (" "):rep(number_length + #SEPARATOR) .. ("-"):rep(total_len))
 	end
 
 	local header = config.show_line_numbers == false and