MagicStack / MagicStack/MagicPython

Highlight all PEP-0350 defined codetags

未關閉
#250 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
JavaScript
星號
1.4k
分支
98
PR 合併指標
30 天內沒有已合併 PR

描述

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

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先定位 MagicPython 現有的 codetag 強調顯示定義,並將其與 issue 中的 PEP-0350 助記符清單進行比較。擴充已辨識的清單,使其涵蓋所要求的頂層助記符,接著執行專案的語法強調顯示測試,或檢查已強調顯示的 Python 註解,以驗證新的標籤。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript
領域
tooling
Issue 類型
功能
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。