VS Code Make Tasks

A native VS Code task explorer for documented Makefile targets.

• 1. Details
  • 1.1. Prerequisites
  • 1.2. Usage
• 2. Contribution

1. Details

1.1. Prerequisites

• Visual Studio Code

  Visual Studio Code (>=1.125) is required to run the extension.

1.2. Usage

1. Insights and Details

   • Specification

     The Make Tasks Specification is the normative reference for annotation syntax and externally observable behavior.

   • Activity Bar

     Dedicated Makefile icon and target explorer in the Activity Bar.

   • Explorer

     Target grouping by workspace, Makefile, and category when necessary.

   • Execution

     Target execution as native VS Code tasks from the explorer.

   • Quick Pick

     Keyboard-driven target selection and execution.

   • Navigation

     Direct navigation to target definitions.

   • Workspace

     Multi-root workspace and multiple-Makefile support.

   • Auto-refresh

     Automatic target refresh after matching Makefile changes when makefileTasks.autoRefresh is enabled.

   • Configuration

     Configurable Make command, discovery globs, exclusions, sorting, click behavior, and automatic refresh.

2. Usage and Instructions

   • Tasks

     The extension discovers documented Makefile targets and presents them as VS Code tasks. A target is discoverable when it has a non-empty preceding or inline ## description. The extension ignores undocumented targets, helper rules, pattern rules, variable assignments, and unsupported target names.

     ## Single-line description for the build task
     build:
       go build ./...
     .PHONY: build
     

     test: ## Inline description for the test task
       go test ./...
     .PHONY: test
     

   • Categorization

     Organize tasks with canonical section comments. The extension groups tasks by category in the Activity Bar explorer and places uncategorized tasks under Uncategorized.

     # ─── Skills Manager ────────────────────────────────────────────────────
     
     skills-agent-add: ## Provision Agent Skills
       skills add ./skills
     
     skills-agent-update: ## Update Agent Skills
       skills update ./skills
     
     # --- Dependencies ------------------------------------------------------
     
     dependency-update: ## Update project dependencies
       renovate --platform=local
     
     # === Test ==============================================================
     
     test: ## Run the test suite
       go test ./...
     

   • Input Metadata

     Document expected positional arguments or Make variable assignments with optional # Usage: metadata. Usage metadata is descriptive and does not validate or supply runtime arguments.

     # Usage: make deploy ENV=<name> [VERSION=<version>]
     #
     deploy: ## Deploy the application
       ./scripts/deploy --env "$(ENV)" --version "$(VERSION)"
     .PHONY: deploy
     

   • Invocation

     Run targets with positional arguments or Make variable assignments through Run Target with Arguments or makefileTarget task definitions.

     # Usage: make build [MODE=<mode>]
     #
     build: ## Build the application
       go build -tags "$(MODE)" ./...
     .PHONY: build
     

2. Contribution

1. Insights and Details

   • Node.js

     Node.js (>=22) is required to build, test, and package the extension.

   • VS Code Extension Anatomy

     Anatomy of a VS Code extension, including the structure of the extension folder and the purpose of each file.

   • VS Code Publisher Marketplace

     The publisher page for the extension, including version history, download statistics, and links to the source repository.

2. Usage and Instructions

   • Tasks

     The repository Makefile provides documented targets for installing dependencies, validating changes, building, packaging, and installing the extension locally.

     make vscode-extension-dependencies
     make vscode-extension-build
     make vscode-extension-package
     make vscode-extension-install