Carry over changes from cli by MilapNaik · Pull Request #233 · rokucommunity/roku-deploy

MilapNaik · 2026-02-26T14:52:47Z

Extend CLI changes from #202 to Rokudeploy.ts. Done mostly by Claude Code.

Copilot

Pull request overview

This PR carries forward recent CLI argument/behavior changes (from #202) into the underlying RokuDeploy.ts API and command implementations, aligning option names and expanding sideload() behavior.

Changes:

Renames options across the API to match CLI (remotePort → ecpPort, ZipOptions.stagingDir → dir, rekeySignedPackage → pkg).
Moves/centralizes path resolution logic into command classes and RokuDeploy.sideload().
Updates docs/changelog to reflect the new option names and sideload close behavior.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/commands/ZipCommand.ts	Adds `cwd` defaulting and resolves `--out`/`--dir` paths before calling `zip()`.
src/commands/StageCommand.ts	Maps `--out` to `stagingDir` for `stage()`.
src/commands/SideloadCommand.ts	Resolves `zip/rootDir/outZip` paths and forwards options to `sideload()`.
src/commands/RekeyDeviceCommand.ts	Adds `cwd` defaulting and resolves `--pkg` to an absolute path.
src/commands/CreateSignedPackageCommand.ts	Adds `cwd` defaulting and parses `--out` into `outDir/outFile`.
src/commands/CaptureScreenshotCommand.ts	Adds `cwd` defaulting and parses `--out` into `screenshotDir/screenshotFile`.
src/cli.ts	Removes inline argument post-processing; updates `sideload` flag to `--close/--no-close`; switches to `ecpPort`.
src/RokuDeployOptions.ts	Renames `remotePort` → `ecpPort` and `rekeySignedPackage` → `pkg`.
src/RokuDeploy.ts	Implements `ZipOptions.dir`; switches ECP usage to `ecpPort`; enhances `sideload()` (zip/rootDir support + channel close).
src/RokuDeploy.spec.ts	Updates tests for renamed options (`pkg`, `dir`, `ecpPort`).
README.md	Updates CLI/API docs for renamed options and new `sideload` behavior.
CHANGELOG.md	Adds `4.0.0-alpha.3` breaking-change notes covering the renames and sideload changes.

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

You can also share your feedback on Copilot code review. Take the survey.

…h the actual file extension.

…user.

…a bit to better align with cli

…oad in rokudeploy

MilapNaik · 2026-04-10T20:13:16Z

@copilot Can you take a look at these changes and make sure it:

Consolidates CLI and programmatic flows so that they are consistent regardless of how a user chooses to use this package
The uses themselves are bug-free and accomplish what they set out to do as defined from the docstrings and function names

…eSignedPackageOptions, add missing tests Agent-Logs-Url: https://github.com/rokucommunity/roku-deploy/sessions/634b6c5a-0fb7-4407-8625-8c25cf7f84ce Co-authored-by: MilapNaik <7122945+MilapNaik@users.noreply.github.com>

Agent-Logs-Url: https://github.com/rokucommunity/roku-deploy/sessions/634b6c5a-0fb7-4407-8625-8c25cf7f84ce Co-authored-by: MilapNaik <7122945+MilapNaik@users.noreply.github.com>

Copilot · 2026-04-10T20:28:40Z

@copilot Can you take a look at these changes and make sure it:

Consolidates CLI and programmatic flows so that they are consistent regardless of how a user chooses to use this package
...

I reviewed the CLI and programmatic flows and found the following issues, which I've fixed in commit 10aedc1:

Bug: retainDeploymentArchive default not working for rootDir — When sideload() was called with rootDir, the generated zip was incorrectly retained by default instead of being deleted. The options.retainDeploymentArchive ??= false was placed after getOptions(), which had already set it to true (the global default). Fixed by moving the ??= false assignment into the rootDir branch before getOptions() is called, matching how the zip branch sets ??= true upfront.
Type: outFile missing from CreateSignedPackageOptions — CreateSignedPackageCommand sets outFile when the user provides --out, but the programmatic CreateSignedPackageOptions interface didn't declare outFile. Added it so both flows are type-safe and consistent.
Tests: improved coverage — The existing "does not delete the archive by default" test was ambiguous (used rootDir but expected the file to be retained, which only worked due to the bug above). Split into two clear tests:
- does not delete a pre-built zip by default (uses zip option → retained)
- deletes the generated archive by default when using rootDir (uses rootDir → deleted)
Also added:
- skips closeChannel when close is false
- triggers zip when rootDir is provided

TwitchBronBron · 2026-04-13T17:30:26Z


        if (imageUrlOnDevice) {
-            saveFilePath = util.standardizePath(path.join(options.screenshotDir, options.screenshotFile + imageExt));
+            const userExt = ['.jpg', '.png'].includes(path.extname(options.screenshotFile).toLowerCase()) ? path.extname(options.screenshotFile) : undefined;


Let's have a flag called autoExtension. The default is false. When false, use the filename EXACTLY as provided by the user. no extnesion comparing or swapping, etc.

When true:

if the user supplied name ends with the extension from the device, use their name completely

if the user supplied name doees not end with the extension from the deviec but is either .png or jpeg, swap the file extension

otherwise, append the device extension to the end of the user supplied filename

MilapNaik added 3 commits February 26, 2026 09:50

Carry over changes from cli. Done by Claude Code.

ec0cf04

fix tests for RekeySignedPackage variable name

07b892c

Fix more variable names to match cli arguments

b3d77b2

MilapNaik changed the title ~~Carry over changes from cli. Done by Claude Code.~~ Carry over changes from cli Feb 26, 2026

MilapNaik requested a review from Copilot March 9, 2026 19:35

Copilot started reviewing on behalf of MilapNaik March 9, 2026 19:35 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

MilapNaik and others added 19 commits April 1, 2026 16:41

Fix possibility of extension being double added in screenshotFile

04fb94c

Add a warning if user's screenshot extension exists and does not matc…

cc0d95c

…h the actual file extension.

Check for acceptable extensions

7a774f3

Don't duplicate .pkg file extension if it is already provided by the …

b117007

…user.

Add a test around duplicating .pkg

ac64036

Fix most sideload tests based on the close channel being added

391df4c

Fix rokudeploy tests for sideload since it has changed functionality …

4a4760c

…a bit to better align with cli

Only set retainDeploymentArchive if user did not set it.

02231e4

Remove sideload command tests since that functionality moved to sidel…

b131607

…oad in rokudeploy

Fix renaming variables in cli tests

80fedff

Fix the rest of the cli tests that are missing cwd

38deaeb

Merge branch 'v4' into extend-cli-conventions

e6d9b07

Delete rogue console log

eb28dd3

Fix some failing tests

7cd5caa

Simplify options with the use of 2 base options

fe44634

getting ecp network access wasn't working, fixed

9c7ed27

More simplifying options logic using base options packages

3279db1

Fix test

debff13

Fix minor inconsistencies between cli and programmatic paths

bd6e8b6

Copilot started work on behalf of MilapNaik April 10, 2026 20:13 View session

Copilot AI and others added 2 commits April 10, 2026 20:27

Rename test for consistency

10aedc1

Agent-Logs-Url: https://github.com/rokucommunity/roku-deploy/sessions/634b6c5a-0fb7-4407-8625-8c25cf7f84ce Co-authored-by: MilapNaik <7122945+MilapNaik@users.noreply.github.com>

Copilot finished work on behalf of MilapNaik April 10, 2026 20:29

Minor adjustments to copilot

817630a

MilapNaik marked this pull request as ready for review April 13, 2026 16:20

MilapNaik requested a review from TwitchBronBron April 13, 2026 16:20

Clean up the key event interfaces

4045903

TwitchBronBron reviewed Apr 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Carry over changes from cli#233

Carry over changes from cli#233
MilapNaik wants to merge 26 commits intov4from
extend-cli-conventions

MilapNaik commented Feb 26, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MilapNaik commented Apr 10, 2026

Uh oh!

Copilot AI commented Apr 10, 2026

Uh oh!

TwitchBronBron Apr 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

MilapNaik commented Feb 26, 2026 • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MilapNaik commented Apr 10, 2026

Uh oh!

Copilot AI commented Apr 10, 2026

Uh oh!

TwitchBronBron Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MilapNaik commented Feb 26, 2026 •

edited

Loading