rokucommunity / rokucommunity/brighterscript

Improve the type checking for node fields that accept multiple value types

Open
#1,193 0 comments 0 reactions 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

#1191 provided relief for some of the pain points of node fields that accept more data types, but ideally we could improve many of these field types to accept a subset of values. For example, translation can only accept a string literal value that looks like an array, an array, or perhaps a variable of type string (when we don't know what the value actually is). We should do more extensive testing to find all the edge cases for these fields, and improve the type system accordingly.

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 reviewing the changes from #1191 and the existing node-field type checking behavior. Enumerate edge cases for fields such as translation, add extensive tests for accepted values, and refine the type system so each field accepts only its supported subset.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.