Skip to content

Conversation

@vinistock
Copy link
Member

Closes #588

Add documentation for extension authors. I tried to include our motivations and goals, guidelines to avoid common pitfalls and instructions on how to build an extension.

One thing that's missing is instructions for test helpers, mainly because we didn't build those yet. Is there anything else missing that would be helpful?

@vinistock vinistock added the documentation Improvements or additions to documentation label Jun 20, 2023
@vinistock vinistock added this to the 2023-Q2 milestone Jun 20, 2023
@vinistock vinistock self-assigned this Jun 20, 2023
@vinistock vinistock requested a review from a team as a code owner June 20, 2023 20:09
@github-actions
Copy link
Contributor

github-actions bot commented Jun 20, 2023

Benchmark results in seconds (slowest at top)

          textDocument/completion average: 0.258426 std_dev: 0.005002
          textDocument/diagnostic average: 0.038361 std_dev: 0.008532
      textDocument/selectionRange average: 0.003223 std_dev: 0.000339
   textDocument/documentHighlight average: 0.001661 std_dev: 0.000102
        textDocument/documentLink average: 0.001635 std_dev: 0.000113
            textDocument/codeLens average: 0.001628 std_dev: 0.000119
 textDocument/semanticTokens/full average: 0.001624 std_dev: 0.000272
      textDocument/documentSymbol average: 0.001621 std_dev: 5.0e-05
        textDocument/foldingRange average: 0.001443 std_dev: 9.7e-05
textDocument/semanticTokens/range average: 0.000828 std_dev: 4.0e-05
           textDocument/inlayHint average: 0.000575 std_dev: 4.5e-05
               codeAction/resolve average: 0.000556 std_dev: 6.1e-05
               textDocument/hover average: 0.000522 std_dev: 5.9e-05
    textDocument/onTypeFormatting average: 0.000101 std_dev: 5.0e-05
          textDocument/formatting average: 6.0e-05 std_dev: 0.000275
          textDocument/codeAction average: 3.3e-05 std_dev: 2.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
               codeAction/resolve unchanged
          textDocument/completion faster by 1.978 %
            textDocument/codeLens unchanged

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 for the detailed documentation. I think it provides enough info to help developers get started 👍
Just added a few suggestions.

@vinistock vinistock force-pushed the vs/add_server_extensions_docs branch 3 times, most recently from fb70f86 to 5e893d6 Compare June 20, 2023 21:06
@andyw8
Copy link
Contributor

andyw8 commented Jun 20, 2023

This is good but it's hard to review for ease of understanding since we are already heavily involved in Ruby LSP's development. It would be helpful to get some 'outsider' feedback.

@andyw8
Copy link
Contributor

andyw8 commented Jun 20, 2023

Should we point people to the Ruby DX Slack for help? Maybe start a #lsp-extensions channel?

@vinistock vinistock force-pushed the vs/add_server_extensions_docs branch from 5e893d6 to 6e60ba9 Compare June 21, 2023 14:40
@vinistock
Copy link
Member Author

@andyw8 great idea. I created a channel for ruby-lsp-extensions and cited it on the docs.

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.

👍

@vinistock vinistock force-pushed the vs/add_server_extensions_docs branch from 6e60ba9 to 5770c98 Compare June 21, 2023 17:36
@vinistock vinistock enabled auto-merge June 21, 2023 17:38
@vinistock vinistock merged commit 9022dfc into main Jun 21, 2023
@vinistock vinistock deleted the vs/add_server_extensions_docs branch June 21, 2023 17:41
@shopify-shipit shopify-shipit bot temporarily deployed to production June 23, 2023 15:44 Inactive
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to create server extensions and guidelines

4 participants