✨ Minimap - Markup comments
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
Research direction
Start by locating the minimap implementation and the handling of MARK, TODO, and FIXME comments. Review the proposed alternatives with maintainers before coding, since the issue lists several possible behaviors rather than one agreed scope. Done means the selected markup-comment behavior is implemented consistently in the minimap and verified visually.
Written by the indexing model from the issue text.
Description
Description
In many code editors(like xcode, vscode etc) the minimap provides the ability to also function as a table of contents.
That is done by using the following keywords:
//MARK: Regular Mark
//MARK: - Mark with line seperator
//TODO: A todo list item.
//TODO: - A todo list item with line seperator.
//FIXME: A fixme item
//FIXME: - A fixme item with line seperator.
This picture shows how it is implemented in xcode.
Additional Context
As can be seen in the picture above, the xcode minimap doesn't differentiate between TODO and FIXME. for both it does show a line separator.
I would suggest a few changes to xcode's implementation of todo and fixme.
- Both fixme and todo are not needed. just todo is good enough.
- It might be beneficial for todos to be shown in the minimap, not just as a line. Perhaps with a smaller font or just the word todo, showing there is a todo at that place.
- I don't think a line separator is needed for todo's
- It might be nice to have one of the left side panels to be a list of all todo's. If there aren't any in the code, perhaps it can be a built-in todo list (which is currently, I believe, way out of scope and for sure a feature on its own.)
Besides the line separator there is no difference between the 2 Mark's.
Perhaps it can be considered to make the mark without line separator regular font and slightly smaller, and to keep the line-separated mark bold and large.
Screenshots
No response
- Dominant language
- Swift
- Stars
- 720
- Forks
- 162
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from CodeEditApp/CodeEditSourceEditor
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
CodeEditApp/CodeEditSourceEditor#377 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
CodeEditApp/CodeEditSourceEditor#376 · 1 comment ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
CodeEditApp/CodeEditSourceEditor#378 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
All issues in CodeEditApp/CodeEditSourceEditor
Similar issues
-
area:dictation documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
uttrflow/uttrflow-swift#1180 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
OneBusAway/onebusaway-ios#1451 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
type: docs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
googleapis/google-cloud-swift#971 ·