Skip to content

Commit 2fb6107

Browse files
committed
Unblock CI check for unacceptable language
Rewords documentation and APIs that don't meet Apple's unacceptable language standards. Unblocks the CI check that runs the check-unacceptable-language.sh script. Issue: #1161
1 parent 0ca8dcf commit 2fb6107

8 files changed

+17
-14
lines changed

.unacceptablelanguageignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
NOTICE.txt
2+
src/utilities/utilities.ts
3+
src/tasks/SwiftProcess.ts

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ Merge debug adapter changes from v1.6.x prerelease builds into main release.
327327
### Fixed
328328

329329
- Ensure we catch errors when decoding `Info.plist` on Windows.
330-
- Killing of `xctest` process if testing is cancelled.
330+
- Halt `xctest` process if testing is cancelled.
331331

332332
## 1.2.0 - 2023-03-22
333333

@@ -587,14 +587,14 @@ Version 0.5.0 of vscode-swift now requires v1.65.0 of Visual Studio Code
587587
### Added
588588

589589
- Store XCTest class locations in related TestItem. This will augment source code with an icon to run all the tests in a class.
590-
- Cancellation support for tests. When you cancel a test the underlying process is killed (previously it was left running).
590+
- Cancellation support for tests. When you cancel a test the underlying process is halted (previously it was left running).
591591
- Show Test Explorer output view as soon as testing starts.
592592
- Option to enable/disable the auto-generation of launch.json configurations (default: on).
593593
- Option to add compile errors to the problems view (default: on).
594594

595595
### Changed
596596

597-
- Run non-debug test sessions outside of debugger. Now a crash test will not hang inside the debugger. Also we can stream test output to the test explorer view.
597+
- Run non-debug test sessions outside of debugger. Now a crash test will not suspend inside the debugger. Also we can stream test output to the test explorer view.
598598
- Show skipped tests as skipped, instead of passed.
599599

600600
## 0.4.0 - 2022-03-22

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To begin development on the VS Code extension for Swift you will need to install
1414
```
1515
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
1616
```
17-
More details on nvm installation can be found in the [README](https://github.com/nvm-sh/nvm/blob/master/README.md) from its GitHub repository.
17+
More details on nvm installation can be found in the [README](https://github.com/nvm-sh/nvm/?tab=readme-ov-file) from its GitHub repository.
1818

1919
Once you have installed nvm, you can clone and configure the repository.
2020

src/TestExplorer/TestExplorer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ export class TestExplorer {
249249
// get build options before build is run so we can be sure they aren't changed
250250
// mid-build
251251
const testBuildOptions = buildOptions(toolchain);
252-
// normally we wouldn't run the build here, but you can hang swiftPM on macOS
252+
// normally we wouldn't run the build here, but you can suspend swiftPM on macOS
253253
// if you try and list tests while skipping the build if you are using a different
254254
// sanitizer settings
255255
if (process.platform === "darwin" && configuration.sanitizer !== "off") {

src/tasks/SwiftProcess.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ export interface SwiftProcess {
6161
*/
6262
handleInput(s: string): void;
6363
/**
64-
* Forcefully kill the pty process. Optionally can provide a signal.
64+
* Forcefully terminate the pty process. Optionally can provide a signal.
6565
*/
66-
kill(signal?: NodeJS.Signals): void;
66+
terminate(signal?: NodeJS.Signals): void;
6767
/**
6868
* Resize the pty to match the new {@link vscode.Pseudoterminal} dimensions
6969
*
@@ -129,7 +129,7 @@ export class SwiftPtyProcess implements SwiftProcess {
129129
this.spawnedProcess?.write(s);
130130
}
131131

132-
kill(signal?: NodeJS.Signals): void {
132+
terminate(signal?: NodeJS.Signals): void {
133133
if (!this.spawnedProcess) {
134134
return;
135135
}

src/tasks/SwiftPseudoterminal.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,16 +81,16 @@ export class SwiftPseudoterminal implements vscode.Pseudoterminal, vscode.Dispos
8181
/**
8282
* Called by vscode when the user interacts with the
8383
* terminal. Here we will handle any special sequences,
84-
* ex. ctrl+c to kill, and otherwise pass the input along
84+
* ex. ctrl+c to terminate, and otherwise pass the input along
8585
* to {@link SwiftProcess.handleInput}
8686
*
8787
* @param data VT sequence as a string
8888
*/
8989
handleInput(data: string): void {
9090
const buf: Buffer = Buffer.from(data);
91-
// Kill on ctrl+c
91+
// Terminate process on ctrl+c
9292
if (buf.length === 1 && buf[0] === 3) {
93-
this.swiftProcess.kill();
93+
this.swiftProcess.terminate();
9494
} else {
9595
this.swiftProcess.handleInput(data);
9696
}
@@ -105,6 +105,6 @@ export class SwiftPseudoterminal implements vscode.Pseudoterminal, vscode.Dispos
105105
onDidClose: vscode.Event<number | void> = this.closeEmitter.event;
106106

107107
close(): void {
108-
this.swiftProcess.kill();
108+
this.swiftProcess.terminate();
109109
}
110110
}

test/MockUtils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ function replaceWithMocks<T>(obj: Partial<T>): MockedObject<T> {
118118
}
119119
} catch (error) {
120120
// Certain VSCode internals are locked behind API flags that will
121-
// throw an error if not set. Hang onto the error and throw it later
121+
// throw an error if not set. Hold onto the error and throw it later
122122
// if this property is actually accessed by the test.
123123
(error as any)._wasThrownByRealObject = true;
124124
result[property] = error;

test/fixtures.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export class TestSwiftProcess implements SwiftProcess {
7272
this.closeEmitter.fire(exitCode);
7373
}
7474

75-
kill(): void {
75+
terminate(): void {
7676
this.close(8);
7777
}
7878

0 commit comments

Comments
 (0)