Redocly / Redocly/redocly-cli

Add some type of plugin to allow dynamic definition of extensions or config files

Open
#1,551 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

I have a use case where I run different validations on the files depending on their "state": draft, development, stable or deprecated.

I have 4 different config files for each, but I would like a plugin with a function that would receive the root element and based on the information I decide I can return an extends line or something like that.

I cannot use per-api definitions because I would have to sync the main redocly with the actual state of the files...

Do you have a way to do this?

Thanks! The tool is great and I intend to use it extensively.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the CLI's existing plugin and configuration-extension entry points. Compare the requested state-based selection of draft, development, stable, and deprecated config files with the current configuration model. Done would require a defined plugin API and documented behavior for dynamically returning an extends configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.