Skip to content
| Marketplace
Sign in
Visual Studio Code>Linters>README Structure CheckerNew to Visual Studio Code? Get it now.
README Structure Checker

README Structure Checker

VaultOps

|
3 installs
| (0) | Free
Validates required README sections and flags missing headings for release hygiene.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

README Structure Checker

Validates required README sections and flags missing headings for release hygiene.

Usage

  1. Open the command palette in VS Code.
  2. Run readme-structure-checker.run.
  3. The command shows a notification and applies lightweight text hygiene helpers.

Local development

npm install
npm run build
npm test

Press F5 in VS Code to launch an Extension Development Host and test the command.

Packaging

npm run package

This generates a source bundle zip for release automation.

Marketplace submission notes

  • Set a real publisher in package.json.
  • Replace placeholder assets in assets/ (icon + screenshots).
  • Use dist-submission/ files for listing fields and release upload.

Support

For support, contact support@example.com.

UI Settings Module

  • Adds extension settings under VS Code preferences.
  • Default setting: trim trailing whitespace on command run.

Storage Module

  • Includes src/storage.ts using ExtensionContext.globalState.
  • Stores local run counters only.
  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2026 Microsoft