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 VS Code command to collect issue reporting data #2456

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 16, 2024

Motivation

Inspired by #2396

Users often need to share environment information when reporting issues with the Ruby LSP extension. Currently, this process is manual and error-prone, as users manually collect different information and put them into the issue. This change aims to streamline the process and improve user experience by adding a convenient copy button to the view.

Data example

### Ruby LSP Information

#### VS Code Version

1.92.1

#### Ruby LSP Extension Version

0.7.15

#### Ruby LSP Server Version

0.17.15

#### Ruby LSP Addons



#### Ruby Version

3.3.3

#### Ruby Version Manager

chruby

#### Installed Extensions

<details>
<summary>Click to expand</summary>

- better-comments (3.0.2)
- project-manager (12.8.0)
- markdown-mermaid (1.23.1)
- vscode-markdownlint (0.55.0)
- vscode-eslint (3.0.10)
- EditorConfig (0.16.4)
- copilot (1.223.1058)
- copilot-chat (0.19.2024073102)
- remotehub (0.62.0)
- vscode-github-actions (0.26.3)
- vscode-pull-request-github (0.94.0)
- go (0.42.0)
- vscode-graphql (0.12.0)
- vscode-graphql-syntax (1.3.6)
- vscode-rdbg (0.2.2)
- vscode-clangd (0.1.29)
- debugpy (2024.10.0)
- python (2024.12.3)
- vscode-pylance (2024.8.1)
- remote-containers (0.380.0)
- remote-ssh (0.113.1)
- remote-ssh-edit (0.86.0)
- cpptools (1.21.6)
- remote-explorer (0.4.3)
- remote-repositories (0.40.0)
- material-icon-theme (5.9.0)
- ruby-extensions-pack (0.1.11)
- vscode-shadowenv (0.1.1)
- sorbet-vscode-extension (0.3.35)
- code-spell-checker (3.0.1)
- shellcheck (0.37.1)
- vim (1.27.3)
- markdown-all-in-one (3.6.2)
- ruby-lsp (0.7.15)
</details>

#### Ruby LSP Settings

<details>
<summary>Click to expand</summary>

##### Workspace

```json
{
  "erbSupport": false
}
```

##### User

```json
{
  "enableExperimentalFeatures": false,
  "enabledFeatures": {
    "codeActions": true,
    "diagnostics": true,
    "documentHighlights": true,
    "documentLink": true,
    "documentSymbols": true,
    "foldingRanges": true,
    "formatting": true,
    "hover": true,
    "inlayHint": true,
    "onTypeFormatting": true,
    "selectionRanges": true,
    "semanticHighlighting": true,
    "completion": true,
    "codeLens": true,
    "definition": true,
    "workspaceSymbol": true,
    "signatureHelp": true,
    "typeHierarchy": true
  },
  "featuresConfiguration": {},
  "rubyVersionManager": {
    "identifier": "auto"
  },
  "customRubyCommand": "",
  "formatter": "auto",
  "linters": null,
  "bundleGemfile": "",
  "testTimeout": 30,
  "branch": "",
  "pullDiagnosticsOn": "both",
  "useBundlerCompose": false,
  "bypassTypechecker": true,
  "rubyExecutablePath": "",
  "indexing": {},
  "erbSupport": false
}
```

</details>

@st0012 st0012 requested a review from a team as a code owner August 16, 2024 21:34
@st0012 st0012 added enhancement New feature or request vscode This pull request should be included in the VS Code extension's release notes labels Aug 16, 2024
@st0012 st0012 self-assigned this Aug 16, 2024
vscode/src/issueDiagnosingHelper.ts Outdated Show resolved Hide resolved
vscode/src/issueDiagnosingHelper.ts Outdated Show resolved Hide resolved
vscode/package.json Outdated Show resolved Hide resolved
@st0012 st0012 requested a review from vinistock August 19, 2024 18:02
@st0012 st0012 force-pushed the add-diagnosting-vscode-command branch from ba82b4b to cec1ccb Compare August 19, 2024 20:04
@andyw8 andyw8 changed the title Add diagnosting vscode command Add diagnosing vscode command Aug 20, 2024
@andyw8
Copy link
Contributor

andyw8 commented Aug 20, 2024

(fixed typo in PR title)

- Implement `collectRubyLspInfo` function in new `infoCollector.ts` file
- Add new command `rubyLsp.collectRubyLspInfo` in `package.json`
- Register the new command in `rubyLsp.ts`
- Collect and display information including:
  - VS Code version
  - Ruby LSP extension version
  - Ruby LSP server version
  - Installed Ruby LSP addons
  - Ruby version and version manager
  - Installed public VS Code extensions

This feature will help users and maintainers quickly gather relevant information
for reporting Ruby LSP related issues. The collected information is displayed
in the output channel for easy copying and pasting into GitHub issues.
@st0012 st0012 force-pushed the add-diagnosting-vscode-command branch from cec1ccb to 7b034e7 Compare August 20, 2024 21:39
@st0012 st0012 changed the title Add diagnosing vscode command Add VS Code command to collect issue reporting data Aug 20, 2024
@st0012 st0012 requested a review from vinistock August 20, 2024 21:45
@st0012 st0012 merged commit 980440b into main Aug 21, 2024
34 checks passed
@st0012 st0012 deleted the add-diagnosting-vscode-command branch August 21, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request vscode This pull request should be included in the VS Code extension's release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants