Comment Section Outline (VS Code Extension)

Overview

Comment Section Outline adds VS Code Outline entries for structured comment section headers.

Many repository infrastructure files do not have native symbols, even though they are organized into human-readable sections.

This extension recognizes comment headers such as:

# === Checkout ===

# === Setup ===

# === Install ===

Install from Marketplace

Install from the Visual Studio Marketplace:

Comment Section Outline

Or install from VS Code by searching for:

Comment Section Outline

Install Locally

To install a local build, first package the extension:

npm run format
npm run check
npm run package:vsix

Then install the generated .vsix file in VS Code:

code --install-extension comment-section-outline-0.1.0.vsix

After installation, open a supported file such as .gitattributes, Markdown, TOML, YAML, PowerShell, or VS Code JSONC settings. Section comments should appear in the VS Code Outline view.

To uninstall the local extension:

code --uninstall-extension denisecase.comment-section-outline

Release Packaging

This repository packages the VS Code extension as a .vsix artifact through GitHub Actions. The release workflow verifies formatting, type checking, linting, extension-host tests, runtime dependency audit, and VSIX packaging.

Marketplace publishing for the initial release was performed manually from the Visual Studio Marketplace publisher portal. Automated Marketplace publishing will be added after the publisher personal access token flow is configured and stored as a GitHub Actions secret.

Publisher Verification

A VS Code extension may be published by an unverified Visual Studio Marketplace publisher. The Marketplace will not show the verified publisher trust indicator until the publisher completes Microsoft's verification process.

Microsoft's verified publisher process requires the publisher to prove control of an identifying domain, typically through DNS verification, and the publisher/domain must meet Marketplace eligibility requirements. Until verification is complete, users may rely on the public repository, source code, and packaged VSIX artifact as the trust evidence for this project.

Developer Command Reference

Show command reference

In a machine terminal

git clone https://github.com/denisecase/section-comment-outline

cd section-comment-outline
code .

In a VS Code terminal

# update dependency ranges and install
# npx npm-check-updates -u
npm install

# process
npm run format
npm run check
npm run package:vsix

# save progress
git add -A
git commit -m "update"
git push -u origin main

Resources

Visual Studio Marketplace listing for installing the published extension.
VS Code extension publishing documentation for publisher setup, VSIX packaging, and Marketplace publishing.
VS Code extension manifest documentation for package.json extension metadata, contribution points, and Marketplace fields.
Namecheap for domain registration used in publisher identity and future verified-publisher setup.
Cloudflare for DNS management, HTTPS, and domain redirects.
Favicon.io for converting the extension icon into favicon/icon formats.
ChatGPT for initial icon generation, extension development guidance, troubleshooting, and documentation support.

Maintainer Resources

Visual Studio Marketplace publisher management for managing publisher identity, VS Code extension listings, manual VSIX uploads, reports, and publishing settings.
VS Code publishing documentation for creating a Marketplace personal access token with Marketplace Manage scope.
GitHub Actions secrets for storing a future VSCE_PAT publishing token.