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

Add kate to editors list #2375

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add kate to editors list #2375

merged 1 commit into from
Aug 7, 2024

Conversation

larskanis
Copy link
Contributor

This adds some notes, how to setup the kate editor with ruby-lsp.

Motivation

I couldn't find any information how to setup kate with ruby-lsp by google search or by inspecting ruby-lsp or kate resources.

Implementation

The config JSON is taken from the solargraph default setting of kate and adjusted to use ruby-lsp.

Automated Tests

None - the change is just documentation.

Manual Tests

I checked that the following actions work in kate:

  • go to definition
  • search references
  • hover over classes and methods to see documentation
  • extend selection, shrink selection
  • document outline shows the methods

@larskanis larskanis requested a review from a team as a code owner July 27, 2024 16:07
@larskanis larskanis requested review from andyw8 and st0012 July 27, 2024 16:07
@larskanis
Copy link
Contributor Author

I have signed the CLA!

Copy link
Member

@st0012 st0012 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Can you also update the editors list at the top of the file?

EDITORS.md Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
@st0012 st0012 added the documentation Improvements or additions to documentation label Jul 31, 2024
@andyw8
Copy link
Contributor

andyw8 commented Jul 31, 2024

For reference, here is the current config:

https://github.com/KDE/kate/blob/9e4ecb181c592a8cffdac0c66a0f3b3ebb4ac49a/addons/lspclient/settings.json#L237-L242

        "ruby": {
            "command": ["solargraph", "stdio"],
            "rootIndicationFileNames": ["Gemfile", "Gemfile.lock", "gems.rb", "gems.lock", "Rakefile"],
            "url": "https://solargraph.org",
            "highlightingModeRegex": "^Ruby$"
        },

EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
EDITORS.md Outdated Show resolved Hide resolved
@andyw8 andyw8 enabled auto-merge (squash) August 2, 2024 20:29
@andyw8 andyw8 added the server This pull request should be included in the server gem's release notes label Aug 2, 2024
This adds some notes, how to setup the kate editor with ruby-lsp.

Co-authored-by: Andy Waite <github.aw@andywaite.com>
Co-authored-by: Stan Lo <stan001212@gmail.com>
auto-merge was automatically disabled August 2, 2024 20:34

Head branch was pushed to by a user without write access

@vinistock vinistock merged commit 38c1207 into Shopify:main Aug 7, 2024
19 checks passed
@vinistock
Copy link
Member

Thank you for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation server This pull request should be included in the server gem's release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants