Skip to content

Make PragmaScope a no-op for empty warning lists to prevent global warning suppression leakage #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matt-edmondson merged 2 commits into from
Sep 13, 2026
Merged

Make PragmaScope a no-op for empty warning lists to prevent global warning suppression leakage #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2eb521d
Initial plan
Copilot Sep 13, 2026
feb76d1
Handle empty PragmaScope warning lists as no-op
Copilot Sep 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CodeBlocker.Test/ScopesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,39 @@ public void PragmaScopeJoinsSeveralWarnings()
codeBlocker.ToString());
}

[TestMethod]
public void PragmaScopeWithAnEmptyStringIsANoOp()
{
using CodeBlocker codeBlocker = Create();

using (new PragmaScope(codeBlocker, ""))
{
codeBlocker.WriteLine("public int Value;");
}

Assert.AreEqual("public int Value;\n", codeBlocker.ToString());
}

[TestMethod]
public void PragmaScopeWithAnEmptyWarningSequenceDoesNotAffectAnOuterScope()
{
using CodeBlocker codeBlocker = Create();

using (new PragmaScope(codeBlocker, "CS1591"))
{
using (new PragmaScope(codeBlocker, []))
{
codeBlocker.WriteLine("public int X;");
}

codeBlocker.WriteLine("public int Y;");
}

Assert.AreEqual(
"#pragma warning disable CS1591\npublic int X;\npublic int Y;\n#pragma warning restore CS1591\n",
codeBlocker.ToString());
}

[TestMethod]
public void ScopesOfMixedKindsNestCorrectly()
{
Expand Down
13 changes: 12 additions & 1 deletion CodeBlocker/Scopes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,8 @@ private static void End(CodeBlocker codeBlocker)
/// <param name="codeBlocker">The parent <see cref="CodeBlocker"/>.</param>
/// <param name="warnings">
/// The warning identifiers to suppress, written verbatim after the directive — either a single
/// identifier such as <c>CS1591</c> or a comma-separated list.
/// identifier such as <c>CS1591</c> or a comma-separated list. Empty or whitespace warnings are a
/// no-op and emit no directives.
/// </param>
public class PragmaScope(CodeBlocker codeBlocker, string warnings)
: ScopedAction(onOpen: () => Begin(codeBlocker, warnings), onClose: () => End(codeBlocker, warnings))
Expand All @@ -177,12 +178,22 @@ public PragmaScope(CodeBlocker codeBlocker, IEnumerable<string> warnings)
private static void Begin(CodeBlocker codeBlocker, string warnings)
{
Ensure.NotNull(codeBlocker);
if (string.IsNullOrWhiteSpace(warnings))
{
return;
}

codeBlocker.WriteLine($"#pragma warning disable {warnings}");
}

private static void End(CodeBlocker codeBlocker, string warnings)
{
Ensure.NotNull(codeBlocker);
if (string.IsNullOrWhiteSpace(warnings))
{
return;
}

codeBlocker.WriteLine($"#pragma warning restore {warnings}");
}
}