ROADMAP.md

✅ 1.0 MVP

• Add github action for versioning and releasing
• implement unit tests for converters

1.1 Refinement

• Better cmd description and help texts
• Alternative config path via --config flag
• @error tag should not be required in JSDoc comments with default config
  • You can change this behavior via config if needed
  • sourceFile.requireErrorTag config option

1.2 Easy Setup

• swerr init interactive command to create a swerr.config.js based on user input
  • add --yes flag to skip prompts and create a default config file

1.3 Easy Configuration

• swerr add converter <converter-name> command to add converters to the configuration
• swerr remove converter <converter-name> command to remove converters from the configuration

2.0 Polish & CI-ready

• Config Overrides via CLI flags, for example:
  • --set sourceFile.inputDir=src to override input directory
  • --set converter[0].config.fileName=errors.html to override converter configurations
• --dry-run flag to simulate the generation process without creating files
• Custom scan rules for source files
  • Allow users to define regex-based scan rules in swerr.config.js
  • Extract values from file content and map them to tags (e.g. httpCode = 404 → @http 404) to reduce manual tagging
  • Configurable conflict behavior when tags already exist

3.0 Advanced Features

• swerr watch command to monitor source files for changes and automatically regenerate documentation
• swerr doctor command to check the configuration and environment for potential issues