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.

Copilot · 2026-03-09T19:42:10Z

README.md

+// Sideload a zip file
 rokuDeploy.sideload({
    host: 'ip-of-roku',
    password: 'password for roku dev admin portal',
-    outDir: 'folder/where/your/zip/resides/',
-    outFile: 'filename-of-your-app.zip'
+    zip: './path/to/your/app.zip'
+    //...other options if necessary
+}).then(function(){
+    //the app has been sideloaded
+}, function(error) {
+    //it failed
+    console.error(error);
+});
+
+// Sideload from a source directory (will be zipped automatically)
+rokuDeploy.sideload({
+    host: 'ip-of-roku',
+    password: 'password for roku dev admin portal',
+    rootDir: './path/to/your/project'
    //...other options if necessary
 }).then(function(){


These TypeScript examples are missing commas between properties (e.g. after zip: './path/to/your/app.zip' / rootDir: './path/to/your/project'), making them invalid code. Add the missing commas so the examples compile.

Copilot · 2026-03-09T19:42:10Z

src/commands/CaptureScreenshotCommand.ts

+        if (args.out) {
+            args.out = path.resolve(args.cwd, args.out);
+            options.screenshotDir = path.dirname(args.out);
+            options.screenshotFile = path.basename(args.out);
+        }


CaptureScreenshotCommand sets options.screenshotFile to path.basename(args.out), which includes an extension (e.g. roku-deploy.jpg). RokuDeploy.captureScreenshot() appends the device-provided extension to screenshotFile, so this will create roku-deploy.jpg.jpg. Consider stripping the extension when setting screenshotFile (and treat --out as a full path prefix).

Copilot · 2026-03-09T19:42:10Z

src/RokuDeploy.ts

+        // Resolve zip/rootDir before getOptions so outDir/outFile are set correctly
+        if (options.zip) {
+            options.zip = path.resolve(options.cwd ?? process.cwd(), options.zip);
+            options.outDir = path.dirname(options.zip);
+            options.outFile = path.basename(options.zip);
+            options.retainDeploymentArchive = true;
+        } else if (options.rootDir) {
+            options.rootDir = path.resolve(options.cwd ?? process.cwd(), options.rootDir);
+        }
+
        options = this.getOptions(options) as any;
+
+        // Close the channel before sideloading unless explicitly disabled
+        if (options.close !== false) {
+            await this.closeChannel(options as CloseChannelOptions);
+        }
+
+        // If rootDir was provided (and no zip), zip it first then sideload
+        if (!options.zip && options.rootDir) {
+            await this.zip({ dir: options.rootDir, outDir: options.outDir, outFile: options.outFile, cwd: options.cwd });
+            options.retainDeploymentArchive = false;
+        }


This code overwrites retainDeploymentArchive unconditionally (sets true when zip is provided, and later forces false when rootDir is provided). That prevents callers from honoring an explicit retainDeploymentArchive value. Only set this as a default when the caller didn’t provide a value (e.g. when retainDeploymentArchive is undefined).

Copilot · 2026-03-09T19:42:10Z

README.md

 rokuDeploy.createSignedPackage({
    host: '1.2.3.4',
    password: 'password',
-    signingPassword: 'signing password',
-    stagingDir: './path/to/staging/directory'
+    signingPassword: 'signing password'
    //...other options if necessary
 })


This TypeScript example is missing commas between properties (e.g. after signingPassword: 'signing password'), so it won’t compile as-written. Add the missing commas to keep the README examples copy/pasteable.

Copilot · 2026-03-09T19:42:11Z

README.md

 rokuDeploy.rekeyDevice({
    host: 'ip-of-roku',
    password: 'password',
-    rekeySignedPackage: './path/to/signed.pkg'
+    pkg: './path/to/signed.pkg'
    //...other options if necessary


This TypeScript example is missing a comma after pkg: './path/to/signed.pkg', making the snippet invalid. Add the trailing comma so the example compiles.

Copilot · 2026-03-09T19:42:11Z

src/commands/CreateSignedPackageCommand.ts

+        if (args.out) {
+            if (!args.out.endsWith('.pkg')) {
+                throw new Error('Out must end with a .pkg');
+            }
+            args.out = path.resolve(args.cwd, args.out);
+            options.outDir = path.dirname(args.out);
+            options.outFile = path.basename(args.out);
+        }


options.outFile is being set to the full basename including the .pkg extension. getOutputPkgFilePath() always appends .pkg when outFile doesn’t end with .zip, so this will produce filenames like my-app.pkg.pkg. Strip the extension when setting outFile (or update getOutputPkgFilePath() to treat .pkg as already-suffixed).

Copilot · 2026-03-09T19:42:11Z

src/commands/SideloadCommand.ts

        if (args.outZip) {
            options.outZip = path.resolve(args.cwd, args.outZip);
        }
-
-        if (args.ecpPort) {
-            options.remotePort = args.ecpPort;
-        }
-
-        if (args.noclose !== true) {
-            await rokuDeploy.closeChannel(options as CloseChannelOptions);
-        }
-
-
-        if (args.zip) {
-            options.retainDeploymentArchive = true;
-            await rokuDeploy.sideload(options);
-        } else if (args.rootDir) {
-            await rokuDeploy.zip(options);
-            options.retainDeploymentArchive = false;
-            await rokuDeploy.sideload(options);
-        } else {
-            throw new Error('Either zip or rootDir must be provided for sideload command');
-        }
+        await rokuDeploy.sideload(options);


The CLI exposes --outZip for sideload, but this command only resolves it into options.outZip and RokuDeploy.sideload() never reads outZip (it uses outDir/outFile). As a result --outZip currently has no effect. Map outZip into outDir/outFile (like ZipCommand does) or remove the flag from the CLI/options.

Copilot · 2026-03-09T19:42:11Z

src/RokuDeploy.ts

+        // Close the channel before sideloading unless explicitly disabled
+        if (options.close !== false) {
+            await this.closeChannel(options as CloseChannelOptions);
+        }
+
+        // If rootDir was provided (and no zip), zip it first then sideload
+        if (!options.zip && options.rootDir) {
+            await this.zip({ dir: options.rootDir, outDir: options.outDir, outFile: options.outFile, cwd: options.cwd });
+            options.retainDeploymentArchive = false;


sideload() now closes the channel by default and can also auto-zip rootDir before uploading. The existing RokuDeploy.spec.ts sideload tests currently assume a fixed number/order of doPostRequest calls; they will need to be updated and new assertions added to cover (1) close-on-by-default, (2) close: false skipping the close, and (3) rootDir triggering a zip() call.

Copilot · 2026-03-09T19:42:11Z

README.md

 //create a signed package of your project
 rokuDeploy.zip({
    outDir: 'folder/to/put/zip',
-    stagingDir: 'path/to/files/to/zip',
+    dir: 'path/to/files/to/zip',
    outFile: 'filename-of-your-app.zip'
    //...other options if necessary


The TypeScript example is not valid syntax: missing commas between object properties (e.g. after outFile: 'filename-of-your-app.zip'). Also the comment says "create a signed package" but the example calls rokuDeploy.zip(). Fix the example so it compiles and matches the API being demonstrated.

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

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 3 commits intov4from
extend-cli-conventions

MilapNaik commented Feb 26, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Copilot AI Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 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!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MilapNaik commented Feb 26, 2026 •

edited

Loading