Add config for dbt deps #1565
Merged
Add config for dbt deps #1565
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe pull request introduces a new configuration property Changes
Sequence DiagramsequenceDiagram
participant User
participant Extension
participant DBTProject
participant DependencyManager
User->>Extension: Configure project
Extension->>DBTProject: Initialize project
DBTProject->>Extension: Check installDepsOnProjectInitialization
alt Dependencies should be installed
DBTProject->>DependencyManager: installDeps(silent)
DependencyManager-->>DBTProject: Dependencies installed
else Dependencies installation disabled
DBTProject-->>Extension: Skip dependency installation
end
Possibly related PRs
Suggested reviewers
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to f85b62c in 32 seconds
More details
- Looked at
50lines of code in2files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. src/manifest/dbtProject.ts:661
- Draft comment:
TheinstallDepsfunction now accepts asilentparameter, which is used to set thefocusproperty of theinstallDepsCommand. This change is consistent with the new configuration optiondbt.installDepsOnProjectInitialization. - Reason this comment was not posted:
Confidence changes required:10%
The functioninstallDepshas been modified to accept asilentparameter, which is used to set thefocusproperty of theinstallDepsCommand. This change is consistent with the new configuration optiondbt.installDepsOnProjectInitialization.
2. src/manifest/dbtProject.ts:661
- Draft comment:
Please specify a return type for theinstallDepsfunction to improve code readability and maintainability. - Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_e0gVQpC5P2hdhyly
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/manifest/dbtProject.ts (1)
661-669: Add JSDoc documentation for the new parameter.While the implementation is correct, consider adding JSDoc documentation to describe the new
silentparameter and its purpose.+/** + * Install dbt dependencies. + * @param silent When true, prevents the installation command from focusing on the terminal + * @returns Promise that resolves when dependencies are installed + */ async installDeps(silent = false) { this.telemetry.sendTelemetryEvent("installDeps"); const installDepsCommand = this.dbtCommandFactory.createInstallDepsCommand(); if (silent) { installDepsCommand.focus = false; } return this.dbtProjectIntegration.deps(installDepsCommand); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
package.json(1 hunks)src/manifest/dbtProject.ts(2 hunks)
🔇 Additional comments (2)
package.json (1)
124-128: LGTM! Well-structured configuration property.The new configuration property is well-defined with:
- Clear description
- Appropriate default value
- Consistent naming convention
src/manifest/dbtProject.ts (1)
526-529: LGTM! Well-implemented configuration check.The implementation correctly:
- Retrieves the configuration with appropriate default
- Guards against multiple initializations using the depsInitialized flag
- Integrates smoothly with the existing rebuildManifest flow
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Problem
Describe the problem you are solving. Mention the ticket/issue if applicable.
Solution
Describe the implemented solution. Add external references if needed.
Screenshot/Demo
A picture is worth a thousand words. Please highlight the changes if applicable.
How to test
Checklist
README.mdupdated and added information about my changeImportant
Adds configuration to automatically install dbt dependencies on project initialization, with default enabled, in
DBTProjectclass.dbt.installDepsOnProjectInitializationconfiguration inpackage.jsonto control automatic installation of dbt dependencies during project initialization.true, meaning dependencies are installed by default.DBTProjectclass,rebuildManifest()method checksinstallDepsOnProjectInitializationsetting and installs dependencies if not initialized.installDeps()method to accept asilentparameter to control command focus.This description was created by
for f85b62c. It will automatically update as commits are pushed.
Summary by CodeRabbit
New Features
Configuration
dbt.installDepsOnProjectInitializationadded with default value oftrue