Skip to content

Refresh VS Code extension docs#2404

Open
DjamilaBaroudi wants to merge 4 commits into
mainfrom
curitiba
Open

Refresh VS Code extension docs#2404
DjamilaBaroudi wants to merge 4 commits into
mainfrom
curitiba

Conversation

@DjamilaBaroudi

Copy link
Copy Markdown
Contributor

The VS Code extension docs had drifted from the current extension. This refresh:

  • Updates configuration.md with the actual settings (folding, path separator, SQLFluff, CLI auto-update, telemetry, run-option defaults, sensor mode, query preview, query timeout, default exclude tag).
  • Fixes the panel list in panel-overview.md and getting-started.md (it said "two/three panels" and missed Table Diff and Run History).
  • Adds short Query Preview / Table Diff / Run History sections to overview.md.
  • Adds panel pages for Table Diff and Run History, and links them (plus the existing Activity Bar page) in the sidebar.

Update the settings list, panels overview, and getting-started to match the
current extension, and add Table Diff and Run History panel pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
docs/vscode-extension/configuration.md:7
All other settings in this file use camelCase (e.g., `bruin.pathSeparator`, `bruin.cli.autoUpdate`), but `bruin.FoldingState` starts with an uppercase `F`. VS Code setting keys are case-sensitive when referenced directly in `settings.json`, so if the actual key is `bruin.foldingState` this would fail silently for anyone who tries to set it manually. Please verify the casing against the extension's `package.json` declaration.

```suggestion
- **Folding State** (`bruin.foldingState`): Whether Bruin sections are folded or expanded by default when you open an asset. Options: `folded`, `expanded`.
```

### Issue 2 of 2
docs/vscode-extension/configuration.md:32
A default of `1000` seconds (~16.7 minutes) for query timeout is unusually high. Could you confirm this is intentional and not meant to be milliseconds or a smaller number of seconds? If it is correct, a brief note explaining why (e.g. "suitable for large dataset queries") would help users calibrate their own settings.

Reviews (1): Last reviewed commit: "Refresh VS Code extension docs" | Re-trigger Greptile

### General

Choose whether Bruin sections are folded or expanded by default when opening an asset. Adjust this in the extension settings under `Bruin > Default Folding State`. The options are:
- **Folding State** (`bruin.FoldingState`): Whether Bruin sections are folded or expanded by default when you open an asset. Options: `folded`, `expanded`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 All other settings in this file use camelCase (e.g., bruin.pathSeparator, bruin.cli.autoUpdate), but bruin.FoldingState starts with an uppercase F. VS Code setting keys are case-sensitive when referenced directly in settings.json, so if the actual key is bruin.foldingState this would fail silently for anyone who tries to set it manually. Please verify the casing against the extension's package.json declaration.

Suggested change
- **Folding State** (`bruin.FoldingState`): Whether Bruin sections are folded or expanded by default when you open an asset. Options: `folded`, `expanded`.
- **Folding State** (`bruin.foldingState`): Whether Bruin sections are folded or expanded by default when you open an asset. Options: `folded`, `expanded`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/vscode-extension/configuration.md
Line: 7

Comment:
All other settings in this file use camelCase (e.g., `bruin.pathSeparator`, `bruin.cli.autoUpdate`), but `bruin.FoldingState` starts with an uppercase `F`. VS Code setting keys are case-sensitive when referenced directly in `settings.json`, so if the actual key is `bruin.foldingState` this would fail silently for anyone who tries to set it manually. Please verify the casing against the extension's `package.json` declaration.

```suggestion
- **Folding State** (`bruin.foldingState`): Whether Bruin sections are folded or expanded by default when you open an asset. Options: `folded`, `expanded`.
```

How can I resolve this? If you propose a fix, please make it concise.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Verified against the extension's package.json (line 161): the key really is bruin.FoldingState with a capital F. It's an inconsistency in the extension itself, but the docs must match the actual key, so keeping it as-is — switching to foldingState would be the silent-failure case you flagged.

Comment thread docs/vscode-extension/configuration.md Outdated

The extension provides checkbox settings to control default enabled/disabled states for various features:
- **Preview Selected Query** (`bruin.query.previewSelectedQuery.enabled`): show the "Preview selected query" CodeLens when you select text in a SQL file. On by default.
- **Query Timeout** (`bruin.query.timeout`): timeout in seconds for query execution. Defaults to `1000`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 A default of 1000 seconds (~16.7 minutes) for query timeout is unusually high. Could you confirm this is intentional and not meant to be milliseconds or a smaller number of seconds? If it is correct, a brief note explaining why (e.g. "suitable for large dataset queries") would help users calibrate their own settings.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/vscode-extension/configuration.md
Line: 32

Comment:
A default of `1000` seconds (~16.7 minutes) for query timeout is unusually high. Could you confirm this is intentional and not meant to be milliseconds or a smaller number of seconds? If it is correct, a brief note explaining why (e.g. "suitable for large dataset queries") would help users calibrate their own settings.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Confirmed intentional — it's in seconds. Added a note clarifying the unit and that the large default is deliberate (so big queries aren't cut off).

Add run options and backfill to the General tab docs, and a Commands &
Shortcuts page covering the command palette actions and the preview shortcut.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Reviews (2): Last reviewed commit: "Document run options, backfill, and comm..." | Re-trigger Greptile

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Reviews (3): Last reviewed commit: "Document variable overrides in the Gener..." | Re-trigger Greptile

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Reviews (4): Last reviewed commit: "Clarify query timeout units in VS Code d..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant