new package support for new project

Author: eleanorjboyd

src/features/creators/creationHelpers.ts

@@ -0,0 +1,87 @@
+import { window, extensions } from 'vscode';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+
+/**
+ * Prompts the user to choose whether to create a new venv for a package.
+ * Returns true if the user selects 'Yes', false if 'No', and undefined if cancelled.
+ */
+export async function promptForVenv(): Promise<boolean | undefined> {
+    const venvChoice = await window.showQuickPick(['Yes', 'No'], {
+        placeHolder: 'Would you like to create a new venv for this package?',
+        ignoreFocusOut: true,
+    });
+    if (!venvChoice) {
+        return undefined;
+    }
+    return venvChoice === 'Yes';
+}
+
+/**
+ * Returns true if GitHub Copilot extension is installed, false otherwise.
+ */
+export function isCopilotInstalled(): boolean {
+    return !!extensions.getExtension('GitHub.copilot');
+}
+
+/**
+ * Prompts the user to choose whether to create a Copilot instructions file, only if Copilot is installed.
+ * Returns true if the user selects 'Yes', false if 'No', and undefined if cancelled or Copilot not installed.
+ */
+export async function promptForCopilotInstructions(): Promise<boolean | undefined> {
+    if (!isCopilotInstalled()) {
+        return undefined;
+    }
+    const copilotChoice = await window.showQuickPick(['Yes', 'No'], {
+        placeHolder: 'Would you like to create a Copilot instructions file?',
+        ignoreFocusOut: true,
+    });
+    if (!copilotChoice) {
+        return undefined;
+    }
+    return copilotChoice === 'Yes';
+}
+
+export async function removeCopilotInstructions(destFolder: string) {
+    const copilotFolder = path.join(destFolder, '.github');
+    if (await fs.pathExists(copilotFolder)) {
+        await fs.remove(copilotFolder);
+    }
+}
+
+export async function quickCreateNewVenv(destFolder: string) {
+    const venvPath = path.join(destFolder, '.venv');
+    try {
+        // Placeholder: replace with your venv creation logic
+        // await quickCreateVenv(...)
+        window.showInformationMessage(`(Placeholder) Would create venv at: ${venvPath}`);
+    } catch (err) {
+        window.showErrorMessage(`Failed to create virtual environment: ${err}`);
+    }
+}
+
+// Helper to recursively replace all occurrences of a string in file/folder names and file contents
+export async function replaceInFilesAndNames(dir: string, searchValue: string, replaceValue: string) {
+    const entries = await fs.readdir(dir, { withFileTypes: true });
+    for (const entry of entries) {
+        let entryName = entry.name;
+        let fullPath = path.join(dir, entryName);
+        let newFullPath = fullPath;
+        // If the file or folder name contains searchValue, rename it
+        if (entryName.includes(searchValue)) {
+            const newName = entryName.replace(new RegExp(searchValue, 'g'), replaceValue);
+            newFullPath = path.join(dir, newName);
+            await fs.rename(fullPath, newFullPath);
+            entryName = newName;
+        }
+        if (entry.isDirectory()) {
+            await replaceInFilesAndNames(newFullPath, searchValue, replaceValue);
+        } else {
+            let content = await fs.readFile(newFullPath, 'utf8');
+            if (content.includes(searchValue)) {
+                content = content.replace(new RegExp(searchValue, 'g'), replaceValue);
+                await fs.writeFile(newFullPath, content, 'utf8');
+            }
+        }
+    }
+}

src/features/creators/newPackageProject.ts

@@ -1,6 +1,16 @@
-import { MarkdownString, window } from 'vscode';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import { Uri, workspace, MarkdownString, window } from 'vscode';
 import { PythonProject, PythonProjectCreator, PythonProjectCreatorOptions } from '../../api';
