microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
.devcontainer/README.md
109lines · modecode
| 1 | --- |
| 2 | title: Dev Container |
| 3 | description: Pre-configured development environment for HVE Core with all required tools and extensions |
| 4 | author: HVE Core Team |
| 5 | ms.date: 2025-11-05 |
| 6 | ms.topic: guide |
| 7 | keywords: |
| 8 | - devcontainer |
| 9 | - development environment |
| 10 | - vscode |
| 11 | - docker |
| 12 | estimated_reading_time: 3 |
| 13 | --- |
| 14 | |
| 15 | A pre-configured development environment that includes all tools, extensions, and dependencies needed for HVE Core development. Ensures consistency across all development machines. |
| 16 | |
| 17 | ## Prerequisites |
| 18 | |
| 19 | * [Docker Desktop](https://www.docker.com/products/docker-desktop) |
| 20 | * [Visual Studio Code](https://code.visualstudio.com/) |
| 21 | * [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) |
| 22 | * Git |
| 23 | |
| 24 | ## Quick Start |
| 25 | |
| 26 | 1. Clone the repository: |
| 27 | |
| 28 | ```bash |
| 29 | git clone https://github.com/microsoft/hve-core.git |
| 30 | cd hve-core |
| 31 | ``` |
| 32 | |
| 33 | 2. Open in VS Code: |
| 34 | |
| 35 | ```bash |
| 36 | code . |
| 37 | ``` |
| 38 | |
| 39 | 3. Reopen in container: |
| 40 | * Press `F1` or `Ctrl+Shift+P` |
| 41 | * Select **Dev Containers: Reopen in Container** |
| 42 | * Wait for the container to build (first time takes 5-10 minutes) |
| 43 | |
| 44 | ## Included Tools |
| 45 | |
| 46 | ### Languages & Runtimes |
| 47 | |
| 48 | * Node.js 20 |
| 49 | * Python 3.11 |
| 50 | * PowerShell 7.x |
| 51 | |
| 52 | ### CLI Tools |
| 53 | |
| 54 | * Git |
| 55 | * GitHub CLI (`gh`) |
| 56 | * Azure CLI (`az`) |
| 57 | * actionlint (GitHub Actions workflow linter) |
| 58 | |
| 59 | ### Code Quality |
| 60 | |
| 61 | * Markdown: markdownlint, markdown-table-formatter |
| 62 | * Spelling: Code Spell Checker (VS Code extension) |
| 63 | * Shell: shellcheck |
| 64 | |
| 65 | ### Security |
| 66 | |
| 67 | * Gitleaks (secret scanning) |
| 68 | |
| 69 | ### PowerShell Modules |
| 70 | |
| 71 | * PSScriptAnalyzer |
| 72 | * PowerShell-Yaml |
| 73 | * Pester 5.7.1 |
| 74 | |
| 75 | ## Pre-installed VS Code Extensions |
| 76 | |
| 77 | * Spell Checking: Street Side Software Spell Checker |
| 78 | * Markdown: markdownlint, Markdown All in One, Mermaid support |
| 79 | * GitHub: GitHub Pull Requests |
| 80 | |
| 81 | ## Common Commands |
| 82 | |
| 83 | Run these commands inside the container: |
| 84 | |
| 85 | ```bash |
| 86 | # Lint Markdown files |
| 87 | markdownlint '**/*.md' --ignore node_modules |
| 88 | |
| 89 | # Check spelling |
| 90 | cspell '**/*.md' |
| 91 | |
| 92 | # Check shell scripts |
| 93 | shellcheck scripts/**/*.sh |
| 94 | |
| 95 | # Security scan |
| 96 | gitleaks detect --source . --verbose |
| 97 | ``` |
| 98 | |
| 99 | ## Troubleshooting |
| 100 | |
| 101 | Container won't build: Ensure Docker Desktop is running and you have sufficient disk space (5GB+). |
| 102 | |
| 103 | Extensions not loading: Reload the window (`F1` → **Developer: Reload Window**). |
| 104 | |
| 105 | For more help, see [SUPPORT.md](../SUPPORT.md). |
| 106 | |
| 107 | --- |
| 108 | |
| 109 | 🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers. |
| 110 | |