Skip to content

KernFerm/VSC-Auto-Installer

Repository files navigation

💻 Visual Studio Code Auto Setup Guide

This guide provides detailed instructions on using the VisualStudioCode+Auto-Setup.ps1 script to automate the installation and configuration of Visual Studio Code on Windows systems 🪟. Whether you're setting up a new machine or configuring multiple computers, this script simplifies the process by automating tasks that would otherwise be manual and time-consuming.

The script automates several key tasks:

  • Downloading and Installing Visual Studio Code: It retrieves the latest stable version of Visual Studio Code directly from the official website and installs it on your system without any user intervention.
  • Adding Visual Studio Code to the System PATH: This ensures that you can run Visual Studio Code from any command line window by typing code.
  • Extension Installation: The script includes predefined extensions that are automatically installed, enhancing the functionality and integration of Visual Studio Code. These extensions support a wide range of development activities, including Python programming, container management, and AI-assisted coding.
  • Configuration: Any necessary configuration of Visual Studio Code settings to optimize performance or adhere to specific development standards can also be scripted.

By automating these steps, the script not only saves time and effort but also ensures a consistent setup across different environments, making it ideal for both individual and organizational use.


📥 How to Download the Repo (First-Time Users)

Click the link to read Instructions 📄.

Support the Project ⭐

If you find this project useful, please give it a star! Your support is appreciated and helps keep the project growing. 🌟


⚙️ Prerequisites

  • PowerShell must be installed on your system. You will use it to run the setup script.
  • Both MSIs are from the official GitHub page of Official PowerShell GitHub.

🔧 v7.4.6 Release of PowerShell - Latest (recommended)

Select the version that matches your system specs:


⚙️ Visual Studio Code Installation Script with Logging

This PowerShell script automates the download, installation, and configuration of Visual Studio Code. It also logs every step for troubleshooting and auditing purposes 📑.


📝 Logging Functionality

The script includes a logging mechanism to record the installation process, ensuring that every significant action is documented.


🛠️ Log-Message Function

The core of the logging functionality is the Log-Message function. It logs messages to both the console and a log file.

Definition

function Log-Message {
    param (
        [string]$message
    )

    $timestamp = Get-Date -Format "yyyy-MM-dd HH:mm"
    $logEntry = "$timestamp - $message"
    
    Write-Host $logEntry
    
    $logFilePath = "path\to\your\logfile.log" # Define the log file path
    Add-Content -Path $logFilePath -Value $logEntry
}

📝 Log File Path

The log file is stored in the system's temporary directory as VSCodeInstallLog.txt.

$logFilePath = "$env:USERPROFILE\VSCodeInstallLog.txt"

📝 Log Entries

  • Each log entry contains a timestamp and a description of the current step of the script. Example log entries:
2024-07-18 12:00:00 - Downloading Visual Studio Code installer...
2024-07-18 12:01:00 - Download completed.
2024-07-18 12:02:00 - Running the Visual Studio Code installer...
2024-07-18 12:03:00 - Installation completed.
2024-07-18 12:08:00 - Installing VS Code extension: ms-python.vscode-pylance...
2024-07-18 12:09:00 - Successfully installed extension: ms-python.vscode-pylance.

🛠️ Example Usage

Here’s how the Log-Message function is used within the script:

Log-Message "Downloading Visual Studio Code installer..."

try {
    Invoke-WebRequest -Uri $url -OutFile $installerPath -ErrorAction Stop
    Log-Message "Download completed."
} catch {
    Log-Message "Failed to download Visual Studio Code installer: $_"
    exit 1
}

🚀 Steps to Use the Script

  1. Run as Administrator: Right-click on the script and select Run as administrator 🔒.
  2. Navigate to Script Location: Open PowerShell as admin and navigate to the script directory using cd.

🏃 How to Run

To execute the script, run:

.\VisualStudioCode+Auto-Setup.ps1
  • If the script does not run, change the execution policy by running:
Set-ExecutionPolicy Bypass -Scope Process
  • If a message pops up, click Y then enter.
  • Then, run the script again:
.\VisualStudioCode+Auto-Setup.ps1

🛠️ Script Functionality

  • Automatic Download: The script downloads the latest stable release of Visual Studio Code from the official website.
  • Silent Installation: It runs the installer with silent arguments, allowing installation without user interaction.
  • Add to PATH: The script adds the VS Code executable to the user PATH, allowing you to run code from the command line.
  • Cleanup: After installation, the script removes the installer file to free up space.
  • Extension Installation: The script installs an extensive list of extensions for enhanced development capabilities across multiple languages and tools.

⚠️ Notes

  • Ensure that Visual Studio Code is closed before running the script to avoid conflicts during extension installation.
  • The script will not add VS Code to the PATH if it already exists there.