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.

Sign up for GitHub

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

Jump to bottom

Add editors file with instructions on how to set up the Ruby LSP #545

Merged
merged 1 commit into from
Mar 6, 2023
Merged

Add editors file with instructions on how to set up the Ruby LSP #545

merged 1 commit into from
Mar 6, 2023

Conversation

vinistock
Copy link
Member

@vinistock vinistock commented Mar 6, 2023 •
edited
Loading

Motivation

The community is adding instructions on how to set up the Ruby LSP in different editors. Emacs was recently added and we have a long running discussion on how to configure NeoVim in #188.

We should add a list to make it easier to discover these instructions here in the repo.

Implementation

Added an EDITORS.md file and linked it from the readme. I wanted to properly link it using YARD, so that EDITORS.md was treated like an actual page rather than a file in the repository, but I couldn't quite figure it out. Does anyone know how to do that?

@vinistock vinistock added the chore Chore task label Mar 6, 2023
@vinistock vinistock requested a review from a team as a code owner March 6, 2023 18:10
@vinistock vinistock self-assigned this Mar 6, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2023 

Benchmark results in seconds (slowest at top)

          textDocument/formatting average: 0.111359 std_dev: 0.026468
          textDocument/diagnostic average: 0.040798 std_dev: 0.003914
      textDocument/selectionRange average: 0.00362 std_dev: 0.000818
   textDocument/documentHighlight average: 0.001418 std_dev: 0.000247
        textDocument/foldingRange average: 0.00141 std_dev: 8.0e-05
 textDocument/semanticTokens/full average: 0.00082 std_dev: 0.000165
textDocument/semanticTokens/range average: 0.00059 std_dev: 2.5e-05
               textDocument/hover average: 0.00054 std_dev: 0.000204
        textDocument/documentLink average: 0.000506 std_dev: 0.000162
           textDocument/inlayHint average: 0.0004 std_dev: 8.6e-05
      textDocument/documentSymbol average: 0.000226 std_dev: 4.8e-05
    textDocument/onTypeFormatting average: 0.000103 std_dev: 0.00017
          textDocument/codeAction average: 2.6e-05 std_dev: 2.8e-05


================================================================================
Comparison with main branch:

 textDocument/semanticTokens/full unchanged
textDocument/semanticTokens/range unchanged
      textDocument/documentSymbol unchanged
        textDocument/foldingRange unchanged
          textDocument/formatting unchanged
          textDocument/diagnostic unchanged
        textDocument/documentLink unchanged
           textDocument/inlayHint unchanged
      textDocument/selectionRange unchanged
   textDocument/documentHighlight unchanged
               textDocument/hover unchanged
          textDocument/codeAction unchanged
    textDocument/onTypeFormatting unchanged

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2023 

Benchmark results in seconds (slowest at top)

          textDocument/formatting average: 0.115756 std_dev: 0.027409
          textDocument/diagnostic average: 0.041965 std_dev: 0.004235
      textDocument/selectionRange average: 0.003677 std_dev: 0.001018
   textDocument/documentHighlight average: 0.001449 std_dev: 0.000319
        textDocument/foldingRange average: 0.001443 std_dev: 7.0e-05
 textDocument/semanticTokens/full average: 0.000849 std_dev: 0.000189
textDocument/semanticTokens/range average: 0.000611 std_dev: 2.1e-05
               textDocument/hover average: 0.000555 std_dev: 0.000281
        textDocument/documentLink average: 0.000521 std_dev: 0.000165
           textDocument/inlayHint average: 0.000404 std_dev: 9.2e-05
      textDocument/documentSymbol average: 0.000241 std_dev: 5.0e-05
    textDocument/onTypeFormatting average: 0.000106 std_dev: 0.000183
          textDocument/codeAction average: 2.6e-05 std_dev: 2.8e-05


================================================================================
Comparison with main branch:

 textDocument/semanticTokens/full unchanged
textDocument/semanticTokens/range unchanged
      textDocument/documentSymbol unchanged
        textDocument/foldingRange unchanged
          textDocument/formatting unchanged
          textDocument/diagnostic unchanged
        textDocument/documentLink unchanged
           textDocument/inlayHint unchanged
      textDocument/selectionRange unchanged
   textDocument/documentHighlight unchanged
               textDocument/hover unchanged
          textDocument/codeAction unchanged
    textDocument/onTypeFormatting unchanged

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2023 

Benchmark results in seconds (slowest at top)

          textDocument/formatting average: 0.141982 std_dev: 0.031245
          textDocument/diagnostic average: 0.05081 std_dev: 0.007606
      textDocument/selectionRange average: 0.004543 std_dev: 0.001142
   textDocument/documentHighlight average: 0.00173 std_dev: 0.000551
        textDocument/foldingRange average: 0.001663 std_dev: 0.00024
 textDocument/semanticTokens/full average: 0.00085 std_dev: 0.000255
               textDocument/hover average: 0.000656 std_dev: 0.000323
