Skip to content

Update VS Code settings, set default terminal for macOS and Linux#2205

Merged
johlju merged 2 commits intodsccommunity:mainfrom
johlju:fix/default-shell
Sep 12, 2025
Merged

Update VS Code settings, set default terminal for macOS and Linux#2205
johlju merged 2 commits intodsccommunity:mainfrom
johlju:fix/default-shell

Conversation

@johlju
Copy link
Member

@johlju johlju commented Sep 11, 2025

Pull Request (PR) description

  • .vscode/settings.json
    • Set terminal.integrated.defaultProfile.osx and terminal.integrated.defaultProfile.linux
      to pwsh and added terminal profiles for macOS and Linux to ensure the
      integrated terminal defaults to pwsh in developer environments.

This Pull Request (PR) fixes the following issues

None

Task list

  • Added an entry to the change log under the Unreleased section of the
    file CHANGELOG.md. Entry should say what was changed and how that
    affects users (if applicable), and reference the issue being resolved
    (if applicable).
  • Resource documentation updated in the resource's README.md.
  • Resource parameter descriptions updated in schema.mof.
  • Comment-based help updated, including parameter descriptions.
  • Localization strings updated.
  • Examples updated.
  • Unit tests updated. See DSC Community Testing Guidelines.
  • Integration tests updated (where possible). See DSC Community Testing Guidelines.
  • Code changes adheres to DSC Community Style Guidelines.

This change is Reviewable

@johlju johlju requested a review from a team as a code owner September 11, 2025 17:01
@coderabbitai
Copy link

coderabbitai bot commented Sep 11, 2025

Walkthrough

Adds VS Code workspace terminal settings that set the integrated terminal default to PowerShell (pwsh) on macOS and Linux, and records this change in the changelog. No application code or runtime behavior is modified.

Changes

Cohort / File(s) Summary
Editor configuration
​.vscode/settings.json
Adds terminal.integrated.defaultProfile.osx and terminal.integrated.defaultProfile.linux set to "pwsh", and defines OS-specific terminal.integrated.profiles.* (macOS: pwsh, zsh, bash; Linux: pwsh, bash). Retains existing github.copilot.chat.codeGeneration.useInstructionFiles.
Documentation
CHANGELOG.md
Adds an Unreleased > Changed entry documenting the addition of the VS Code settings that default integrated terminal to pwsh on macOS and Linux.

Sequence Diagram(s)

(omitted — changes are configuration-only, no control-flow modifications)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The current title accurately and concisely summarizes the primary change in the PR (updating VS Code settings to set the default integrated terminal for macOS and Linux) and is specific enough for a reviewer scanning history to understand the main intent without extraneous details.
Description Check ✅ Passed The PR description clearly describes the changes to .vscode/settings.json (setting terminal.integrated.defaultProfile.osx and .linux to pwsh and adding profiles) and documents the inclusion of a CHANGELOG entry, so it is related to the changeset and satisfies this lenient check.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


📜 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 d408baa and 5053c5a.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
  • GitHub Check: PSScriptAnalyzer
  • GitHub Check: PSScriptAnalyzer

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@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: 0

🧹 Nitpick comments (1)
.vscode/settings.json (1)

135-160: Confirm pwsh availability on PATH (or document fallback paths)

On some macOS/Linux setups VS Code may not inherit a PATH containing pwsh (e.g., macOS launched from Dock). Please verify dev containers/hosts surface pwsh on PATH; otherwise consider documenting typical install paths (/opt/homebrew/bin or /usr/local/bin on macOS; /usr/bin or /snap/bin on Linux) or adding a brief note in CONTRIBUTING for users to adjust the profile path locally.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8313dbe and d408baa.

📒 Files selected for processing (2)
  • .vscode/settings.json (1 hunks)
  • CHANGELOG.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.md

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Follow Markdown formatting requirements for documentation

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

  • CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

  • Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
  • Use 2 spaces for indentation
  • Use '1.' for all items in ordered lists (1/1/1 numbering style)
  • Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
  • Empty lines required before/after code blocks and headings (except before line 1)
  • Escape backslashes in file paths only (not in code blocks)
  • Code blocks must specify language identifiers

Text Formatting

  • Parameters: bold
  • Values/literals: inline code
  • Resource/module/product names: italic
  • Commands/files/paths: inline code

Files:

  • CHANGELOG.md
CHANGELOG.md

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Always update CHANGELOG.md

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Do not add an item if there is already an existing item for the same change

Always update the CHANGELOG.md Unreleased section

Files:

  • CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

  • Always update the Unreleased section in CHANGELOG.md
  • Use Keep a Changelog format
  • Describe notable changes briefly, ≤2 items per change type
  • Reference issues using format issue #<issue_number>
  • No empty lines between list items in same section
  • Skip adding entry if same change already exists in Unreleased section
  • No duplicate sections or items in Unreleased section

Files:

  • CHANGELOG.md
**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

  • Command: Public command
  • Function: Private function
  • Resource: DSC class-based resource

Build & Test Workflow

  • Run scripts in pwsh; always from repository root
  • Build before running tests: .\build.ps1 -Tasks build
  • Always run tests in new PowerShell session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

  • Public commands: source/Public/{CommandName}.ps1
  • Private functions: source/Private/{FunctionName}.ps1
  • Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
  • Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

  • Follow instructions over existing code patterns
  • Follow PowerShell style and test guideline instructions strictly
  • Always update CHANGELOG.md Unreleased section
  • Localize all strings using string keys; remove any orphaned string keys
  • Check DscResource.Common before creating private functions
  • Separate reusable logic into private functions
  • DSC resources should always be created as class-based resources
  • Add unit tests for all commands/functions/resources
  • Add integration tests for all public commands and resources

Files:

  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
  • GitHub Check: PSScriptAnalyzer
  • GitHub Check: PSScriptAnalyzer
🔇 Additional comments (2)
CHANGELOG.md (1)

109-112: Changelog entry LGTM

Entry is under Unreleased → Changed, uses inline code for file/value names, and is concise.

.vscode/settings.json (1)

135-160: Default pwsh profiles for macOS/Linux look good

Profiles are correctly defined and defaulted to pwsh on both OSes.

@codecov
Copy link

codecov bot commented Sep 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94%. Comparing base (48e61cb) to head (5053c5a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@         Coverage Diff          @@
##           main   #2205   +/-   ##
====================================
  Coverage    94%     94%           
====================================
  Files       145     145           
  Lines      9091    9091           
====================================
  Hits       8617    8617           
  Misses      474     474           
Flag Coverage Δ
unit 94% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@johlju johlju merged commit f16d828 into dsccommunity:main Sep 12, 2025
25 checks passed
@johlju johlju deleted the fix/default-shell branch September 12, 2025 13:19
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