Skip to content

contributing.md

Latest commit

 

History

History
73 lines (50 loc) · 1.95 KB

contributing.md

File metadata and controls

73 lines (50 loc) · 1.95 KB

🇺🇸 English | 🇷🇺 Русский | 🇨🇳 中文

Adding a New Rule

You need to add a folder with the name of the newly created rule to the src/rules directory with 6 files:

  • index.ts - main file with rule logic - must export: processor (default export) and configSchema (named export)
  • index.test.ts - tests for the rule covering all configuration fields and usage examples
  • /docs/{lang}/_description.md - file with rule description
  • /docs/{lang}/_motivation.md - file with description of rule motivation with examples (in which cases it can be useful in practice)
  • /docs/{lang}/_config.md - file with rule configuration description

For detailed logs needed for debugging see "Debugging" section.

All rule names must start with an action designation.

Project Structure

src/
├── cli/          # CLI interface
├── config.ts     # Configuration and validation
├── core/         # Core logic
├── logger/       # Logging system
├── openapi.ts    # OpenAPI file handling
├── rules/        # Modification rules
└── index.ts      # Entry point

Development

Installing Dependencies

npm install

Building

npm run build

Testing

npm test

Additional Commands

  • npm run clear - Clean build directories
  • npm run format - Code formatting
  • npm run tools:generate-readme - Documentation generation
  • npm run tools:generate-rule-types - Rule types generation

Debugging

Internally uses the npm package debug for detailed logging

To output all debug logs:

DEBUG=openapi-modifier:* openapi-modifier

To output debug logs for a specific rule, for example for the remove-operation-id rule:

DEBUG=openapi-modifier:rule:remove-operation-id openapi-modifier