rokucommunity / rokucommunity/brighterscript

Warn when importing a d.bs file but using runtime stuff from them

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

Nobody has claimed this yet.

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

Description

Sometimes you can accidentally import a .d.bs file instead of a .brs or .bs file. We should help developers detect this.

There are valid use cases for wanting to import a .d.bs file (maybe?). But if there's a .brs file next to it, perhaps we should warn you about using that one instead?

Or, we could just warn when using runtime files from an imported d.bs file because they won't exist at runtime.

Also, we probably shouldn't suggest importing .d.bs files at all?

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

The issue names no files, tests, or entry points. Start by locating import resolution and handling for .d.bs, .brs, and .bs files, then clarify which warning behavior is wanted and add coverage showing that the chosen warning appears only for runtime usage that will not exist at runtime.

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
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.