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
1a04f25 to
dc90b7a
Compare
6e15f43 to
08ba0bc
Compare
|
LGTM! |
|
@jonaslagoni @smoya could someone of you check this pr. Thanks a lot |
jonaslagoni
left a comment
There was a problem hiding this comment.
@jonaslagoni @smoya could someone of you check this pr. Thanks a lot
As mentioned earlier, no need for us to review core changes that affects AsyncAPI rules or outputs of it 🙂
|
Any update on this? Would really appreciate this feature so we can produce better HTML reports that link to our documentation |
|
@dweber019 I've reviewed and this is looking good. I've also resolved the merge conflicts and merged in the latest from Some of the documentation-url tests are failing. Could you take a look and we can make sure to get this merged and released? |
|
@dweber019 gentle nudge on this. Would you be able to take a stab at fixing the tests. |
# @stoplight/spectral-formatters [1.5.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-formatters-1.4.3...@stoplight/spectral-formatters-1.5.0) (2025-04-22) ### Features * **core:** add documentUrl to JS api and cli formatters ([#2443](#2443)) ([e787728](e787728))
# [6.15.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-cli-6.14.3...@stoplight/spectral-cli-6.15.0) (2025-04-22) ### Bug Fixes * **deps:** bump elliptic from 6.6.0 to 6.6.1 ([#2782](#2782)) ([5ff9602](5ff9602)) * **repo:** replace discord link with forum link ([#2793](#2793)) ([6229442](6229442)) ### Features * **core:** add documentUrl to JS api and cli formatters ([#2443](#2443)) ([e787728](e787728)) * **functions:** add or function ([#2798](#2798)) ([d9ef27f](d9ef27f))
# [1.20.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-core-1.19.5...@stoplight/spectral-core-1.20.0) (2025-04-22) ### Bug Fixes * **deps:** bump elliptic from 6.6.0 to 6.6.1 ([#2782](#2782)) ([5ff9602](5ff9602)) * **deps:** fix yarn lockfile ([e6c3b9d](e6c3b9d)) * **deps:** update spectral-core in cli ([35687cd](35687cd)) * **repo:** replace discord link with forum link ([#2793](#2793)) ([6229442](6229442)) ### Features * **core:** add documentUrl to JS api and cli formatters ([#2443](#2443)) ([e787728](e787728)) * **functions:** add or function ([#2798](#2798)) ([d9ef27f](d9ef27f))
|
🎉 This PR is included in version 1.20.0 🎉 The release is available on Your semantic-release bot 📦🚀 |
# [1.10.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-functions-1.9.4...@stoplight/spectral-functions-1.10.0) (2025-04-22) ### Bug Fixes * **deps:** bump elliptic from 6.6.0 to 6.6.1 ([#2782](#2782)) ([5ff9602](5ff9602)) * **deps:** fix yarn lockfile ([e6c3b9d](e6c3b9d)) * **deps:** update spectral-core in cli ([35687cd](35687cd)) * **repo:** replace discord link with forum link ([#2793](#2793)) ([6229442](6229442)) ### Features * **core:** add documentUrl to JS api and cli formatters ([#2443](#2443)) ([e787728](e787728)) * **functions:** add or function ([#2798](#2798)) ([d9ef27f](d9ef27f))
# [1.22.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-rulesets-1.21.4...@stoplight/spectral-rulesets-1.22.0) (2025-04-22) ### Bug Fixes * **deps:** bump elliptic from 6.6.0 to 6.6.1 ([#2782](#2782)) ([5ff9602](5ff9602)) * **deps:** fix yarn lockfile ([e6c3b9d](e6c3b9d)) * **deps:** update spectral-core in cli ([35687cd](35687cd)) * **repo:** replace discord link with forum link ([#2793](#2793)) ([6229442](6229442)) ### Features * **core:** add documentUrl to JS api and cli formatters ([#2443](#2443)) ([e787728](e787728)) * **functions:** add or function ([#2798](#2798)) ([d9ef27f](d9ef27f))
Fixes #1488.
Checklist
Does this PR introduce a breaking change?
Screenshots
All formatters have been updated.