OpenLightingProject / OpenLightingProject/open-fixture-library
Spot plugin errors
Open
Nobody has claimed this yet.
component-plugin
- Dominant language
- JSON
- Stars
- 258
- Forks
- 100
- Avg merge
- 11h 52m
- Merged PRs (30d)
- 53
Description
If a plugin is invalid, the thrown errors often don't make clear that this is a mistake in the plugin – you have to dig into the server code (e.g. main.js) and understand how the usage of plugins exactly works.
As we want to encourage developers to add plugins, errors in the plugins should be spotted, for example:
- Missing
nameorversionorimport/exportinmodule.exports - Bad output files object / array (e.g. 2d array)
- Duplicate output file name (which currently results in overwriting one of them)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the plugin handling in main.js and trace how plugin exports and output files are processed. Done means invalid plugins produce clear plugin-specific errors for missing metadata or exports, malformed output file structures, and duplicate output filenames.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- backend, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100