Highlight all PEP-0350 defined codetags

Offen
#250 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
tooling

Rechercherichtung

Beginne damit, MagicPythons bestehende Definitionen für die Codetag-Hervorhebung zu finden und sie mit der PEP-0350-Mnemonikliste im Issue zu vergleichen. Erweitere die Liste der erkannten Einträge, sodass sie die angeforderten Top-Level-Mnemonics abdeckt, und führe anschließend die Syntax-Highlighting-Tests des Projekts aus oder prüfe hervorgehobene Python-Kommentare, um die neuen Tags zu verifizieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

MagicPython currently only highlights a very small subset of the codetags from 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
  • 5-10 lines of surrounding code: Exhaustive list of mnemonics:
"""
## 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: 
"""
Vorherrschende Sprache
JavaScript
Sterne
1.4k
Forks
98
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus MagicStack/MagicPython

Alle Issues in MagicStack/MagicPython

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.