Configuration to turn linting on or off
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
The linter runs whenever it generates specs, which puts output in the console and adds to render time. This is a problem when used in customer facing interfaces.
Describe the solution you'd like
A configuration parameter in redocly.yaml and available on the command line which would enable (default) or disable linting.
Describe alternatives you've considered
While it's not possible to prevent linting it's possible to "hide" the errors by clearing the console in the browser via JavaScript.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing spec generation and linting configuration from redocly.yaml and the command-line entry point. Verify how linting currently runs, then make the setting enable linting by default and disable it when requested; done means both configuration paths control linting without changing other generated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100