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 custom terminal executable settings #973

Merged
merged 3 commits into from May 26, 2023

Conversation

brianignacio5
Copy link
Collaborator

Description

Add idf.customTerminalExecutable and idf.customTerminalExecutableArgs to customize the shell executable and shell arguments used in the extension tasks. By default it will use the vscode configured terminal.

Added them also to ESP-IDF: Doctor command output.

Shell arguments are also required as specified in VSCODE API for ShellExecutionOptions :

  • The arguments to be passed to the shell executable used to run the task. Most shells
    * require special arguments to execute a command. For example bash requires the -c
    * argument to execute a command, PowerShell requires -Command and cmd requires both
    * /d and /c.

Fixes #935

Type of change

  • New feature (non-breaking change which adds functionality)

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Click on "ESP-IDF: Monitor your device" with idf.customTerminalExecutable not defined.
  2. Execute action.
  3. Observe results. You should see in the output that terminal used is the same as vscode configured terminal.
  4. Set idf.customTerminalExecutable in settings.json to any custom terminal like /bin/bash and required idf.customTerminalExecutableArgs like ["-c" ] for Bash or corresponding for commands.
  5. Click on "ESP-IDF: Monitor your device" and ESP-IDF: Build your project commands. Check in the output that is using the custom terminal executable.

How has this been tested?

Manual testing

Test Configuration:

  • ESP-IDF Version: 5.0
  • OS (Windows,Linux and macOS): macOS

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

@brianignacio5 brianignacio5 self-assigned this May 16, 2023
@github-actions
Copy link

github-actions bot commented May 16, 2023

Download the artifacts for this pull request:

Copy link
Collaborator

@radurentea radurentea left a comment

Choose a reason for hiding this comment

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

LGTM

@brianignacio5 brianignacio5 merged commit 9caeb73 into master May 26, 2023
5 checks passed
@brianignacio5 brianignacio5 deleted the enhance/customize-terminal branch May 26, 2023 08:30
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.

[Feature Request]: Allowing manually specify which terminal edf runs on (VSC-1086)
2 participants