-
Notifications
You must be signed in to change notification settings - Fork 89
Add command to create a Swift DocC documentation catalog #2006
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
amanthatdoescares
wants to merge
14
commits into
swiftlang:main
Choose a base branch
from
amanthatdoescares:add-docc-command
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+215
−0
Open
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
43e2518
Add command to create Swift DocC documentation catalog
amanthatdoescares 81461d5
Add command to create Swift DocC documentation catalog
amanthatdoescares 6291552
restoring package-lock-json
amanthatdoescares 3277a02
Use async filesystem APIs, Included Copyright Headers, changed the va…
amanthatdoescares a528243
Validate Docc Catalog exisitance inside input
amanthatdoescares 62a4225
Ask user to select the workspace folder and validate docc name inline
amanthatdoescares 907fdfb
Update src/commands/createDocumentationCatalog.ts
amanthatdoescares 1a6fb2f
Update src/commands/createDocumentationCatalog.ts
amanthatdoescares 7343dae
Use async filesystem check
amanthatdoescares dd3533b
Add target-based QuickPick for DocC catalog creation
amanthatdoescares 3a1d262
Use folderExists for directory check
amanthatdoescares 3ec91e0
Using folderContext.swiftpackage
amanthatdoescares d74fb7c
Use pathExists for DocC creation checks
amanthatdoescares 3b8853c
Add integration test for createDocumentationCatalog command
amanthatdoescares File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| import * as fs from "fs"; | ||
amanthatdoescares marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| import * as path from "path"; | ||
| import * as vscode from "vscode"; | ||
|
|
||
| export async function createDocumentationCatalog(): Promise<void> { | ||
| const folders = vscode.workspace.workspaceFolders; | ||
| if (!folders || folders.length === 0) { | ||
| await vscode.window.showErrorMessage("Open a workspace first."); | ||
matthewbastien marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return; | ||
| } | ||
|
|
||
| const moduleName = await vscode.window.showInputBox({ | ||
| prompt: "Enter Swift module name", | ||
| placeHolder: "MyModule", | ||
| validateInput: value => | ||
| value.trim().length === 0 ? "Module name cannot be empty" : undefined, | ||
| }); | ||
|
|
||
| if (!moduleName) { | ||
| return; // user cancelled | ||
| } | ||
|
|
||
| const rootPath = folders[0].uri.fsPath; | ||
amanthatdoescares marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const doccDir = path.join(rootPath, `${moduleName}.docc`); | ||
matthewbastien marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const markdownFile = path.join(doccDir, `${moduleName}.md`); | ||
|
|
||
| if (fs.existsSync(doccDir)) { | ||
amanthatdoescares marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| await vscode.window.showErrorMessage( | ||
| `Documentation catalog "${moduleName}.docc" already exists.` | ||
| ); | ||
| return; | ||
| } | ||
|
|
||
| fs.mkdirSync(doccDir, { recursive: true }); | ||
| fs.writeFileSync(markdownFile, `# ${moduleName}\n`, { encoding: "utf8" }); | ||
|
|
||
| await vscode.window.showInformationMessage( | ||
amanthatdoescares marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| `Created DocC documentation catalog: ${moduleName}.docc` | ||
| ); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.