workbenchdev / workbenchdev/Workbench
Support XML comments when formatting code
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 844
- Forks
- 91
- Avg merge
- 7h 12m
- Merged PRs (30d)
- 1
Description
Right now, if the XML UI contains comments, they will get removed when the code is formatted (Ctrl+Shift+Return or Run).
This is quite annoying as the user might have spent time writing those comments, and they will get deleted. Fortunately it's possible to "undo" the formatting.
Let's support XML comments - for that we need
- Make ltx sax-like parser emit XML comments
- Update Workbench
formatfunction to use and append comments
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 with the ltx sax-like parser at src/parsers/ltx.js and determine how XML comments are currently handled. Then trace Workbench's format function for XML UI formatting; done means comments emitted by the parser are preserved and appended rather than removed when formatting is triggered by Ctrl+Shift+Return or Run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- desktop, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100