FrigaT/SQLLint
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

Изменено формирование ошибок на темплейты

Browse Source
This commit is contained in:
FrigaT
2025-12-26 21:52:27 +03:00
parent 3c2ee7f9a7
commit 4a0e9d7d6b
12 changed files with 52 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
SQLLinter/Common/BaseRuleVisitor.cs
View File

@@ -55,14 +55,14 @@ public abstract class BaseRuleVisitor : TSqlFragmentVisitor, IRule
_violations.Add(violation);
}
protected void AddViolation(string RuleName, string Message, int Line, int Column)
protected void AddViolation(string RuleName, string Template, int Line, int Column, params string[] param)
{
_violations.Add(new(RuleName, Message, Line, Column));
_violations.Add(new(RuleName, Template, Line, Column, param));
}
protected void AddViolation(TSqlFragment node, params string[] param)
{
AddViolation(Name, this.GetText(param), GetLineNumber(node), GetColumnNumber(node));
_violations.Add(new(this.Name, this.Text, GetLineNumber(node), GetColumnNumber(node), param));
}
protected string GetText(params string[] param)

2
SQLLinter/Common/IReporter.cs
View File

@@ -4,5 +4,5 @@ public interface IReporter : IBaseReporter
{
void ReportViolation(IRuleViolation violation);
void ReportViolation(string fileName, int line, int column, RuleViolationSeverity severity, string ruleName, string violationText);
void ReportViolation(string fileName, int line, int column, RuleViolationSeverity severity, string ruleName, string template, params string[] param);
}

2
SQLLinter/Common/Violation.cs
View File

@@ -1,4 +1,4 @@
namespace SQLLinter.Common
{
public record Violation(string RuleName, string Message, int Line, int Column);
public record Violation(string RuleName, string Template, int Line, int Column, string[] Params);
}

12
SQLLinter/Infrastructure/Parser/SqlRuleVisitor.cs
View File

@@ -76,7 +76,7 @@ public class SqlRuleVisitor : IRuleVisitor
}
}
violations.ForEach(t => _reporter.ReportViolation(filePath, t.Line, t.Column, rule.Severity, t.RuleName, t.Message));
violations.ForEach(t => _reporter.ReportViolation(filePath, t.Line, t.Column, rule.Severity, t.RuleName, t.Template, t.Params));
}
private static bool VisitorIsBlackListedForDynamicSql(IRule visitor)
@@ -109,7 +109,15 @@ public class SqlRuleVisitor : IRuleVisitor
if (!globalRulesOnLine.Any())
{
_reporter.ReportViolation(new RuleViolation(sqlPath, "invalid-syntax", error.Message, error.Line, error.Column, RuleViolationSeverity.Critical));
_reporter.ReportViolation(new RuleViolation()
{
FileName = sqlPath,
RuleName = "invalid-syntax",
Text = error.Message,
Line = error.Line,
Column = error.Column,
Severity = RuleViolationSeverity.Critical
});
if (updatedExitCode)
{
continue;

22
SQLLinter/Infrastructure/Reporters/Reporter.cs
View File

@@ -7,15 +7,22 @@ namespace SQLLinter.Infrastructure.Reporters;
public class Reporter : IReporter
{
private readonly List<string> _log = new();
private readonly bool _useLogging;
public int? FixedCount { get; set; }
private readonly ConcurrentBag<IRuleViolation> ruleViolations = new();
public List<IRuleViolation> Violations => ruleViolations.ToList();
public Reporter(bool useLogging = false)
{
_useLogging = useLogging;
}
public virtual void Report(string message)
{
_log.Add(message);
if (_useLogging) _log.Add(message);
}
public List<string> GetLog() => _log;
@@ -34,8 +41,17 @@ public class Reporter : IReporter
Report(violation.ToString());
}
public void ReportViolation(string fileName, int line, int column, RuleViolationSeverity severity, string ruleName, string violationText)
public void ReportViolation(string fileName, int line, int column, RuleViolationSeverity severity, string ruleName, string template, params string[] param)
{
ReportViolation(new RuleViolation(fileName, ruleName, violationText, line, column, severity));
ReportViolation(new RuleTemplateViolation()
{
FileName = fileName,
RuleName = ruleName,
RuleTemplate = template,
Line = line,
Column = column,
Severity = severity,
Params = param.ToList(),
});
}
}

2
SQLLinter/Infrastructure/Rules/ConditionalBeginEndRule.cs
View File

@@ -19,7 +19,7 @@ public class ConditionalBeginEndRule : BaseRuleVisitor, IRule
{
if (node.ThenStatement is not BeginEndBlockStatement)
{
AddViolation(Name, Text, GetLineNumber(node), GetColumnNumber(node));
AddViolation(node);
}
if (node.ElseStatement != null && node.ElseStatement is not BeginEndBlockStatement && node.ElseStatement is not IfStatement)

2
SQLLinter/Infrastructure/Rules/IndexHintRule.cs
View File

@@ -11,7 +11,7 @@ public class IndexHintRule : BaseRuleVisitor
{
if (node.HintKind == TableHintKind.Index)
{
AddViolation(Name, Text, GetLineNumber(node), GetColumnNumber(node));
AddViolation(node);
}
}
}

2
SQLLinter/Infrastructure/Rules/InsertValuesInsteadOfSelectRule.cs
View File

@@ -18,7 +18,7 @@ public class InsertValuesInsteadOfSelectRule : BaseRuleVisitor
// Если в SELECT нет таблиц (т.е. просто SELECT 1,2,3)
if (query.FromClause == null || query.FromClause.TableReferences.Count == 0)
{
AddViolation(Name, Text, GetLineNumber(node), GetColumnNumber(node));
AddViolation(node);
}
}
}

