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 VSCode tasks for building nativeaudio #168

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

neilenns
Copy link
Collaborator

@neilenns neilenns commented Mar 4, 2025

Adds three VSCode tasks related to building the native audio DLL:

  • CMake - Generate build files: Runs the cmake -S command
  • CMake - Build NativeAudio (Debug): Runs the cmake --build command with --config Debug
  • CMake - Build NativeAudio (Release): Runs the cmake --build command with --config Release

The last two are dependent on the first to ensure the build files are always fresh prior to building the DLL.

These can be invoked with the Task: Run Task command in VSCode:

image

Summary by CodeRabbit

  • New Features
    • Introduced new build capabilities to generate build files and compile the NativeAudio project.
    • Enabled streamlined Debug and Release build options.
    • Existing build workflows for other projects remain unchanged.

@neilenns neilenns requested a review from justinshannon as a code owner March 4, 2025 22:52
Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Walkthrough

The pull request modifies the .vscode/tasks.json file by adding new shell tasks for the NativeAudio project. Three tasks have been introduced: one to generate build files using CMake and two to build the NativeAudio project in Debug and Release configurations. These new tasks depend on the generation step, while the existing tasks for building the vATIS.Desktop and DevServer projects remain unchanged.

Changes

File Changes Summary
.vscode/tasks.json Added three new shell tasks:
- CMake - Generate build files
- CMake - Build NativeAudio (Debug)
- CMake - Build NativeAudio (Release)
Tasks use CMake commands with dependencies and problem matchers, while existing .NET project tasks remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant TaskRunner as VSCode Task Runner
    participant Gen as CMake Generate Task
    participant BuildDebug as CMake Build (Debug)
    participant BuildRelease as CMake Build (Release)

    Dev->>TaskRunner: Initiate NativeAudio build
    TaskRunner->>Gen: Execute "CMake - Generate build files"
    Gen-->>TaskRunner: Build files generated
    TaskRunner->>BuildDebug: Run "CMake - Build NativeAudio (Debug)"
    BuildDebug-->>TaskRunner: Debug build complete
    TaskRunner->>BuildRelease: Run "CMake - Build NativeAudio (Release)"
    BuildRelease-->>TaskRunner: Release build complete
Loading

Suggested reviewers

  • justinshannon

Poem

Hopping through code with a joyful beat,
My bunny paws tap at each new feat.
CMake tasks spring to life in debug and release,
Building NativeAudio with elegance and ease.
A rabbit's cheer for code so neat!
🐇✨


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?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 43207f9 and cc8463c.

📒 Files selected for processing (1)
  • .vscode/tasks.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build (macos-latest)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (1)
.vscode/tasks.json (1)

24-36: Approved addition of the "CMake - Generate build files" task.
This new task is correctly configured to generate build files using CMake with clear arguments and appropriate problem matchers.

Comment on lines +47 to +55
{
"type": "shell",
"label": "CMake - Build NativeAudio (Release)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Release"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
"dependsOn": ["CMake - generate build files"]
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

⚠️ Potential issue

Fix dependency label casing for the Release build task.
Similar to the Debug build task, the "dependsOn" field here references "CMake - generate build files" with incorrect casing. Update it to the correct label "CMake - Generate build files".

-            "dependsOn": ["CMake - generate build files"]
+            "dependsOn": ["CMake - Generate build files"]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{
"type": "shell",
"label": "CMake - Build NativeAudio (Release)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Release"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
"dependsOn": ["CMake - generate build files"]
}
{
"type": "shell",
"label": "CMake - Build NativeAudio (Release)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Release"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
"dependsOn": ["CMake - Generate build files"]
}

Comment on lines +38 to +46
{
"type": "shell",
"label": "CMake - Build NativeAudio (Debug)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Debug"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
"dependsOn": ["CMake - generate build files"]
},
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

⚠️ Potential issue

Fix dependency label casing for the Debug build task.
The "dependsOn" field is set to "CMake - generate build files" while the actual task label is "CMake - Generate build files". Since VSCode task dependencies are case sensitive, please update it to match exactly.

-            "dependsOn": ["CMake - generate build files"]
+            "dependsOn": ["CMake - Generate build files"]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{
"type": "shell",
"label": "CMake - Build NativeAudio (Debug)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Debug"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
"dependsOn": ["CMake - generate build files"]
},
{
"type": "shell",
"label": "CMake - Build NativeAudio (Debug)",
"command": "cmake",
"args": ["--build", "./NativeAudio/out", "--config", "Debug"],
"group": "build",
"problemMatcher": ["$gcc", "$msCompile"],
- "dependsOn": ["CMake - generate build files"]
+ "dependsOn": ["CMake - Generate build files"]
},

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