Allow toolbar buttons visibility to be configured via settings

[matthieucan]

Overview

Problem

Hi! Thanks for the great extension.

I would like the toolbar buttons to be configurable so they can be hidden. I find the long list (7 buttons) prone to misclicks, and there are some that I don't use as they are not relevant for my projects.

Solution

Make every button conditionally appear, via an associated setting. By default, they are all present, so this does not alter the current behavior.

Screenshot/Demo

A simplified toolbar with only the "Run" and "Test" buttons enabled:

How to test

• Run this branch
• Go to Settings, and uncheck the options "Enable the 'xxx' button in SQL files"
• Open an SQL file, look at the toolbar

Checklist

• [x] I have run this code and it appears to resolve the stated issue
• [ ] README.md updated and added information about my change

---

[!IMPORTANT] Toolbar buttons in SQL files are now configurable via new boolean settings in package.json, allowing users to hide unused buttons.

• Behavior:
  • Toolbar buttons in SQL files can now be conditionally hidden via new boolean settings in package.json.
  • Default behavior remains unchanged; all buttons are visible unless settings are modified.
• Settings:
  • Added settings: dbt.enableBuildModel, dbt.enableExecuteSql, dbt.enableSqlQuickPick, dbt.enableRunModel, dbt.enableTestModel, dbt.enableSqlPreview, dbt.enableConvertToModel.
• Commands:
  • Updated editor/title and editor/title/run commands to check new settings before displaying buttons.

^{This description was created by for 253ae83acc353bf294dc0204a6c4dec978510c3c. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• New Features
  • Introduced new user-configurable options to control SQL file functionalities.
  • Added the ability to enable or disable several interactive buttons for building, executing, running, testing, previewing, and converting models.
  • Enhanced control settings ensure these features are activated only when desired, providing a more customizable user experience.

[coderabbitai[bot]]

Walkthrough

This update modifies the package.json file by adding several new configuration properties under the dbt namespace. These boolean properties, all defaulting to true, allow users to enable or disable specific SQL file functionalities such as building, executing, testing, running, previewing, and converting dbt models. Additionally, the conditions for enabling related commands in the editor title sections were updated to incorporate these configuration properties.

Changes

File	Summary
package.json	Added new boolean configuration properties under dbt (enableBuildModel, enableExecuteSql, enableSqlQuickPick, enableRunModel, enableTestModel, enableSqlPreview, enableConvertToModel) with defaults set to true, and updated command conditions in editor title sections to respect these flags.
documentation/docs/setup/configuration.md	Added documentation for seven new boolean configuration options controlling the visibility and enablement of dbt-related action buttons in SQL files. No existing docs were removed or altered.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant E as Editor
    participant C as Config Checker
    participant X as Command Executor

    U->>E: Attempt to trigger SQL action (e.g., Execute SQL)
    E->>C: Check corresponding dbt configuration (e.g., dbt.enableExecuteSql)
    C-->>E: Return true/false
    alt Configuration enabled
        E->>X: Execute corresponding SQL command
        X-->>U: Command executed
    else Configuration disabled
        E-->>U: Command not available
    end

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• mdesmet
• anandgupta42

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

[!WARNING]

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd4e52532c461d914a6fef18a86534fab0be48cd and bf15394c5d63ee6e4a2b5a4eda0a8743db1b9e89.

📒 Files selected for processing (1)

• documentation/docs/setup/configuration.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• documentation/docs/setup/configuration.md

✨ Finishing Touches

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[mdesmet]

This is OOTB supported by vscode. I don't have big objection but these things are sometimes easy to overlook when maintaining the extension. So I prefer to not support any features that are already supported by vscode.

[matthieucan]

This is OOTB supported by vscode. I don't have big objection but these things are sometimes easy to overlook when maintaining the extension. So I prefer to not support any features that are already supported by vscode.

You're right! However, I think this can't be configured through .vscode/settings.json in a given project?

[anandgupta42]

@mdesmet @saravmajestic We will have to update the docs also - https://docs.myaltimate.com/setup/configuration/

[matthieucan]

@mdesmet @saravmajestic We will have to update the docs also - https://docs.myaltimate.com/setup/configuration/

Apologies for the (long) delay in getting back to you. I have now updated the documentation, thanks for the pointer!