[SR-13619] Using SwiftSyntax to parse a definition file, results in unknown declarations about swift-syntax HOT 6 CLOSED

@swift-ci create

from swift-syntax.

As you also pointed out the interface generation source output is not valid syntax, it is intended for displaying-to-the-user purposes, not for consumption by tools.

Could you clarify what exactly you are trying to achieve? We may be able to point you to another direction.

from swift-syntax.

Comment by Javier (JIRA)

Thanks Argyrios. Yes you're right, that's why I was hesitant to catalog the issue as a bug. I work on the documentation of a framework (SwiftUI). I use SwiftSyntax to extract every method, property, initializer and protocol from the SwiftUI definition file generated by Xcode, in order to create the Table of Contents of my documentation.

This is not a big issue for me. To work around it, previous to parsing, I automatically edit the definition file and change all occurrences of:

{ get nonmutating set }

with

{ get /* nonmutating set */ }

from swift-syntax.

You should find useful the `swift-symbolgraph-extract` tool, part of Xcode 12/swift 5.3 toolchain. It outputs a json file that describes the API and documentation of a module. See a possible use for it in jazzy: realm/jazzy#1171

Feel free to ask questions about it in the forums.

from swift-syntax.

Comment by Javier (JIRA)

Thanks a lot for the pointer, that did not exist when I originally implemented my solution using SwiftSyntax. I performed a quick test and it looks promising (although a lot, lot, lot slower). I'll keep it in mind for a future rewrite of my extractor. For the time being, I'll keep using SwiftSyntax. The only unknown declarations I get are those mentioned, but they can be easily workaround. Thanks again for your help!

from swift-syntax.

AFAICT the issue appears to be resolved, so I’m closing this issue. Please re-open it if you don’t agree.

from swift-syntax.