krzysztofzablocki/Sourcery

Ignore code marked as such by the preprocessor / Swift Active Compilation Conditions

Open

#500 opened on Jan 23, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Swift (7,973 stars) (633 forks)batch import
enhancementhelp wanted

Description

Many projects use swift preprocessor directives / active compilation conditions to enable conditional compilation. (e.g. lines surrounded by an if/ifdef/ifndef directive that should only compile when their condition – usually an environment variable – evaluates to true.)

As far as I can tell, Sourcery appears not to be aware of these markers and therefore blocks of code marked to be ignored are still processed by Sourcery – leading to compilation errors.

Searching the source code I see that the Source Kitten dependency may expose those lines of code which should be ignored so this may be something that could be added relatively simply?

Contributor guide

Tech stack
swift
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
mostly clear
Prerequisites
Swift preprocessor directivesSourceKitten frameworkSourcery codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how SourceKitten exposes preprocessor conditional compilation regions, particularly the clang c/Index.h line 624 referenced in the issue. Examine Sourcery's existing parsing pipeline to determine where to add filtering of code blocks that are inactive under current compilation conditions. Look at any comments in the issue for suggested approaches or maintainer input, and review similar features in other Swift code generation tools.