feat: convert remaining js to ts by KazuCocoa · Pull Request #462 · appium/node-teen_process

KazuCocoa · 2025-12-20T02:48:33Z

Convert js to ts
Move export from bottom to each definition
Update package.json to refer to proper index in build

BREAKING CHANGE: TeenProcessExecOptions type respects SpawnOptions in node:child_process of timeout type
BREAKING CHANGE: Remove handleLastLines form SubProcess by following the TODO
BREAKING CHANGE: Minimize exposed properties in SubProcess

Copilot

Pull request overview

This PR completes the TypeScript migration by converting the remaining JavaScript files to TypeScript, reorganizing exports to be inline with their definitions, and updating the package configuration to properly reference the compiled output.

Key Changes:

Converted core library files (subprocess.js, exec.js, index.js) and root index.js to TypeScript
Refactored exports from centralized bottom-of-file declarations to inline exports
Updated package.json to point main entry to build/index.js and added types declaration

Reviewed changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tsconfig.json	Removed `checkJs` option and added `index.ts` to includes array for proper TypeScript compilation
package.json	Updated main entry point to `build/index.js`, added types field, and simplified files array to include build directory
index.js → index.ts	Converted to TypeScript with simple re-export from lib
lib/index.js → lib/index.ts	Converted to TypeScript with inline named exports
lib/subprocess.js → lib/subprocess.ts	Converted to TypeScript with full type annotations, generic types, and proper event handling types
lib/exec.js → lib/exec.ts	Converted to TypeScript with comprehensive type definitions for options and return values
lib/helpers.ts	Updated imports to use node: protocol and refined JSDoc to standard TypeScript documentation
lib/circular-buffer.ts	Minor formatting fix (added closing brace)
test/exec-specs.ts	Added type assertions to stdout/stderr for type safety in tests

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

lib/subprocess.ts

lib/exec.ts

lib/subprocess.ts

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

package.json

lib/exec.ts

lib/helpers.ts

lib/exec.ts

index.ts

lib/subprocess.ts

test/exec-specs.ts

KazuCocoa · 2025-12-20T18:26:00Z

Updated ✅

Copilot

Pull request overview

Copilot reviewed 11 out of 13 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

lib/subprocess.ts

lib/index.ts

lib/exec.ts

mykola-mokhnach · 2025-12-20T18:52:44Z

lib/subprocess.ts

+ *
+ * @template TSubProcessOptions - Options type extending SubProcessOptions
+ *
+ * @fires SubProcess#output - Emitted when stdout or stderr receives data


lib/subprocess.ts

lib/types.ts

mykola-mokhnach · 2025-12-20T19:28:29Z

lib/index.ts

+export {spawn} from 'node:child_process';
+export {SubProcess} from './subprocess';
+export {exec} from './exec';
+export type * from './types';


please double check if we need to export all types. I prefer to explicitly list these that need to be public as changing some in the future might create breaking behaviors

Sure, let me search types in our repo and expose only used ones

Hm, I see TeenProcessExecResult but the type is not in this class so long. Based on the usage, I assume the type is ExecResult right now. I'll update ExecResult to TeenProcessExecResult for other modules

mykola-mokhnach · 2025-12-20T19:29:17Z

lib/subprocess.ts

+  private cmd: string;
+  private opts: TSubProcessOptions;
+  private expectingExit: boolean;
+  private rep: string;


it also makes sense to add readonly to these that are not supposed to be mutated during class lifecycle

oh, nice. right

mykola-mokhnach · 2025-12-20T19:29:41Z

lib/subprocess.ts

+  async start(
+    startDetector: StartDetector<TSubProcessOptions> | number | boolean | null = null,
+    timeoutMs: number | boolean | null = null,
+    detach = false,


## [4.0.0](v3.0.6...v4.0.0) (2025-12-20) ### ⚠ BREAKING CHANGES * `TeenProcessExecOptions` type respects `SpawnOptions` in `node:child_process` of `timeout` type * Remove `handleLastLines` from SubProcess by following the TODO * Minimize exposed properties in `SubProcess` ### Features * convert remaining js to ts ([#462](#462)) ([a228fd8](a228fd8))

github-actions · 2025-12-20T19:55:59Z

🎉 This PR is included in version 4.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

KazuCocoa · 2025-12-20T19:58:20Z

Oh... some typescript uses proper ExecError so let me keep ExecError instead of TeenProcessExecResult by following existing code. Update quickly

KazuCocoa added 5 commits December 19, 2025 18:27

chore: convert js to ts

470a1ed

remove lint

05f9ee4

remove redundant config

3f579c1

modify format

56f4925

move export

7d1f7c4

KazuCocoa requested review from Copilot and mykola-mokhnach December 20, 2025 02:48

Copilot started reviewing on behalf of KazuCocoa December 20, 2025 02:49 View session

Copilot AI reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

lib/exec.ts Show resolved Hide resolved

lib/subprocess.ts Outdated Show resolved Hide resolved

lib/subprocess.ts Outdated Show resolved Hide resolved

fix lint

97f76f6

Copilot AI reviewed Dec 20, 2025

View reviewed changes

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

package.json Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/exec.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/exec.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/helpers.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/exec.ts Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

index.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

test/exec-specs.ts Outdated Show resolved Hide resolved

KazuCocoa added 4 commits December 20, 2025 09:41

chore: follow the build/lib/index.js

39e14d5

exclude types

d5ff025

revert my bad modification

d2a884f

BREAKING CHANGE: remove handleLastLines by following the TODO

8b1e3d4

KazuCocoa changed the title ~~chore: convert remaining js to ts~~ feat!: convert remaining js to ts Dec 20, 2025

KazuCocoa changed the title ~~feat!: convert remaining js to ts~~ feat: convert remaining js to ts Dec 20, 2025

KazuCocoa added 3 commits December 20, 2025 10:09

update docstring

b45bf59

update types for BufferProp to follow default false

61f4bd6

update tsconfig

06b6abe

KazuCocoa requested review from Copilot and mykola-mokhnach December 20, 2025 18:26

Copilot started reviewing on behalf of KazuCocoa December 20, 2025 18:26 View session

Copilot AI reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/index.ts Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/exec.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/subprocess.ts Outdated Show resolved Hide resolved

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

lib/types.ts Show resolved Hide resolved

KazuCocoa added 4 commits December 20, 2025 10:55

tweak format

910fe13

modify reviews

b88fa3b

use includes in test

9346dc0

modify a bit

55a1b6e

mykola-mokhnach reviewed Dec 20, 2025

View reviewed changes

mykola-mokhnach approved these changes Dec 20, 2025

View reviewed changes

KazuCocoa added 2 commits December 20, 2025 11:31

make proc as private as well

d025643

expose specific types only

27c73b8

KazuCocoa merged commit a228fd8 into main Dec 20, 2025
7 checks passed

KazuCocoa deleted the ts branch December 20, 2025 19:54

github-actions bot added the released label Dec 20, 2025

KazuCocoa mentioned this pull request Dec 20, 2025

fix: keep ExecResult instead of TeenProcessExecResult #463

Merged

Uh oh!

Conversation

KazuCocoa commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KazuCocoa commented Dec 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mykola-mokhnach Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mykola-mokhnach Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Dec 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 20, 2025

Uh oh!

KazuCocoa commented Dec 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

KazuCocoa commented Dec 20, 2025 •

edited

Loading