HACS Integration Preflight (VS Code)

Validate Home Assistant custom integrations (custom_components/<domain>) before submitting to HACS. The extension mirrors HACS reviewer expectations, flags errors/warnings, and offers safe autofixes.

Features

• Repository detection (single integration only, git + GitHub remote required)
• hacs.json and manifest.json validation (including key ordering autofix)
• GitHub metadata and release checks (using optional PAT)
• Branding verification against brands.home-assistant.io
• CI workflow validation with an Add/Repair Workflow command (category: integration)
• Preflight panel with sections + inline diagnostics

Commands

• HACS: Run Integration Preflight Check
• HACS: Autofix manifest.json ordering
• HACS: Add/Repair CI Workflows
• HACS: Check Home Assistant Brands status

Settings

• hacsPreflight.githubToken: GitHub PAT for repository metadata/releases (optional).
• hacsPreflight.brandsCheck: Enable remote brand asset lookup (defaults to true).

Usage

1. Open the integration repository in VS Code.
2. Run HACS: Run Integration Preflight Check (View → HACS Preflight).
3. Use provided buttons/commands to autofix manifest ordering or add the HACS workflow.
4. Resolve remaining warnings/errors before submitting to HACS.

CI Workflow Scaffolding

HACS: Add/Repair CI Workflows previews a diff and then writes .github/workflows/hacs.yml using the official hacs/action with category: integration. Changes are applied via Workspace Edits so they are undoable.

Testing

npm install
npm test

References

• https://hacs.xyz/docs/publish/start/
• https://hacs.xyz/docs/publish/integration/
• https://hacs.xyz/docs/publish/include/
• https://hacs.xyz/docs/publish/action/
• https://github.com/home-assistant/brands
• https://developers.home-assistant.io/docs/branding/
• https://developers.home-assistant.io/docs/creating_integration_manifest/

Come see our other apps and integrations at WeaveHub.