rokucommunity / rokucommunity/brighterscript

[bsconfig] validate jsonschema when loading the bsconfig.json files

Open
#1,142 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Summary

[bsconfig] validate bsconfig.json against the jsonschema when the json data is loaded.

Details

It would be great if the loadConfigFile utility in https://github.com/rokucommunity/brighterscript/blob/483a15454f1c8751619421ee4c99dbf4fdd073d7/src/util.ts#L168

would be able to validate the data payload in the bsconfig.json file against the json-schema defined in https://github.com/rokucommunity/brighterscript/blob/483a15454f1c8751619421ee4c99dbf4fdd073d7/bsconfig.schema.json#L4

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 reading loadConfigFile in src/util.ts and the schema in bsconfig.schema.json. Determine how the loaded bsconfig.json payload should be validated there; done means configuration data is checked against that schema when loaded.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.