去除 VSCode 插件 reStructuredText 的綠色波浪線以及 D002 和 D004 錯誤
文章目錄
- 去除 VSCode 插件 reStructuredText 的綠色波浪線以及 D002 和 D004 錯誤
-
- 0. 參考資料
- 1. 背景描述
- 2. 問題起因
- 3. 解決方案
0. 參考資料
- Warnings D002 and D004 at every single line
- doc8 reports unnecessary D002 and D004 on Windows line ending
1. 背景描述
在
Win 10
平台下使用
VSCode
的
reStructuredText
插件時,
*.rst
檔案的所有文本下面都有綠色波浪線。
- 插件圖檔如下:
- 打開任意
檔案,都可以看到滿屏的綠色波浪線:*.rst
- 可見報錯提示是:
D002 Trailing whitespace
D004 Found literal carriage return
2. 問題起因
通過搜尋發現是
reStructuredText
這個插件的一個依賴
doc8
導緻了這一
bug
。
doc8
認為所有的換行都應該是
\n
,而不是
Win
系統特有的
\r\n
。
是以所有基于
Win
系統的
*.rst
檔案都會顯示
D002
和
D004
的警告,也就出現了滿屏的綠色波浪線。
目前
reStructuredText
插件的作者已經向
doc8
團隊報告了這一
bug
,并且已經有多人确認了這個
bug
,可以看到
doc8
開發團隊在
2019.5.2
日已經把該
bug
的狀态由
New
變成了
Confirmed
。
3. 解決方案
最好的解決方案應該是要等
doc8
開發團隊修複才行,目前隻有一個折中的辦法,即添加配置項讓
doc8
忽略
D002
和
D004
這兩個錯誤:
- 在
中使用VS Code
打開設定。Ctrl + ,
- 搜尋
,點選reStructuredText
Edit in settings.json
- 加入以下配置項:
"restructuredtext.linter.extraArgs": [
"--ignore D002",
"--ignore D004"
]
- 儲存配置檔案
- 再次檢視文檔,發現
和D002
報錯和綠色波浪線消失D004
完成于
2019.5.5