This repository was archived by the owner on Jul 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 245
Added a rule to remove #region/#endregion directives. #194
Open
jakesays-old
wants to merge
3
commits into
dotnet:main
Choose a base branch
from
jakesays-old:RegionRemoval
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
src/Microsoft.DotNet.CodeFormatting.Tests/Rules/RemoveRegionsTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using Xunit; | ||
|
||
namespace Microsoft.DotNet.CodeFormatting.Tests | ||
{ | ||
public class RemoveRegionsTests : SyntaxRuleTestBase | ||
{ | ||
internal override ISyntaxFormattingRule Rule | ||
{ | ||
get | ||
{ | ||
return new Rules.RemoveRegionsRule(); | ||
} | ||
} | ||
|
||
[Fact] | ||
public void TestRemoveRegions() | ||
{ | ||
var text = @" | ||
#region Region 1 | ||
|
||
//comment | ||
#endregion Region 1 | ||
|
||
class WithRegions | ||
{ | ||
#region have region here | ||
public static void DoNothing() | ||
{ | ||
#region inside method | ||
|
||
#endregion inside method | ||
} | ||
#endregion | ||
} | ||
"; | ||
var expected = @" | ||
|
||
//comment | ||
|
||
class WithRegions | ||
{ | ||
public static void DoNothing() | ||
{ | ||
|
||
} | ||
} | ||
"; | ||
Verify(text, expected); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
src/Microsoft.DotNet.CodeFormatting/Rules/RemoveRegionsRule.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
// Copyright(c) Microsoft.All rights reserved. | ||
// Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
||
using System.Collections.Generic; | ||
using System.Linq; | ||
using Microsoft.CodeAnalysis; | ||
using Microsoft.CodeAnalysis.CSharp; | ||
using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
|
||
namespace Microsoft.DotNet.CodeFormatting.Rules | ||
{ | ||
[SyntaxRule(RemoveRegionsRule.Name, RemoveRegionsRule.Description, SyntaxRuleOrder.RemoveRegionsRule, DefaultRule = false)] | ||
internal sealed class RemoveRegionsRule : CSharpOnlyFormattingRule, ISyntaxFormattingRule | ||
{ | ||
internal const string Name = "RemoveRegions"; | ||
internal const string Description = "Removes all regions"; | ||
|
||
public SyntaxNode Process(SyntaxNode targetNode, string languageName) | ||
{ | ||
var finder = new RegionFinder(); | ||
finder.Visit(targetNode); | ||
var results = finder.Results; | ||
|
||
if (results.Count > 0) | ||
{ | ||
return targetNode.ReplaceTrivia(results, | ||
(arg1, arg2) => new SyntaxTrivia()); | ||
} | ||
return targetNode; | ||
} | ||
|
||
private class RegionFinder : CSharpSyntaxWalker | ||
{ | ||
public List<SyntaxTrivia> Results { get; } = new List<SyntaxTrivia>(); | ||
|
||
public RegionFinder() | ||
: base(SyntaxWalkerDepth.StructuredTrivia) | ||
{ | ||
} | ||
|
||
public override void VisitRegionDirectiveTrivia(RegionDirectiveTriviaSyntax node) | ||
{ | ||
Results.Add(node.ParentTrivia); | ||
} | ||
|
||
public override void VisitEndRegionDirectiveTrivia(EndRegionDirectiveTriviaSyntax node) | ||
{ | ||
Results.Add(node.ParentTrivia); | ||
} | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.