Type Method

fileSafeURL(_:)

Patch path components for writing to the file system.

static func fileSafeURL(_ url: URL) -> URL

Discussion

We replace path unsafe characters when generating DocC references. When writing files on disk, however, and or hosting those files in a web environment there might be more complex rules for “safe” paths beyond simply replacing a set of characters. For example a period is a safe character but when a file path component starts with a period that might be problematic when hosted on a generic web server.