rokucommunity / rokucommunity/brighterscript

bsc new feature request: add a way to capture logs after a deploy

Open
#679 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cli enhancement help wanted
Dominant language
TypeScript
Stars
208
Forks
68
Avg merge
8h 39m
Merged PRs (30d)
39

Description

the vscode plugin is able to deploy an application to a roku device and intercept the device logs. From what I understood it spawns a telnet client that connect to the device itself.
After the connection is made even additional features are available (eg add breakpoint, do debug, etc).
Still I would find useful to add a very simple "log dumper" to bsc.

My goal is to run bsc --deploy --follow (or a better named flag) and have bsc to

  • do the actual behavior and build/deploy/start an application to a roku device
  • and also keep running until the application ends
  • and also capture the logs and show them on stdout/stderr
    (and maybe return a status code depending on how the application ended, but it's a bit out of scope)

My use-case is basically to be able to have a command line tool that is able to leverage https://github.com/georgejecook/rooibos as a "test runner"

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing bsc deploy, build, and start command, then review how the VS Code plugin connects to the Roku device and captures logs through telnet. The issue names no files or tests, so first identify the relevant CLI entry point and existing deploy flow. Done means a CLI option deploys and starts the application, follows device logs to stdout or stderr, and remains active until the application ends.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.