MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

Abierto
#250 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
JavaScript
Estrellas
1.4k
Forks
98
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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: 
"""

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando las definiciones existentes de resaltado de codetag de MagicPython y compáralas con la lista de mnemónicos de PEP-0350 del issue. Amplía la lista reconocida para incluir los mnemónicos de nivel superior solicitados y, después, ejecuta las pruebas de resaltado de sintaxis del proyecto o inspecciona comentarios de Python resaltados para verificar las nuevas etiquetas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.