MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

Open
#250 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.4k
Forks
98
PR merge metrics
No merged PRs in 30d

Description

MagicPython currently only highlights a very small subset of the codetags from [PEP-0350](https://peps.python.org/pep-0350/):

- NOTE: A note
- XXX: Attention
- HACK: A hack
- FIXME: Problematic code
- BUG: A bug
- TODO: Pending task

I think the full list should be included in MagicPython, or at least the rest of the top-level mnemonics:

- NOBUG
- REQ
- RFE
- IDEA
- ???
- !!!
- PORT
- CAVEAT
- FAQ
- GLOSS
- SEE
- TODOC
- CRED
- STAT
- RVD

* **Editor name and version**: Visual Studio Code v1.66.2
* **Platform**: Windows 10.0.19044
* **Color scheme**: Dracula
* **MagicPython version**: 1.1.0
* **A sreenshot**:
![image](https://user-images.githubusercontent.com/356814/166968279-0c4717ec-722a-4858-9cee-2c0111582ac0.png)
* **5-10 lines of surrounding code**: Exhaustive list of mnemonics:
```python
"""
## Supported:
NOTE: A note
XXX: Attention
HACK: A hack
FIXME: Problematic code
BUG: A bug
TODO: Pending task

## Not supported:
MILESTONE:
MLSTN:
DONE:
YAGNI:
TBD:
TOBEDONE:
DEBUG:
BROKEN:
REFACTOR:
REFACT:
RFCTR:
OOPS:
SMELL:
NEEDSWORK:
INSPECT:
BUGFIX:
NOBUG:
NOFIX:
WONTFIX:
DONTFIX:
NEVERFIX:
UNFIXABLE:
CANTFIX:
REQ:
REQUIREMENT:
STORY:
RFE:
FEETCH:
NYI:
FR:
FTRQ:
FTR:
IDEA:
???:
QUESTION:
QUEST:
QSTN:
WTF:
!!!:
ALERT:
CLEVER:
MAGIC:
PORT:
PORTABILITY:
WKRD:
CAVEAT:
CAV:
CAVT:
WARNING:
CAUTION:
HELP:
FAQ:
GLOSS:
GLOSSARY:
SEE:
REF:
REFERENCE:
TODOC:
DOCDO:
DODOC:
NEEDSDOC:
EXPLAIN:
DOCUMENT:
CRED:
CREDIT:
THANKS:
STAT:
STATUS:
RVD:
REVIEWED:
REVIEW:
"""
```

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 locating MagicPython's existing codetag highlighting definitions and compare them with the PEP-0350 mnemonic list in the issue. Extend the recognized list to cover the requested top-level mnemonics, then run the project's syntax-highlighting tests or inspect highlighted Python comments to verify the new tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.