Skip to content

Add BeDoc core implementation with action discovery and processing pipeline#486

Open
gesslar wants to merge 1 commit into02-21-chore_update_dev_tooling_and_project_metadatafrom
02-21-refactor_add_flat-hierarchy_src_modules_with_actioneer_pipeline
Open

Add BeDoc core implementation with action discovery and processing pipeline#486
gesslar wants to merge 1 commit into02-21-chore_update_dev_tooling_and_project_metadatafrom
02-21-refactor_add_flat-hierarchy_src_modules_with_actioneer_pipeline

Conversation

@gesslar
Copy link
Owner

@gesslar gesslar commented Feb 22, 2026

This pull request introduces the core BeDoc documentation generation system with a complete modular architecture.

New Core Components:

  • BeDoc class as the main orchestrator that handles configuration validation, action discovery, contract negotiation, and file processing
  • Configuration class for validating and merging options from multiple sources (CLI, config files, environment variables, package.json)
  • Discovery class for finding and loading parser/formatter actions from node_modules and custom paths
  • Conveyor class implementing a pipeline-based file processing system with concurrency support

Action System:

  • Defines action types (parser, formatter) with metadata requirements
  • JSON schema validation for BeDoc actions at dist/schema/bedoc.action.json
  • Contract negotiation between parsers and formatters using the negotiator library

Configuration Management:

  • Comprehensive parameter definitions in ConfigurationParameters.js with validation rules
  • Support for priority-based option processing and exclusive options
  • Environment variable support with BEDOC_* prefix
  • Subconfiguration support for different project setups

CLI Interface:

  • Updated cli.js with proper error handling using Tantrum/Sass error system
  • Integration with commander.js for argument parsing
  • Schema validation loading and BeDoc instance creation

Infrastructure:

  • TypeScript declaration files generated for all components
  • Logging system with debug levels and colored output
  • Hook system for custom parsing and formatting extensions
  • File processing with glob pattern support and concurrent execution

The system provides a complete plugin-based documentation generation framework that can discover and coordinate between different parsers and formatters while maintaining strict contract validation.

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@gesslar gesslar force-pushed the 02-21-refactor_add_flat-hierarchy_src_modules_with_actioneer_pipeline branch from c35ae8b to b1aba58 Compare February 22, 2026 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant