rokucommunity / rokucommunity/brighterscript

Detect overwritting ContentNode interface fields

Open
#174 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It would be great if we can have some warning when we overwrite an existing interface field of the ContentNode. I think that all of the fields are listed here.

Reason for this is that mistakenly overwriting ContentNode fields can lead to all sorts of unexpected results, I, for example, had an issue with TimeGrid component where I've been manually setting TITLE, PLAYDURATION and PLAYSTART fields to a content node used for EPG program, and this led to TimeGrid not displaying any programs at all. It's mindblowing that BrightScript doesn't display any warning when this happens.

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 with the linked Roku Content Metadata documentation to enumerate the existing ContentNode fields, then trace the compiler's handling of ContentNode assignments. Cover the TITLE, PLAYDURATION, and PLAYSTART EPG/TimeGrid case with a diagnostic test; done means overwriting an existing field produces a warning.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.