Skip to content

README.md

Latest commit

 

History

History
112 lines (77 loc) · 2.68 KB

README.md

File metadata and controls

112 lines (77 loc) · 2.68 KB
Raw
title Dev Container
description Pre-configured development environment for HVE Core with all required tools and extensions
author HVE Core Team
ms.date 2025-11-05
ms.topic guide
keywords
devcontainer
development environment
vscode
docker
estimated_reading_time 3

A pre-configured development environment that includes all tools, extensions, and dependencies needed for HVE Core development. Ensures consistency across all development machines.

Prerequisites

Quick Start

  1. Clone the repository:

    git clone https://github.com/microsoft/hve-core.git
cd hve-core

  2. Open in VS Code:

    code .

  3. Reopen in container:

    • Press F1 or Ctrl+Shift+P
    • Select Dev Containers: Reopen in Container
    • Wait for the container to build (first time takes 5-10 minutes)

Included Tools

Languages & Runtimes

  • Node.js 20
  • Python 3.11
  • PowerShell 7.x

CLI Tools

  • Git
  • GitHub CLI (gh)
  • Azure CLI (az)
  • actionlint (GitHub Actions workflow linter)

Code Quality

  • Markdown: markdownlint, markdown-table-formatter
  • Spelling: Code Spell Checker (VS Code extension)
  • Shell: shellcheck

Security

  • Gitleaks (secret scanning)

PowerShell Modules

  • PSScriptAnalyzer
  • PowerShell-Yaml
  • Pester 5.7.1

Pre-installed VS Code Extensions

  • Spell Checking: Street Side Software Spell Checker
  • Markdown: markdownlint, Markdown All in One, Mermaid support
  • GitHub: GitHub Pull Requests

Common Commands

Run these commands inside the container:

# Lint Markdown files
markdownlint '**/*.md' --ignore node_modules

# Check spelling
cspell '**/*.md'

# Check shell scripts
shellcheck scripts/**/*.sh

# Security scan
gitleaks detect --source . --verbose

Troubleshooting

Container won't build: Ensure Docker Desktop is running and you have sufficient disk space (5GB+).

  1. Extensions not loading: Reload the window (F1 → Developer: Reload Window).

  2. HTTP/TLS errors during build: Machines with corporate firewalls performing TLS inspection should ensure they are using the default desktop-linux builder, which honors OS root certificate trust stores. You can change the active builder back to desktop-linux by running docker buildx use desktop-linux.

For more help, see SUPPORT.md.

🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.