workbenchdev / workbenchdev/Workbench
Move previewer to introspectable library
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 844
- Forks
- 91
- Avg merge
- 7h 12m
- Merged PRs (30d)
- 1
Description
Right now we have 2 previewers:
one in JavaScript called Previewer/Internal.js for "inline preview" (preview directly in the Workbench window)
one in Vala called Previewer/External.js for "out of process" preview (preview in a separate process)
The idea here would be to rewrite the previewer as an introspectable library that can be used in different context such as workbench inline preview, windowed preview and out-of-process.
- Reduce maintenance effort by not having to implement things twice – see for example issues with "vala" tag https://github.com/sonnyp/Workbench/issues?q=is%3Aissue+is%3Aopen+label%3Avala
- Remove code duplication
- Cleaner architecture for async/out-of-process use cases
- Can be used in GNOME Builder
- Can be used easily to support more languages
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 src/Previewer/Internal.js and src/Previewer/External.js to compare the existing inline and out-of-process previewers. The work is complete when a shared introspectable previewer library can support Workbench inline, windowed, and out-of-process contexts without maintaining duplicated implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- desktop
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100