Redocly / redocly-cli

βš’οΈ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
https://redocly.com/docs/cli/
MIT License
849 stars 129 forks source link

feat: lint arazzo test descriptions #1601

Open DmitryAnansky opened 4 days ago

DmitryAnansky commented 4 days ago

What/Why/How?

Add Arazzo validation to the lint cli command. Now it is possible to lint Arazzo description file by running redocly lint museum.yaml

Reference

Testing

Screenshots (optional)

Check yourself

Security

changeset-bot[bot] commented 4 days ago

πŸ¦‹ Changeset detected

Latest commit: 687a1c637a9425b7ebcb1d9da6f538bac6470f2a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages | Name | Type | | --------------------- | ----- | | @redocly/openapi-core | Minor | | @redocly/cli | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions[bot] commented 4 days ago
Command Mean [ms] Min [ms] Max [ms] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 992.0 Β± 14.2 964.8 1016.7 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 998.8 Β± 20.2 974.4 1032.5 1.01 Β± 0.02
github-actions[bot] commented 4 days ago

Coverage report

St.:grey_question:
Category Percentage Covered / Total
🟑 Statements 77.36% 4538/5866
🟑 Branches 67.74% 2495/3683
🟑 Functions 70.92% 751/1059
🟑 Lines 77.56% 4273/5509
Show new covered files 🐣
|
St.:grey_question:
| File | Statements | Branches | Functions | Lines | | :----------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------ | :--------- | :------- | :-------- | :---- | | 🟒 |
`...` / arazzo.ts
| 100% | 100% | 100% | 100% |
Show files with reduced coverage πŸ”»
|
St.:grey_question:
| File | Statements | Branches | Functions | Lines | | :----------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------- | :------------------------------------------------------------ | :------------------------------------------------------------- | :-------- | :------------------------------------------------------------ | | 🟑 |
`...` / config.ts
| 69.87% | 76.76% | 67.86% | 69.5% | | 🟒 |
`...` / oas-types.ts
|
95.45% (-2.05% πŸ”»)
|
90.32% (-3.01% πŸ”»)
| 100% |
95.45% (-2.05% πŸ”»)
| | 🟒 | core/src/index.ts | 100% | 100% | 8.93% | 100% |

Test suite run success

748 tests passing in 105 suites.

Report generated by πŸ§ͺjest coverage report action from f712153947b8e2b483d659bbc6d7f07abe07585c