rokucommunity / rokucommunity/brighterscript

Force scope.name to be lower case

Open
#1,478 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There are several locations that compare scope.name, but we have to .toLowerCase() them. It would be good to establish a convention where scope.name is forced to lower case at construction, or store an all-lower-case version for these types of comparisons.

We should do an audit of the project to see how frequently we use scope.name. This could be a breaking change, but realistically people shouldn't be depending on scope.name, rather just using it to compare if scope is same as other scope.

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 auditing all project uses of scope.name and the locations where scopes are constructed, as requested in the issue. Compare the existing lower-case comparisons and determine whether construction-time normalization or a separate lower-case value is appropriate, including the breaking-change impact. Done means scope-name comparisons no longer need repeated lower-casing and the affected behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.