2
SQLLinter/Infrastructure/Rules/KeywordCapitalizationRule.cs
View File

@@ -33,7 +33,7 @@ public class KeywordCapitalizationRule : BaseRuleVisitor, IRule
var tabsOnLine = ColumnNumberCalculator.CountTabsBeforeToken(token.Line, index, node.ScriptTokenStream);
var column = ColumnNumberCalculator.GetColumnNumberBeforeToken(tabsOnLine, token);
AddViolation(Name, GetText(token.Text), GetLineNumber(token), column + dynamicSQLAdjustment);
AddViolation(Name, Text, GetLineNumber(token), column + dynamicSQLAdjustment, token.Text);
}
}

2
SQLLinter/Infrastructure/Rules/MultiTableAliasRule.cs
View File

@@ -34,7 +34,7 @@ public class MultiTableAliasRule : BaseRuleVisitor, IRule
tableName = SQLHelpers.ObjectGetFullName(namedTable.SchemaObject);
}
AddViolation(Name, GetText(tableName), GetLineNumber(childNode), column + dynamicSqlAdjustment);
AddViolation(Name, Text, GetLineNumber(childNode), column + dynamicSqlAdjustment, tableName);
}
var childTableJoinVisitor = new ChildTableJoinVisitor();

2
SQLLinter/Infrastructure/Rules/ProcedureLoggingRule.cs
View File

@@ -79,7 +79,7 @@ public class ProcedureLoggingReturnRule : BaseRuleVisitor
if ((hasDebugLog || hasLabelFinish) || hasReturn)
{
returnPositions.ForEach(t => AddViolation(Name, GetText(name), t.Line, t.Column));
returnPositions.ForEach(t => AddViolation(Name, Text, t.Line, t.Column, name));
}
}

45
SQLLinter/Infrastructure/Rules/RuleViolations/RuleViolation.cs
View File

@@ -4,46 +4,25 @@ namespace SQLLinter.Infrastructure.Rules.RuleViolations
{
public class RuleViolation : IRuleViolation
{
public RuleViolation(string fileName, string ruleName, string text, int startLine, int startColumn, RuleViolationSeverity severity)
{
FileName = fileName;
RuleName = ruleName;
Text = text;
Line = startLine;
Column = startColumn;
Severity = severity;
}
required public string FileName { get; init; }
public RuleViolation(string fileName, string ruleName, int startLine, int startColumn)
{
FileName = fileName;
RuleName = ruleName;
Line = startLine;
Column = startColumn;
}
required public int Column { get; set; }
public RuleViolation(string ruleName, int startLine, int startColumn)
{
RuleName = ruleName;
Line = startLine;
Column = startColumn;
}
required public int Line { get; set; }
public int Column { get; set; }
required public string RuleName { get; init; }
public string FileName { get; set; }
required public RuleViolationSeverity Severity { get; init; }
public int Line { get; set; }
virtual public string Text { get; set; }
}
public string RuleName { get; set; }
public class RuleTemplateViolation : RuleViolation
{
override public string Text => string.Format(RuleTemplate, Params.ToArray());
public RuleViolationSeverity Severity { get; set; }
required public string RuleTemplate { get; init; }
public string Text { get; set; }
public override string ToString()
{
return $@"{Severity.ToString().ToUpper()}: L{Line} C{Column} {FileName} ""{Text}""";
}
public List<string> Params { get; set; } = new();
}
}