Skip to content

feat: new rule scalar-property-missing-example#705

Merged
tatomyr merged 15 commits intomasterfrom
feat/scalar-property-missing-example
May 25, 2022
Merged

feat: new rule scalar-property-missing-example#705
tatomyr merged 15 commits intomasterfrom
feat/scalar-property-missing-example

Conversation

@RomanHotsiy
Copy link
Copy Markdown
Member

@RomanHotsiy RomanHotsiy commented May 25, 2022

What/Why/How?

This is a useful rule to ensure every scalar property has an example defined.

Reference

Slack discussion: https://redoc-ly.slack.com/archives/C02UHE7EL3E/p1653357899168609

Testing

TODO

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 25, 2022

Coverage report

Total coverage

Status Category Percentage Covered / Total
🟡 Statements 65.92% 2636/3999
🟡 Branches 60.01% 1445/2408
🔴 Functions 57.79% 419/725
🟡 Lines 66.16% 2438/3685

Status of coverage: 🟢 - ok, 🟡 - slightly more than threshold, 🔴 - under the threshold

Show new covered files 🌑

Coverage of new files

Status Filename Statements Branches Functions Lines
🟢 home/runner/work/redocly-cli/redocly-cli/packages/core/src/rules/common/scalar-property-missing-example.ts 80.95% 80% 75% 84.21%

Status of coverage: 🟢 - ok, 🟡 - slightly more than threshold, 🔴 - under the threshold

Report generated by 🧪jest coverage report action from 47c0cf6

@tatomyr tatomyr self-assigned this May 25, 2022
@roman-sainchuk roman-sainchuk force-pushed the feat/scalar-property-missing-example branch 3 times, most recently from 8136dea to 53f1b64 Compare May 25, 2022 09:18
@tatomyr tatomyr force-pushed the feat/scalar-property-missing-example branch from ab30b30 to 6c89b63 Compare May 25, 2022 14:10
@tatomyr tatomyr force-pushed the feat/scalar-property-missing-example branch from 553ce80 to 47c0cf6 Compare May 25, 2022 14:34
@tatomyr tatomyr merged commit d27d02f into master May 25, 2022
@tatomyr tatomyr deleted the feat/scalar-property-missing-example branch May 25, 2022 14:50
@tatomyr tatomyr mentioned this pull request May 25, 2022
5 tasks
@adamaltman
Copy link
Copy Markdown
Member

🕺

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.

6 participants