Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Class based usage rendering #119

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tkjaergaard
Copy link

πŸ”— #117

✨ Feature

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR is somewhat a protoype in relation to feature request #117 concerning the ability to easily extending the generation of usage output.

The current implementation is a single function that returns a string. If a user want to alter the output they have to implement the renderUsage function and make alternations. This is fragile to new updates in core implementation and makes the developer reImplement a lot of the utils functions like resolveValue, resolveArgs and formatLineColumns.

This PR allows to simply extend the RenderUsage class and override the methods they want to alter. Alternatively the can create their own class with a custom "template".

Again, it's a foundation to from where we can discuss direction and relevance πŸ™‚

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

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.

None yet

1 participant