README Structure Checker
Validates required README sections and flags missing headings for release hygiene.
Usage
- Open the command palette in VS Code.
- Run
readme-structure-checker.run.
- 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.
| |