krzysztofzablocki/Sourcery

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

Open

#500 opened on 2018年1月23日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Swift (7,973 stars) (633 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.