Skip to content

feat: add .gitignore file creation for new Python environments in venv and conda managers #555

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

Merged
merged 1 commit into from
Jun 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ export interface EnvironmentManager {
quickCreateConfig?(): QuickCreateConfig | undefined;

/**
* Creates a new Python environment within the specified scope.
* Creates a new Python environment within the specified scope. Create should support adding a .gitignore file if it creates a folder within the workspace.
* @param scope - The scope within which to create the environment.
* @param options - Optional parameters for creating the Python environment.
* @returns A promise that resolves to the created Python environment, or undefined if creation failed.
Expand Down
13 changes: 13 additions & 0 deletions src/managers/builtin/venvManager.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as fs from 'fs/promises';
import * as path from 'path';
import { EventEmitter, l10n, LogOutputChannel, MarkdownString, ProgressLocation, ThemeIcon, Uri } from 'vscode';
import {
Expand All @@ -20,6 +21,7 @@ import {
} from '../../api';
import { PYTHON_EXTENSION_ID } from '../../common/constants';
import { VenvManagerStrings } from '../../common/localize';
import { traceError } from '../../common/logging';
import { createDeferred, Deferred } from '../../common/utils/deferred';
import { showErrorMessage, withProgress } from '../../common/window.apis';
import { findParentIfFile } from '../../features/envCommands';
Expand Down Expand Up @@ -162,6 +164,17 @@ export class VenvManager implements EnvironmentManager {
}
if (environment) {
this.addEnvironment(environment, true);

// Add .gitignore to the .venv folder
try {
const venvDir = environment.environmentPath.fsPath;
const gitignorePath = path.join(venvDir, '.gitignore');
await fs.writeFile(gitignorePath, '*\n', { flag: 'w' });
} catch (err) {
traceError(
`Failed to create .gitignore in venv: ${err instanceof Error ? err.message : String(err)}`,
);
}
}
return environment;
} finally {
Expand Down
16 changes: 16 additions & 0 deletions src/managers/conda/condaEnvManager.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import * as fs from 'fs-extra';
import * as path from 'path';
import { Disposable, EventEmitter, l10n, LogOutputChannel, MarkdownString, ProgressLocation, Uri } from 'vscode';
import {
Expand All @@ -19,6 +20,7 @@ import {
SetEnvironmentScope,
} from '../../api';
import { CondaStrings } from '../../common/localize';
import { traceError } from '../../common/logging';
import { createDeferred, Deferred } from '../../common/utils/deferred';
import { showErrorMessage, withProgress } from '../../common/window.apis';
import { NativePythonFinder } from '../common/nativePythonFinder';
Expand Down Expand Up @@ -167,6 +169,20 @@ export class CondaEnvManager implements EnvironmentManager, Disposable {
}
if (result) {
this.addEnvironment(result);

// If the environment is inside the workspace, add a .gitignore file
try {
const projectUris = this.api.getPythonProjects().map((p) => p.uri.fsPath);
const envPath = result.environmentPath?.fsPath;
if (envPath && projectUris.some((root) => envPath.startsWith(root))) {
const gitignorePath = path.join(envPath, '.gitignore');
await fs.writeFile(gitignorePath, '*\n', { flag: 'w' });
}
} catch (err) {
traceError(
`Failed to create .gitignore in conda env: ${err instanceof Error ? err.message : String(err)}`,
);
}
}

return result;
Expand Down