dotnet/roslyn

SyntaxGenerator removes DisabledTextTrivia even with "KeepDirectives" is specified

Open

#21,122 opened on Jul 25, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-IDEBughelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Consider the following code:

#if SomethingNotSet
    this is disabled code
#endif

    SomeCode();

If you use SyntaxGenerator to remove the "SomeCode();" statement and you specify that you want to keep leading directives, you get the following:

#if SomethingNotSet
#endif

This seems pretty broken. Keeping directives is so that the directives will not be touched and the code will retain its meaning. Here though we remove the DisabledText breaking the intent.

Contributor guide

Research direction
Look at SyntaxGenerator.RemoveNode and trace how it handles trivia, specifically the path where KeepDirectives is true. Check for any logic that removes DisabledTextTrivia incorrectly.
Tech stack
csharp
Domain
compilersdeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#GitRoslyn basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55