rokucommunity / rokucommunity/brighterscript

[CLI] --dry command to print out matched files and dest paths

Open
#1,713 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

It can be quite difficult to discern & debug bsconfig files arrays that are not working (when you expect them to work).

  • The only way to identify valid "pkg:/ paths produced by a bsconfig is to generate a build or experiment with auto-complete suggestions.
  • Neither option is viable if the bsc language extension or bsconfig file(s) are throwing errors

Proposed solution:

  • a command or flag (such as --dry or --files that prints out the list of
    • (1) the src files that are matched
    • (2) the resulting dest pkg:/ file paths
  • this command should not fail due to validation errors unless the error prevents the successful parsing of the files bsconfig data

note:
i'm gonna take a stab at implementing this today/tomorrow

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 at the CLI entry point that parses bsconfig files and follow the existing handling of the files array, including how matched sources become pkg:/ destinations. Run the proposed dry-run command against a bsconfig with valid and invalid settings; done means it prints both matched source files and destination paths while only failing when the files data cannot be parsed.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.