Set DocumentationBaseURL and DocumentationExtension
#252
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
Earlopain
force-pushed
the
documentation-url
branch
from
01db1ee to
b9f0889
Compare
|
RuboCop made a release, so this is good to go |
amomchilov
reviewed
Sep 4, 2024
Earlopain
force-pushed
the
documentation-url
branch
from
b9f0889 to
87817c3
Compare
amomchilov
approved these changes
Sep 4, 2024
This allows `ruby-lsp` to link to cop documentation for this extension. Documentation here is in markdown and rubocop didn't support that until recently, so only set this when it supports both options. Otherwise it would link to non-existant html docs.
auto-merge was automatically disabled
September 4, 2024 15:08
Head branch was pushed to by a user without write access
Earlopain
force-pushed
the
documentation-url
branch
from
87817c3 to
07adee0
Compare
|
@amomchilov Let's continue this here. Automerge still seemed to be stuck, I rebased on latest main. |
Earlopain
added a commit
to Earlopain/rubocop-sorbet
that referenced
this pull request
Oct 21, 2024
``` Warning: Sorbet does not support DisabledByDefault parameter. Supported parameters are: - DocumentationBaseURL - DocumentationExtension ``` This is true. Because of Shopify#252, the top-level Sorbet config key now can be present simply by loading the config, which causes RuboCop to do some extra validating. `DisabledByDefault` is already set for all cops at the top anyways.
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.
This allows
ruby-lspto link to cop documentation for this extension (notice the blue link which wasn't present before).It takes you to https://github.com/Shopify/rubocop-sorbet/blob/main/manual/cops_sorbet.md#sorbetstrictsigil
Documentation here is in markdown and rubocop didn't support that until recently, so only set this when it supports both options. Otherwise it would link to non-existant html docs.
Requires a rubocop release with rubocop/rubocop#13080, draft for now.