-// import { runInBackground } from '../execution/runInBackground';
+import {
+    promptForVenv,
+    promptForCopilotInstructions,
+    isCopilotInstalled,
+    quickCreateNewVenv,
+    removeCopilotInstructions,
+    replaceInFilesAndNames,
+} from './creationHelpers';
+import { EXTENSION_ROOT_DIR } from '../../common/constants';
 
 export class NewPackageProject implements PythonProjectCreator {
     public readonly name = 'newPackage';
@@ -11,8 +21,75 @@ export class NewPackageProject implements PythonProjectCreator {
     constructor() {}
 
     async create(_options?: PythonProjectCreatorOptions): Promise<PythonProject | undefined> {
-        // show notification that the package creation was selected than return undefined
-        window.showInformationMessage('Creating a new Python package...');
-        return undefined;
+        // Prompt for package name
+        const packageName = await window.showInputBox({
+            prompt: 'What is the name of the package? (e.g. my_package)',
+            ignoreFocusOut: true,
+        });
+        if (!packageName) {
+            return undefined;
+        }
+
+        // Use helper for venv
+        const createVenv = await promptForVenv();
+        if (createVenv === undefined) {
+            return undefined;
+        }
+
+        // Only prompt for Copilot instructions if Copilot is installed
+        let createCopilotInstructions = false;
+        if (isCopilotInstalled()) {
+            const copilotResult = await promptForCopilotInstructions();
+            if (copilotResult === undefined) {
+                return undefined;
+            }
+            createCopilotInstructions = copilotResult === true;
+        }
+
+        window.showInformationMessage(
+            `Creating a new Python project: ${packageName}\nvenv: ${createVenv}\nCopilot instructions: ${createCopilotInstructions}`,
+        );
+
+        // 1. Copy template folder
+        const templateFolder = path.join(
+            EXTENSION_ROOT_DIR,
+            'src',
+            'features',
+            'creators',
+            'templates',
+            'newPackageTemplate',
+        );
+        if (!(await fs.pathExists(templateFolder))) {
+            window.showErrorMessage('Template folder does not exist.');
+            return undefined;
+            // might need another check or error handling here
+        }
+        const workspaceFolders = workspace.workspaceFolders;
+        if (!workspaceFolders || workspaceFolders.length === 0) {
+            window.showErrorMessage('No workspace folder is open.');
+            return undefined;
+        }
+        const destRoot = workspaceFolders[0].uri.fsPath;
+        const destFolder = path.join(destRoot, `${packageName}_project`);
+        await fs.copy(templateFolder, destFolder);
+
+        // 2. Replace <package_name> in all files and file/folder names using helper
+        await replaceInFilesAndNames(destFolder, 'package_name', packageName);
+
+        // 3. Remove Copilot instructions folder if needed
+        if (!createCopilotInstructions) {
+            await removeCopilotInstructions(destFolder);
+        }
+
+        // 4. Create virtual environment if requested
+        if (createVenv) {
+            await quickCreateNewVenv(destFolder);
+        }
+
+        // Return a PythonProject object if needed by your API
+        return {
+            name: packageName,
+            uri: Uri.file(destFolder),
+        };
     }
 }

src/features/creators/templates/newPackageTemplate/.github/copilot-instructions.md

@@ -0,0 +1,33 @@
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+
+.pytest_cache/

src/features/creators/templates/newPackageTemplate/.gitignore

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

src/features/creators/templates/newPackageTemplate/.vscode/settings.json

@@ -0,0 +1,3 @@
+pytest
+setuptools
+wheel

src/features/creators/templates/newPackageTemplate/README.md

@@ -0,0 +1,5 @@
+def main() -> None:
+    print("Start coding in Python today!")
+
+
+main()

src/features/creators/templates/newPackageTemplate/dev-requirements.txt

@@ -0,0 +1,21 @@
+[project]
+name = "Package Template"
+version = "1.0.0"
+description = "A Python package template."
+readme = "README.md"
+
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+dev-requirements = {file = "dev-requirements.txt"}
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+
+
+
+
+
+