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(core): add documentUrl to JS api and cli formatters #2443
base: develop
Are you sure you want to change the base?
feat(core): add documentUrl to JS api and cli formatters #2443
Conversation
Should we add the docuemtnUrl type here stoplightio/types#127? |
thanks for raising this PR, we've just recently added documentationUrls to our ruleset and would find this really useful 👍 |
@magicmatatjahu @smoya @jonaslagoni any update on this? |
I dont get why we are assigned tbh. @P0lip this is a core change, while it does change something for the AsyncAPI rules, this is all you 😄 |
👋🏼 @dweber019 First of all, I would like to apologize for the delay in responding to your pull request. We appreciate your valuable contribution to the project. We understand your intention to output the documentation URL as part of the lint process. However it may clutter the output and become repetitive. Additionally, not all organizations utilize the documentation URL, and some prefer using the description field. With that in mind, we would like to propose a couple of alternative options: Add the functionality to output the documentationURL behind the --verbose flag. This would make it an opt-in feature, giving users the choice to include the documentation URL in their lint output. The downside to this approach is that it may not cater to organizations that use the description field instead of the documentationURL. Thank you once again for your contribution, and we look forward to collaborating with you on this feature. |
Thx for the feedback. I agree with you. It depends on the use case.
For our use case, the first one would satisfy our needs and makes IMHO more sense, as the documentation url or description is needed in case of error mostly on CI side, where you don't like to rerun a command to understand the error. |
dc9d7f4
to
44c40e2
Compare
02ec0d4
to
84faec8
Compare
@dweber019 Thanks you for raising this issue and for your contribution. I have a similar requirement to make use of the documenationUrl property in Javascript. @mnaumanali94 Any idea if this PR will be accepted and merged anytime soon? Cheers! |
9e92f34
to
6d09915
Compare
dc90b7a
to
c22f408
Compare
I would lean towards this |
Fixes #1488.
Checklist
Does this PR introduce a breaking change?
Screenshots
All formatters have been updated.