Skip to content

Tweak how the terminal is launched on Windows #814

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.

Sign up for GitHub

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

Merged
fredrikekelund merged 9 commits into from
Jan 29, 2025
Merged

Tweak how the terminal is launched on Windows #814

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
406555f
Load the default user-level environment variables in Windows terminal
fredrikekelund Jan 17, 2025
3df40cc
Merge branch 'trunk' into f26d/load-default-terminal-envvars-on-windows
fredrikekelund Jan 28, 2025
81e346f
Simplified approach
fredrikekelund Jan 28, 2025
b2a6884
Enable Windows unit tests on CI
fredrikekelund Jan 28, 2025
bbae38e
Revert "Enable Windows unit tests on CI"
fredrikekelund Jan 28, 2025
abca9ef
Restore macOS logic
fredrikekelund Jan 28, 2025
2a6281e
Tweaks
fredrikekelund Jan 28, 2025
5c4336d
Restore Linux logic
fredrikekelund Jan 28, 2025
5a900da
Fix type error
fredrikekelund Jan 28, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 50 additions & 45 deletions src/ipc-handlers.ts
View file
Open in desktop

@fredrikekelund fredrikekelund Jan 17, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I recommend viewing this diff with the Hide whitespace option enabled on GitHub, since a large part of my changes here is just re-indentation.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { exec } from 'child_process';
import { exec, ExecOptions } from 'child_process';
import crypto from 'crypto';
import {
BrowserWindow,
Expand Down Expand Up @@ -862,50 +862,9 @@ export async function getThumbnailData( _event: IpcMainInvokeEvent, id: string )
return getImageData( path );
}

export function openTerminalAtPath(
_event: IpcMainInvokeEvent,
targetPath: string,
{ wpCliEnabled }: { wpCliEnabled?: boolean } = {}
) {
return new Promise< void >( ( resolve, reject ) => {
const platform = process.platform;
const cliPath = nodePath.join( getResourcesPath(), 'bin' );

const exePath = app.getPath( 'exe' );
const appDirectory = app.getAppPath();
const appPath = ! app.isPackaged ? `${ exePath } ${ appDirectory }` : exePath;

let command: string;
if ( platform === 'win32' ) {
// Windows
if ( wpCliEnabled ) {
command = `start cmd /K "set PATH=${ cliPath };%PATH% && set STUDIO_APP_PATH=${ appPath } && cd /d ${ targetPath }"`;
} else {
command = `start cmd /K "cd /d ${ targetPath }"`;
}
} else if ( platform === 'darwin' ) {
// macOS
const loadWpCliCommand = `clear && export PATH=\\"${ cliPath }\\":$PATH && export STUDIO_APP_PATH=\\"${ appPath }\\" &&`;
const script = `
tell application "Terminal"
if not application "Terminal" is running then launch
do script "${ wpCliEnabled ? loadWpCliCommand : '' } cd ${ targetPath } && clear"
activate
end tell`;
command = `osascript -e '${ script }'`;
} else if ( platform === 'linux' ) {
// Linux
if ( wpCliEnabled ) {
command = `export PATH=${ cliPath }:$PATH && export STUDIO_APP_PATH="${ appPath }" && gnome-terminal -- bash -c 'cd ${ targetPath }; exec bash'`;
} else {
command = `gnome-terminal --working-directory=${ targetPath }`;
}
} else {
console.error( 'Unsupported platform:', platform );
return;
}

exec( command, ( error, _stdout, _stderr ) => {
function promiseExec( command: string, options: ExecOptions = {} ): Promise< void > {
return new Promise( ( resolve, reject ) => {
exec( command, options, ( error ) => {
if ( error ) {
reject( error );
return;
Expand All @@ -915,6 +874,52 @@ export function openTerminalAtPath(
} );
}

export function openTerminalAtPath(
_event: IpcMainInvokeEvent,
targetPath: string,
{ wpCliEnabled }: { wpCliEnabled?: boolean } = {}
) {
const platform = process.platform;
const cliPath = nodePath.join( getResourcesPath(), 'bin' );

const exePath = app.getPath( 'exe' );
const appDirectory = app.getAppPath();
const appPath = ! app.isPackaged ? `${ exePath } ${ appDirectory }` : exePath;

if ( platform === 'win32' ) {
const defaultShell = process.env.ComSpec || 'cmd.exe';
Comment thread
fredrikekelund marked this conversation as resolved.
const env = wpCliEnabled
? { PATH: `${ cliPath };${ process.env.PATH }`, STUDIO_APP_PATH: appPath }
: {};

return promiseExec( `start "Command Prompt" ${ defaultShell }`, {
cwd: targetPath,
env: { ...process.env, ...env },
} );
} else if ( platform === 'darwin' ) {
const loadWpCliCommand = `clear && export PATH=\\"${ cliPath }\\":$PATH && export STUDIO_APP_PATH=\\"${ appPath }\\" &&`;
const osascript = `
tell application "Terminal"
if not application "Terminal" is running then launch
do script "${ wpCliEnabled ? loadWpCliCommand : '' } cd ${ targetPath } && clear"
activate
end tell`;

return promiseExec( `osascript -e '${ osascript }'` );
} else if ( platform === 'linux' ) {
if ( wpCliEnabled ) {
return promiseExec(
`export PATH=${ cliPath }:$PATH && export STUDIO_APP_PATH="${ appPath }" && gnome-terminal -- bash -c 'cd ${ targetPath }; exec bash'`
);
}

return promiseExec( `gnome-terminal --working-directory=${ targetPath }` );
} else {
console.error( 'Unsupported platform:', platform );
return;
}
}

export async function showMessageBox(
event: IpcMainInvokeEvent,
options: Electron.MessageBoxOptions
Expand Down