krzysztofzablocki/Sourcery

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

Open

#500 创建于 2018年1月23日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Swift (7,973 star) (633 fork)batch import
enhancementhelp wanted

描述

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?

贡献者指南

技术栈
swift
领域
tooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Swift preprocessor directivesSourceKitten frameworkSourcery codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.