feat(openapi): a fresh coat of paint on openapi inspect
#1127
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
added
enhancement
erunion
commented
Dec 21, 2024
| let msg: string; | ||
| msg = `You have a total of ${chalk.bold(info.found)} ${pluralize(info.name.toLowerCase(), info.found)} in your API.`; | ||
| if (info.found > 100) { | ||
| msg += ` ${chalk.cyanBright('Wow! 🤯')}`; |
There was a problem hiding this comment.
iffy on the emoji but thought it might be fun for the true Big API sickos if this stood out a bit more. also might bump this 100 operation threshold up to maybe 200 because after this week of debugging failed API uploads 100 operations in a single file seems so small
erunion
commented
Dec 21, 2024
| report.push( | ||
| table(tableData, { | ||
| border: tableBorder, | ||
| columns: { | ||
| 0: { | ||
| width: 26, |
There was a problem hiding this comment.
This caps the "Feature" table column to a specific width, which because the second "Used" one doesn't have variable content, causes the width of every table to now be identical.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
The biggest problem I've had since originally building our
openapi inspectcommand has been that the tables between OpenAPI and ReadMe features aren't of consistent widths. Drives me up a damn wall.So I'm giving a fresh coat of paint to this command that deserves some love.
I also made a couple minor readability to how we construct this table because the code was a bit gnar with some deeply nested
array.push()calls.🧬 QA & Testing
This is what it all looks like: