獻給想為 Glyphs 創作工具的人
這是字型設計軟體 Glyphs 工具程式撰寫相關的專案。 前陣子看到 官網論壇 有人在討論在 VisualStudio Code(以下簡稱 VSCode)撰寫程式碼時,透過 .pyi 格式能產生懸浮視窗說明文字的效果。剛好自己也有這方面的需求,就想到將 官方的 Python API 架構文件 翻譯成中文,並將它搬到 .pyi 檔案中。
![image](https://private-user-images.githubusercontent.com/83154914/320190522-5a5b9e8d-65ad-431b-b785-3cde8974e44a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjIzODUzODYsIm5iZiI6MTcyMjM4NTA4NiwicGF0aCI6Ii84MzE1NDkxNC8zMjAxOTA1MjItNWE1YjllOGQtNjVhZC00MzFiLWI3ODUtM2NkZTg5NzRlNDRhLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MzElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzMxVDAwMTgwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTAyZjQ5ZGUxNGJlYzUzOGZhYTc5MjNkMTYyODM1OTk0ODNkMjEzMjc4MjNlM2FmOTgyNWM4ZTFjZGU0NjAxMzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.8sE7lL9ZIi5CYN8n6FyokWC7CuSFdQ0F-F0i9g16skA)
.pyi 檔案能支援大部分程式撰寫工具使用,每款安裝方法可能不同,這裡以 VSCode 舉例:
- 在 VSCode 的延伸模組區安裝 Pylance。
- 下載本專案資料夾的 .pyi 檔(可改名或放在其他資料夾)。
- 在 VSCode 中按
shift+cmd+P
搜尋setting json
找到使用者設定的JSON檔。 - 將以下程式碼加入JSON文件
"python.analysis.stubPath": "pyi放的路徑位置",
。 - 在你正在撰寫的腳本中加入
from 剛剛的pyi檔(不用副檔名) import *
。
- 輸入時會動態排列建議詞彙,以上下方向鍵切換,可即時預覽條目內容。
- 將游標懸停在程式碼中 Glyphs 相關的詞彙上時會出現條目內容。
- 在詞彙上按住
cmd
點選可連結到原始的字典檔,觀看字典的其他條目和上下文。
目前第一版內容已經大致完成,因為是一人作業,若有發現任何疏漏或是改進的建議(檔案格式、語句詞彙疏漏或是閱讀排版)都歡迎透過 issues 分頁 提出意見。