Add command to create a Swift DocC documentation catalog #2006
Conversation
amanthatdoescares
requested review from
0xTim,
adam-fowler and
award999
as code owners
matthewbastien
left a comment
matthewbastien
left a comment
There was a problem hiding this comment.
Thank you for this PR! There are a few issues that need to be resolved before this can be merged.
Co-authored-by: Matthew Bastien <[email protected]>
Co-authored-by: Matthew Bastien <[email protected]>
|
|
||
| if (hasPackageSwift) { | ||
| try { | ||
| const { stdout } = await execFileAsync("swift", ["package", "dump-package"], { |
There was a problem hiding this comment.
This information is already computed and stored on the folderContext.swiftPackage for each Swift Package folder open in the workspace. See https://github.com/swiftlang/vscode-swift/blob/main/src/commands.ts#L80 for a reference of how to get the folderContext for the currently active folder and pass it in to the command.
There was a problem hiding this comment.
Thanks for pointing this out — I wasn’t aware this information was already available via FolderContext. I’ll refactor the command to use folderContext.swiftPackage instead of invoking swift package dump-package.
| for (const name of targets) { | ||
| const srcPath = path.join(rootPath, "Sources", name); | ||
| try { | ||
| await fs.access(srcPath); |
There was a problem hiding this comment.
you can use fileExists in utilities/filesystem instead
There was a problem hiding this comment.
once i read filesystem i think folderExists is much more accurate in this case
There was a problem hiding this comment.
fileExists() and folderExists() check for the path in question to be a file or folder respectively. You're going to want to use pathExists() because you can't create the folder if anything exists at that path regardless of whether or not it is a file, folder, symlink, etc.
|
|
||
| const doccDir = path.join(basePath, `${value}.docc`); | ||
| try { | ||
| await fs.access(doccDir); |
There was a problem hiding this comment.
fileExists here as well
There was a problem hiding this comment.
i think folderExists is much accurate here
There was a problem hiding this comment.
You'll have to use pathExists().
|
I'd also like to have an integration test for this since the logic will be interacting with the |
4 participants
Description
This change adds a new Swift command that helps users get started with DocC documentation.
The command prompts for a module name and creates a basic DocC catalog in the workspace, including:
<Module>.doccdirectoryThis removes the need to manually set up the DocC folder structure and makes it easier to start documenting Swift packages directly from VS Code.
Issue: #1647
Tasks