Unnamed repository; edit this file 'description' to name the repository.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
import * as vscode from "vscode";

import type { Ctx, Cmd } from "./ctx";
import * as ra from "./lsp_ext";
import { cargoPath } from "./toolchain";
import { log, spawnAsync } from "./util";

type NewProjectKind = "bin" | "lib";
type NewProjectOpenAction = "open" | "openNewWindow" | "addToWorkspace";

type NewProjectTemplate = {
    detail: string;
    id: NewProjectKind;
    label: string;
};

type NewProjectCargo = {
    cargo: string;
    cargoEnv: NodeJS.ProcessEnv;
};

const NEW_PROJECT_TEMPLATES: readonly NewProjectTemplate[] = [
    {
        id: "bin",
        label: "Binary Application",
        detail: "Create a Cargo binary package (`cargo new --bin`)",
    },
    {
        id: "lib",
        label: "Library",
        detail: "Create a Cargo library package (`cargo new --lib`)",
    },
] as const;

export function newProject(ctx: Ctx): Cmd {
    return async () => {
        const cargo = await resolveNewProjectCargo(ctx);

        const selectedKind = await promptForNewProjectTemplate();
        if (!selectedKind) {
            return;
        }

        const parentFolder = await promptForNewProjectParentFolder();
        if (!parentFolder) {
            return;
        }

        const projectName = await promptForNewProjectName(parentFolder);
        if (!projectName) {
            return;
        }

        if (!(await createNewProject(cargo, parentFolder, selectedKind, projectName))) {
            return;
        }

        const projectUri = vscode.Uri.joinPath(parentFolder, projectName);
        const defaultAction = determineNewProjectOpenAction(
            ctx.config.projectCreationOpenAfterCreate,
            Boolean(vscode.workspace.workspaceFolders?.length),
        );
        const action =
            defaultAction === "ask"
                ? await promptForNewProjectOpenAction(
                      projectName,
                      Boolean(vscode.workspace.workspaceFolders?.length),
                  )
                : defaultAction;

        if (action) {
            await executeNewProjectOpenAction(ctx, action, projectUri);
        }
    };
}

async function resolveNewProjectCargo(ctx: Ctx): Promise<NewProjectCargo> {
    // Use the same effective environment rust-analyzer uses elsewhere so project creation sees
    // toolchain wrappers, PATH overrides, and CARGO_HOME changes from configuration.
    const cargoEnv = { ...process.env, ...ctx.config.serverExtraEnv };
    return { cargo: await cargoPath(cargoEnv), cargoEnv };
}

async function promptForNewProjectTemplate(): Promise<NewProjectKind | undefined> {
    const selected = await vscode.window.showQuickPick(NEW_PROJECT_TEMPLATES, {
        placeHolder: "Select a Rust project kind",
    });
    return selected?.id;
}

async function promptForNewProjectParentFolder(): Promise<vscode.Uri | undefined> {
    const selectedFolder = await vscode.window.showOpenDialog({
        title: "Select the parent folder for the new Rust project",
        openLabel: "Select parent folder",
        canSelectFiles: false,
        canSelectFolders: true,
        canSelectMany: false,
    });
    if (!selectedFolder?.length) {
        return undefined;
    }
    return selectedFolder[0];
}

const CARGO_MANIFEST_NAME_PATTERN = /^[\p{Alphabetic}\p{Number}_-]+$/u;

// Keep local validation focused on stable checks that can be reported in the input box, then let
// `cargo new` remain the source of truth for package-name-specific identifier and keyword rules.
export function validateNewProjectName(
    value: string,
    existingNames: readonly string[],
): string | undefined {
    const trimmedValue = value.trim();
    if (trimmedValue.length === 0) {
        return "Project name cannot be empty.";
    }
    if (trimmedValue.includes("/") || trimmedValue.includes("\\")) {
        return "Project name cannot contain '/' or '\\' characters.";
    }
    if (trimmedValue === "." || trimmedValue === "..") {
        return "Project name cannot be '.' or '..'.";
    }
    if (!CARGO_MANIFEST_NAME_PATTERN.test(trimmedValue)) {
        return "Project name can contain only alphanumeric characters, '-' or '_'.";
    }
    if (existingNames.includes(trimmedValue)) {
        return "A file or folder with this name already exists.";
    }
    return undefined;
}

async function promptForNewProjectName(parentFolder: vscode.Uri): Promise<string | undefined> {
    let existingNames: string[] = [];
    try {
        const entries = await vscode.workspace.fs.readDirectory(parentFolder);
        existingNames = entries.map(([name]) => name);
    } catch (error) {
        log.error("Failed to read project parent folder", error);
        void vscode.window.showErrorMessage("Failed to read the selected parent folder.");
        return undefined;
    }

    const projectName = await vscode.window.showInputBox({
        prompt: `Enter the new project name to create inside ${parentFolder.fsPath}`,
        validateInput: async (value) => validateNewProjectName(value, existingNames),
    });
    return projectName?.trim();
}