textDocument/semanticTokens/range average: 0.000647 std_dev: 0.00026
        textDocument/documentLink average: 0.000625 std_dev: 0.000223
           textDocument/inlayHint average: 0.000433 std_dev: 0.000133
      textDocument/documentSymbol average: 0.000257 std_dev: 0.000105
    textDocument/onTypeFormatting average: 0.000139 std_dev: 0.00027
          textDocument/codeAction average: 3.7e-05 std_dev: 4.7e-05


================================================================================
Comparison with main branch:

 textDocument/semanticTokens/full unchanged
textDocument/semanticTokens/range unchanged
      textDocument/documentSymbol unchanged
        textDocument/foldingRange unchanged
          textDocument/formatting unchanged
          textDocument/diagnostic unchanged
        textDocument/documentLink unchanged
           textDocument/inlayHint unchanged
      textDocument/selectionRange unchanged
   textDocument/documentHighlight unchanged
               textDocument/hover unchanged
          textDocument/codeAction unchanged
    textDocument/onTypeFormatting unchanged

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2023 

Benchmark results in seconds (slowest at top)

          textDocument/formatting average: 0.114684 std_dev: 0.027868
          textDocument/diagnostic average: 0.042245 std_dev: 0.004202
      textDocument/selectionRange average: 0.003609 std_dev: 0.000978
   textDocument/documentHighlight average: 0.001448 std_dev: 0.000294
        textDocument/foldingRange average: 0.001434 std_dev: 8.0e-05
 textDocument/semanticTokens/full average: 0.00084 std_dev: 0.000193
textDocument/semanticTokens/range average: 0.00061 std_dev: 3.4e-05
               textDocument/hover average: 0.000549 std_dev: 0.000236
        textDocument/documentLink average: 0.000522 std_dev: 0.000188
           textDocument/inlayHint average: 0.000409 std_dev: 9.2e-05
      textDocument/documentSymbol average: 0.000238 std_dev: 5.1e-05
    textDocument/onTypeFormatting average: 0.00011 std_dev: 0.000216
          textDocument/codeAction average: 2.7e-05 std_dev: 2.9e-05


================================================================================
Comparison with main branch:

 textDocument/semanticTokens/full unchanged
textDocument/semanticTokens/range unchanged
      textDocument/documentSymbol unchanged
        textDocument/foldingRange unchanged
          textDocument/formatting unchanged
          textDocument/diagnostic unchanged
        textDocument/documentLink unchanged
           textDocument/inlayHint unchanged
      textDocument/selectionRange unchanged
   textDocument/documentHighlight unchanged
               textDocument/hover unchanged
          textDocument/codeAction unchanged
    textDocument/onTypeFormatting unchanged

andyw8
andyw8 reviewed Mar 6, 2023
View reviewed changes
README.md Show resolved Hide resolved
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2023 

Benchmark results in seconds (slowest at top)

          textDocument/formatting average: 0.114708 std_dev: 0.026565
          textDocument/diagnostic average: 0.043301 std_dev: 0.003982
      textDocument/selectionRange average: 0.0037 std_dev: 0.001006
   textDocument/documentHighlight average: 0.001449 std_dev: 0.000292
        textDocument/foldingRange average: 0.001426 std_dev: 8.7e-05
 textDocument/semanticTokens/full average: 0.000828 std_dev: 0.000182
textDocument/semanticTokens/range average: 0.000602 std_dev: 3.6e-05
               textDocument/hover average: 0.000553 std_dev: 0.000239
        textDocument/documentLink average: 0.000519 std_dev: 0.000198
           textDocument/inlayHint average: 0.000409 std_dev: 9.1e-05
      textDocument/documentSymbol average: 0.000228 std_dev: 4.9e-05
    textDocument/onTypeFormatting average: 0.000108 std_dev: 0.000189
          textDocument/codeAction average: 2.7e-05 std_dev: 2.9e-05


================================================================================
Comparison with main branch:

 textDocument/semanticTokens/full unchanged
textDocument/semanticTokens/range unchanged
      textDocument/documentSymbol unchanged
        textDocument/foldingRange unchanged
          textDocument/formatting unchanged
          textDocument/diagnostic unchanged
        textDocument/documentLink unchanged
           textDocument/inlayHint unchanged
      textDocument/selectionRange unchanged
   textDocument/documentHighlight unchanged
               textDocument/hover unchanged
          textDocument/codeAction unchanged
    textDocument/onTypeFormatting unchanged

@vinistock vinistock merged commit c12dd2a into main Mar 6, 2023
@vinistock vinistock deleted the vs/add_editors branch March 6, 2023 20:35
@shopify-shipit shopify-shipit bot temporarily deployed to production March 20, 2023 15:01 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andyw8 andyw8 andyw8 left review comments

@paracycle paracycle paracycle approved these changes

Assignees

@vinistock vinistock

Labels
chore Chore task
Projects
None yet
Milestone
Improving the Ruby DX 2023 - Milestone 1
Development

Successfully merging this pull request may close these issues.
3 participants
@vinistock @andyw8 @paracycle