Create new project by matthewbastien · Pull Request #755 · swiftlang/vscode-swift

matthewbastien · 2024-04-19T13:50:25Z

Implementation of the feature request #754.

The workflow is as follows:

User runs the command Swift: New Project
A prompt appears to select the project type. Available project types are retrieved by parsing the output of swift package init --help.
An open folder dialog appears to select the root folder for the new project.
A quick input appears to enter a name for the project.
The project folder is created on disk and swift package init is executed to create the project based on the given inputs.
A modal appears asking whether or not the user would like to open the newly created folder in the current window or a new one. An automatic action for this step can be configured with the swift.openAfterCreateProject setting. This is essentially the same modal used by the Git: Clone command.

I've also added a fairly basic test to make sure that the parsing of swift package init --help is functioning as intended.

Feedback is greatly appreciated! This is my first commit to this project and I definitely don't know all the ins and outs to the code base.

…t templates

daveyc123 · 2024-04-19T14:00:32Z

 */
 export function register(ctx: WorkspaceContext) {
    ctx.subscriptions.push(
+        vscode.commands.registerCommand("swift.createProject", () => createProject(ctx)),


createProject() has a few instances where it returns undefined. What's the experience for the user in these cases? Should createProject be providing guidance/errors to the user in the form of notifications?

The places where createProject() returns undefined correspond to the user cancelling dialogs. I don't think we need any notifications in this case.

👍 What's the behaviour from vscode for exceptions (e.g. the execSwift or mkdir fail)

It pops up a modal with the error message from the exception.

Have you verified what the message is for say mkdir failing? Would be good to make sure it is human readable.

Good question! I tried it out myself and it looks like the error message is fairly self explanatory:

adam-fowler

In general looks pretty good, I've added a few comments

adam-fowler · 2024-04-20T13:56:28Z

      {
        "title": "Swift",
        "properties": {
+          "swift.openAfterCreateProject": {


Can we add an order value to this to define where it appears in the settings menu

Done. I put it at the end of the settings since I can't imagine this being a high runner use case.

adam-fowler · 2024-04-20T13:59:33Z

+/**
+ * A wrapper around {@link vscode.Progress} that allows for delaying progress reporting.
+ */
+class ProgressWrapper<T> implements vscode.Progress<T> {


Can we move the progress UI code to a separate file in the UI folder.

adam-fowler · 2024-04-20T14:14:44Z

+    // Prompt the user whether or not they want to open the newly created project
+    const isWorkspaceOpened = !!vscode.workspace.workspaceFolders;
+    const config = vscode.workspace.getConfiguration("swift");
+    const openAfterCreate = config.get<string>("openAfterCreateProject");


Can we add configuration settings to configuration.ts

adam-fowler · 2024-04-20T14:17:49Z

+
+    // Use swift package manager to initialize the swift project
+    await withDelayedProgress(
+        {


Given there is no progress reported here, any reason you can't use WorkspaceContext.statusItem.showStatusWhileRunning()

I'd expect that 99% of the time we would never even show the notification. In my testing it never showed up unless I reduced the timeout. However, if it does take longer than expected, I want it to be a prominent notification rather than something hidden away in the status bar. That way users know that something is actually happening in the background.

That being said, this does add extra code that will need to be maintained. I'm not too strongly attached to this opinion and can just use showStatusWhileRunning() instead if that makes more sense to you.

adam-fowler · 2024-04-20T14:19:44Z

 */
 export function register(ctx: WorkspaceContext) {
    ctx.subscriptions.push(
+        vscode.commands.registerCommand("swift.createProject", () => createProject(ctx)),


Have you verified what the message is for say mkdir failing? Would be good to make sure it is human readable.

adam-fowler · 2024-04-20T14:24:31Z

+     */
+    public async getProjectTemplates(): Promise<SwiftProjectTemplate[]> {
+        const { stdout } = await execSwift(["package", "init", "--help"], "default");
+        const lines = stdout.split(/\r?\n/g);


This is some funky way to get project templates, but yeah can't see any other way of doing it.

I almost wonder if it is worthwhile rolling our own outside of SwiftPM. Would love to give users the ability to create their own templates. Maybe using Mustache templating to allow users to add in customisation. But that'd be for another task I think.

Yeah I agree. I'd honestly like an option in Swift Package Manager to get these as JSON rather than doing the crazy command line parsing. However, we still need to support Swift versions <6.

adam-fowler · 2024-04-20T14:26:50Z

@swift-server-bot test this please

adam-fowler · 2024-04-20T14:28:56Z

@swift-server-bot add to allowlist

adam-fowler · 2024-04-22T14:31:04Z

CI is returning a bunch of errors for older versions of swift. New features can probably be gated on the last three versions of swift. Get it working for 5.8 if it works for all the earlier swift versions as well you are done. Otherwise Add a new contextKey newProjectAvailable in contextKeys.ts and use the contextKey to control availability of the command. At startup you can check the swift version and set it to false if the swift version is less than 5.8

award999

a few minor comments :)

matthewbastien · 2024-04-22T19:41:37Z

CI is returning a bunch of errors for older versions of swift. New features can probably be gated on the last three versions of swift. Get it working for 5.8 if it works for all the earlier swift versions as well you are done. Otherwise Add a new contextKey newProjectAvailable in contextKeys.ts and use the contextKey to control availability of the command. At startup you can check the swift version and set it to false if the swift version is less than 5.8

The output of swift package init --help changes pretty drastically in versions <5.8.0. I've added the context key for enablement of the command, but we still need to support users being able to create a project in cases where the Swift extension is not activated yet (e.g. when no workspace is open). As such, I've also added a swift.isActivated context key to detect this. An error is shown to the user if they try to use the create project command with an unsupported swift version.

adam-fowler

I think we are good here

matthewbastien added 4 commits April 19, 2024 09:38

add new project command

1ebd9af

parse the output of 'swift package init --help' to get list of projec…

72be060

…t templates

show progress if swift pm takes longer than 1s to complete

736baf3

add test for SwiftToolChain#getProjectTemplates()

b0a99bb

daveyc123 reviewed Apr 19, 2024

View reviewed changes

adam-fowler reviewed Apr 20, 2024

View reviewed changes

award999 reviewed Apr 22, 2024

View reviewed changes

Comment thread package.json Outdated

award999 reviewed Apr 22, 2024

View reviewed changes

Comment thread src/commands.ts Outdated

Comment thread src/commands.ts

matthewbastien added 5 commits April 22, 2024 13:11

fix command name and setting order

b1a6952

move withDelayedProgress to its own file in the ui folder

67874b6

improve project name validation

466711c

only enable create new project command in swift versions >=5.8.0

4cb5ea0

fix broken test

6115422

adam-fowler approved these changes Apr 23, 2024

View reviewed changes

adam-fowler merged commit 9ef875c into swiftlang:main Apr 23, 2024

matthewbastien deleted the create-new-project branch April 23, 2024 13:21

matthewbastien mentioned this pull request May 3, 2024

Retrieving a machine-readable list of possible options and arguments apple/swift-argument-parser#637

Open

Conversation

matthewbastien commented Apr 19, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adam-fowler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adam-fowler Apr 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adam-fowler commented Apr 20, 2024

Uh oh!

adam-fowler commented Apr 20, 2024

Uh oh!

adam-fowler commented Apr 22, 2024

Uh oh!

Uh oh!

award999 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

matthewbastien commented Apr 22, 2024

Uh oh!

adam-fowler left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adam-fowler Apr 20, 2024 •

edited

Loading