去除 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
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)