export function cargoNewArgs(kind: NewProjectKind, name: string): string[] {
    return ["new", kind === "bin" ? "--bin" : "--lib", name];
}

async function createNewProject(
    cargo: NewProjectCargo,
    parentFolder: vscode.Uri,
    kind: NewProjectKind,
    projectName: string,
): Promise<boolean> {
    const args = cargoNewArgs(kind, projectName);
    const createResult = await vscode.window.withProgress(
        {
            location: vscode.ProgressLocation.Notification,
            title: `Creating Rust project ${projectName}`,
        },
        async () =>
            spawnAsync(cargo.cargo, args, {
                cwd: parentFolder.fsPath,
                env: cargo.cargoEnv,
            }),
    );

    if (createResult.error || createResult.status !== 0) {
        const details = formatProcessDetails(createResult);
        await showNewProjectError("Failed to create Rust project.", details || undefined, {
            cargo: cargo.cargo,
            args,
            cwd: parentFolder.fsPath,
            error: createResult.error?.message,
            status: createResult.status,
            stderr: createResult.stderr || undefined,
            stdout: createResult.stdout || undefined,
        });
        return false;
    }

    return true;
}

function formatProcessDetails(result: { error?: Error; stderr: string; stdout: string }): string {
    return [result.stderr, result.stdout, result.error?.message]
        .filter((value): value is string => Boolean(value && value.trim().length > 0))
        .join("\n")
        .trim();
}

async function showNewProjectError(
    message: string,
    details: string | undefined,
    logContext: {
        cargo: string;
        args: string[];
        cwd?: string;
        error?: string;
        status: number | null;
        stderr?: string;
        stdout?: string;
    },
): Promise<void> {
    // Keep command-failure logging focused on the invocation and process output. Environment
    // variables may contain secrets such as API keys, tokens, and credentials, so failure logs
    // must not dump the merged env here.
    const commandLine = [logContext.cargo, ...logContext.args].join(" ");
    log.error(message);
    log.error(`command: ${commandLine}`);
    if (logContext.cwd) {
        log.error(`cwd: ${logContext.cwd}`);
    }
    log.error(`exit status: ${String(logContext.status)}`);
    if (logContext.error) {
        log.error(`error: ${logContext.error}`);
    }
    if (logContext.stderr) {
        log.error(`stderr:\n${logContext.stderr}`);
    }
    if (logContext.stdout) {
        log.error(`stdout:\n${logContext.stdout}`);
    }
    const selection = await vscode.window.showErrorMessage(
        details ? `${message}\n${details}` : message,
        "Open Extension Logs",
    );
    if (selection === "Open Extension Logs") {
        log.show();
    }
}

export function determineNewProjectOpenAction(
    configuredAction: string | undefined,
    hasWorkspaceFolders: boolean,
): "ask" | NewProjectOpenAction {
    switch (configuredAction) {
        case "open":
        case "openNewWindow":
            return configuredAction;
        case "addToWorkspace":
            // Adding to a workspace only makes sense when one is already open. Falling back to
            // "open" keeps the setting usable in empty windows without adding another prompt path.
            return hasWorkspaceFolders ? configuredAction : "open";
        default:
            return "ask";
    }
}

async function promptForNewProjectOpenAction(
    projectName: string,
    hasWorkspaceFolders: boolean,
): Promise<NewProjectOpenAction | undefined> {
    let message = `Would you like to open ${projectName}?`;
    const open = "Open";
    const openNewWindow = "Open in New Window";
    const choices = [open, openNewWindow];

    const addToWorkspace = "Add to VS Code Workspace";
    if (hasWorkspaceFolders) {
        message = `Would you like to open ${projectName}, or add it to the current VS Code workspace?`;
        choices.push(addToWorkspace);
    }

    const result = await vscode.window.showInformationMessage(
        message,
        { modal: true, detail: "The default action can be configured in settings." },
        ...choices,
    );

    const actionMap: Record<string, NewProjectOpenAction> = {
        [open]: "open",
        [openNewWindow]: "openNewWindow",
        [addToWorkspace]: "addToWorkspace",
    };
    return result ? actionMap[result] : undefined;
}

async function executeNewProjectOpenAction(
    ctx: Ctx,
    action: NewProjectOpenAction,
    projectUri: vscode.Uri,
): Promise<void> {
    if (action === "open") {
        await vscode.commands.executeCommand("vscode.openFolder", projectUri, {
            forceReuseWindow: true,
        });
        return;
    }

    if (action === "openNewWindow") {
        await vscode.commands.executeCommand("vscode.openFolder", projectUri, {
            forceNewWindow: true,
        });
        return;
    }

    const index = vscode.workspace.workspaceFolders?.length ?? 0;
    vscode.workspace.updateWorkspaceFolders(index, 0, { uri: projectUri });
    // Reuse the existing workspace window when requested, but nudge rust-analyzer afterwards so
    // the newly added Cargo project is discovered immediately instead of waiting for a later
    // background refresh.
    if (ctx.client?.isRunning()) {
        await ctx.client.sendRequest(ra.reloadWorkspace);
    }
}