No documentation generated with Xcode 11 GM 1 and 2, Jazzy 0.11.1

[tyten]

Scenario

• macOS: 10.14.6
• Xcode: 11 GM 1 or 2
• Jazzy: 0.11.1

Command

bundle exec jazzy -c -o documentation --source-directory=SUBFOLDER\ with\ spaces

Result

Xcode 11

xcodebuild runs, with 0% coverage, documentation generated but nothing included.

Xcode 10.3

Behaves as expected

[jpsim]

Can you share the directory contents for where this is being run?

[tyten]

Without going into too much detail publicly, this framework repo has folder structure as follows (All Swift):

Root (where command is run)
⎣.git
⎣.gitignore
⎣Gemfile&lock
⎣README.md
⎣build
⎣documentation folder
⎣Demo App (folder)
⎣*Framework Folder* (--source-directory points here)
  ⎣build
  ⎣Framework Source Folder
    ⎣Components
    ⎣Extensions
    ⎣Protocols
    ⎣Resources
    ⎣Supporting Files
    ⎣View Controllers
  ⎣Framework.xcodeproj
  ⎣FrameworkTests Folder
⎣.xcworkspace
⎣Demo App.xcodeproj
⎣Tests Folder
⎣Random Other Folders

[johnfairh]

I think the workaround is to add -x USE_SWIFT_RESPONSE_FILE=NO to the jazzy args - there's a problem with our treatment of Xcode 11 swift response files with spaces (as you maybe hinted).

[strike65]

I have the same problem. After updating to Xcode 11 Jazzy doesn't work anymore. Unfortunately the tip doesn't help me. I am not even able to update to 0.11.1. I get the error message:

ERROR: Error installing jazzy:
ERROR: Failed to build gem native extension.
mkmf.rb can't find header files for ruby at /System/Library/Frameworks/Ruby.framework/Versions/2.3/usr/lib/ruby/include/ruby.h

Do you have any ideas?

System:
macOS 10.14.6
Ruby: 2.3.7
gem: 3.0.6
Xcode: 11 (11A420a)

[johnfairh]

@strike65 this is a different problem: you are using the Mojave system Ruby (2.3) but Xcode 11 has the development files for Catalina (2.6). Either switch back to Xcode 10.x to do the install or install an independent Ruby (eg. rbenv via carthage).

[tyten]

I can confirm that added flag makes it work with Xcode 11. Thanks so much.

[tyten]

Although it does look like it ended up ignoring an enum in one of my source files?

[tyten]

In this particular case, enums that are declared in a source file that also contains a class definition were documented. Enums that sat in their own source file were ignored.

[tyten]

According to the output while running, Jazzy didn't even parse it. Is parsed in Xcode 10.3 command line tools with the -x flag

[johnfairh]

The only times I've seen jazzy skip just one file from the parse list is when it somehow picks up an old build record that predates that file being added to the project. Escalating remedies: deleting build, adding -x clean,build, clearing out all DerivedDatas for the project.

If none of that works we'll have to dig into how Xcode11 xcodebuild is treating that file differently building the module.

[johnfairh]

Closing this one: main problem of no files at all being used when there are special characters in the path is fixed in master and 0.11.2. If the 'one file being ignored' problem persists we should track that in a new issue.

[dareknowak]

It's also worth to mention, that some of users might have missing headers. See: castwide/vscode-solargraph#78 (comment)