search

Shopify / rubocop-sorbet

A collection of RuboCop rules for Sorbet
MIT License
181 stars 27 forks source link

Set `DocumentationBaseURL` and `DocumentationExtension` #252

Closed Earlopain closed 1 month ago

Earlopain commented 3 months ago

This allows ruby-lsp to link to cop documentation for this extension (notice the blue link which wasn't present before).

image

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 https://github.com/rubocop/rubocop/pull/13080, draft for now.

Earlopain commented 2 months ago

RuboCop made a release, so this is good to go

Earlopain commented 1 month ago

@amomchilov Let's continue this here. Automerge still seemed to be stuck, I rebased on latest main.