-
Notifications
You must be signed in to change notification settings - Fork 83
Detect Swiftly Installation #1772
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
Merged
matthewbastien
merged 3 commits into
swiftlang:main
from
roulpriya:do-not-show-swiftly-install
Aug 13, 2025
Merged
Changes from all commits
Commits
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
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the VS Code Swift open source project | ||
// | ||
// Copyright (c) 2025 the VS Code Swift project authors | ||
// Licensed under Apache License v2.0 | ||
// | ||
// See LICENSE.txt for license information | ||
// See CONTRIBUTORS.txt for the list of VS Code Swift project authors | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
import { execFile } from "./utilities"; | ||
matthewbastien marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
// use `type swift` to find `swift`. Run inside /bin/sh to ensure | ||
// we get consistent output as different shells output a different | ||
// format. Tried running with `-p` but that is not available in /bin/sh | ||
export async function findBinaryPath(binaryName: string): Promise<string> { | ||
const { stdout, stderr } = await execFile("/bin/sh", [ | ||
"-c", | ||
`LC_MESSAGES=C type ${binaryName}`, | ||
]); | ||
const binaryNameMatch = new RegExp(`^${binaryName} is (.*)$`).exec(stdout.trimEnd()); | ||
if (binaryNameMatch) { | ||
return binaryNameMatch[1]; | ||
} else { | ||
throw Error( | ||
`/bin/sh -c LC_MESSAGES=C type ${binaryName}: stdout: ${stdout}, stderr: ${stderr}` | ||
); | ||
} | ||
} |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the VS Code Swift open source project | ||
// | ||
// Copyright (c) 2025 the VS Code Swift project authors | ||
// Licensed under Apache License v2.0 | ||
// | ||
// See LICENSE.txt for license information | ||
// See CONTRIBUTORS.txt for the list of VS Code Swift project authors | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
import { beforeEach, afterEach } from "mocha"; | ||
import { expect } from "chai"; | ||
matthewbastien marked this conversation as resolved.
Show resolved
Hide resolved
|
||
import * as sinon from "sinon"; | ||
import { findBinaryPath } from "../../../src/utilities/shell"; | ||
import * as utilities from "../../../src/utilities/utilities"; | ||
|
||
suite("Shell Unit Test Suite", () => { | ||
let execFileStub: sinon.SinonStub; | ||
|
||
beforeEach(() => { | ||
execFileStub = sinon.stub(utilities, "execFile"); | ||
}); | ||
|
||
afterEach(() => { | ||
sinon.restore(); | ||
}); | ||
|
||
suite("findBinaryPath", () => { | ||
test("returns the path to a binary in the PATH", async () => { | ||
execFileStub.resolves({ | ||
stdout: "node is /usr/local/bin/node\n", | ||
stderr: "", | ||
}); | ||
|
||
const binaryPath = await findBinaryPath("node"); | ||
expect(binaryPath).to.equal("/usr/local/bin/node"); | ||
expect(execFileStub).to.have.been.calledWith("/bin/sh", [ | ||
"-c", | ||
"LC_MESSAGES=C type node", | ||
]); | ||
}); | ||
|
||
test("throws for a non-existent binary", async () => { | ||
execFileStub.resolves({ | ||
stdout: "", | ||
stderr: "sh: type: nonexistentbinary: not found\n", | ||
}); | ||
|
||
try { | ||
await findBinaryPath("nonexistentbinary"); | ||
expect.fail("Expected an error to be thrown for a non-existent binary"); | ||
} catch (error) { | ||
expect(error).to.be.an("error"); | ||
expect((error as Error).message).to.include("nonexistentbinary"); | ||
} | ||
}); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
praise: great idea to reuse the existing logic