Skip to content

Commit 80d7b74

Browse files
committed
Rename xcodeVersionFromSdk and improve comments/log messages
1 parent efea044 commit 80d7b74

5 files changed

Lines changed: 46 additions & 44 deletions

File tree

‎lib/entry-points.js‎

Lines changed: 5 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/languages/traced.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,7 @@ test.serial(
498498
checkExpectedLogMessages(t, logger.messages, [
499499
"Unable to determine Xcode version: Not found",
500500
"Unable to determine Xcode version from xcodebuild: Error to force next fallback",
501-
"Unable to determine Xcode version: Error to force next fallback",
501+
"Unable to determine Xcode SDK version: Error to force next fallback",
502502
]);
503503
checkUnexpectedLogMessages(t, logger.messages, [
504504
"Traced analysis is not supported on Xcode 27",

‎src/languages/traced.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Feature } from "../feature-flags";
1010
import {
1111
darwinVersion,
1212
xcodeVersionFromLink,
13-
xcodeVersionFromSdk,
13+
xcodeSdkVersion,
1414
xcodeVersionFromXcodeBuild,
1515
} from "../platform";
1616
import { ConfigurationError } from "../util";
@@ -208,7 +208,7 @@ export async function checkRunnerSupportsTracedAnalysis(
208208
const xcodeVer =
209209
xcodeVersionFromLink(action.logger) ??
210210
(await xcodeVersionFromXcodeBuild(action.logger)) ??
211-
(await xcodeVersionFromSdk(action.logger));
211+
(await xcodeSdkVersion(action.logger));
212212

213213
if (
214214
xcodeVer !== undefined &&

‎src/platform.test.ts‎

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
darwinVersion,
1313
XCODE_SELECT_LINK_PATH,
1414
xcodeVersionFromLink,
15-
xcodeVersionFromSdk,
15+
xcodeSdkVersion,
1616
xcodeVersionFromXcodeBuild,
1717
} from "./platform";
1818
import {
@@ -298,7 +298,7 @@ test.serial(
298298
);
299299

300300
test.serial(
301-
"xcodeVersionFromSdk returns undefined for non-zero exit code",
301+
"xcodeSdkVersion returns undefined for non-zero exit code",
302302
async (t) => {
303303
const logger = new RecordingLogger();
304304

@@ -308,7 +308,7 @@ test.serial(
308308
const toolrunnerStub = sinon.stub(toolrunner, "ToolRunner").returns(runner);
309309

310310
await t.notThrowsAsync(async () => {
311-
const result = await xcodeVersionFromSdk(logger);
311+
const result = await xcodeSdkVersion(logger);
312312

313313
t.is(result, undefined);
314314

@@ -325,41 +325,38 @@ test.serial(
325325
},
326326
);
327327

328-
test.serial(
329-
"xcodeVersionFromSdk extracts version from xcrun stdout",
330-
async (t) => {
331-
const logger = new RecordingLogger();
328+
test.serial("xcodeSdkVersion extracts version from xcrun stdout", async (t) => {
329+
const logger = new RecordingLogger();
332330

333-
const which = sinon.stub(io, "which").resolves("/path/to/xcrun");
331+
const which = sinon.stub(io, "which").resolves("/path/to/xcrun");
334332

335-
let stdoutListener: ((data: Buffer) => void) | undefined = undefined;
336-
const exec = sinon.stub<[], Promise<number>>().callsFake(async () => {
337-
if (stdoutListener !== undefined) {
338-
stdoutListener(Buffer.from("26.5"));
339-
}
340-
return 0;
341-
});
342-
const runner = sinon.createStubInstance(toolrunner.ToolRunner, { exec });
333+
let stdoutListener: ((data: Buffer) => void) | undefined = undefined;
334+
const exec = sinon.stub<[], Promise<number>>().callsFake(async () => {
335+
if (stdoutListener !== undefined) {
336+
stdoutListener(Buffer.from("26.5"));
337+
}
338+
return 0;
339+
});
340+
const runner = sinon.createStubInstance(toolrunner.ToolRunner, { exec });
343341

344-
const toolrunnerStub = sinon
345-
.stub(toolrunner, "ToolRunner")
346-
.callsFake((_cmd, _args, opts: ExecOptions) => {
347-
stdoutListener = opts.listeners?.stdout;
348-
return runner;
349-
});
342+
const toolrunnerStub = sinon
343+
.stub(toolrunner, "ToolRunner")
344+
.callsFake((_cmd, _args, opts: ExecOptions) => {
345+
stdoutListener = opts.listeners?.stdout;
346+
return runner;
347+
});
350348

351-
await t.notThrowsAsync(async () => {
352-
const result = await xcodeVersionFromSdk(logger);
349+
await t.notThrowsAsync(async () => {
350+
const result = await xcodeSdkVersion(logger);
353351

354-
t.not(result, undefined);
355-
t.is(result?.major, 26);
356-
t.is(result?.minor, 5);
352+
t.not(result, undefined);
353+
t.is(result?.major, 26);
354+
t.is(result?.minor, 5);
357355

358-
t.is(which.callCount, 1);
359-
t.deepEqual(which.args[0], ["xcrun", true]);
356+
t.is(which.callCount, 1);
357+
t.deepEqual(which.args[0], ["xcrun", true]);
360358

361-
t.is(toolrunnerStub.callCount, 1);
362-
t.is(exec.callCount, 1);
363-
});
364-
},
365-
);
359+
t.is(toolrunnerStub.callCount, 1);
360+
t.is(exec.callCount, 1);
361+
});
362+
});

‎src/platform.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,12 +186,13 @@ export async function xcodeVersionFromXcodeBuild(
186186
}
187187

188188
/**
189-
* Tries to determine the version of Xcode that is installed by running `xcrun --sdk macosx --show-sdk-version`.
189+
* Tries to determine the version of the Xcode SDK that is installed by running
190+
* `xcrun --sdk macosx --show-sdk-version`.
190191
*
191192
* @param logger The logger to use.
192-
* @returns The Xcode version or `undefined` if it couldn't be determined.
193+
* @returns The Xcode SDK version or `undefined` if it couldn't be determined.
193194
*/
194-
export async function xcodeVersionFromSdk(
195+
export async function xcodeSdkVersion(
195196
logger: Logger,
196197
): Promise<semver.SemVer | undefined> {
197198
try {
@@ -236,7 +237,9 @@ export async function xcodeVersionFromSdk(
236237

237238
return version;
238239
} catch (err) {
239-
logger.debug(`Unable to determine Xcode version: ${getErrorMessage(err)}`);
240+
logger.debug(
241+
`Unable to determine Xcode SDK version: ${getErrorMessage(err)}`,
242+
);
240243
return undefined;
241244
}
242245
}

0 commit comments

Comments
 (0)