使用flake8标记文件中的lints python代码块
flake8-markdown的Python项目详细描述
雪花8降价
使用^{
这个包通过确保代码示例没有错误，帮助改进python项目的文档。
功能
- lints代码块包含常规python和python解释器代码（^{
} ） - pre-commit提交时挂钩到lint
安装
flake8标记可以使用pip或您选择的包管理器从pypi安装：
pip install flake8-markdown
用法
cli
您可以使用flake8-markdown命令将flake8标记作为cli工具。
flake8-markdown接受一个或多个globs作为其参数。
示例：
$ flake8-markdown flake8-markdown "tests/samples/*.md"tests/samples/emphasized_lines.md:6:1: F821 undefined name 'emphasized_imaginary_function'tests/samples/basic.md:8:48: E999 SyntaxError: EOL while scanning string literaltests/samples/basic.md:14:7: F821 undefined name 'undefined_variable'
预提交挂钩
也可以使用pre-commit将flake8-markdown添加到项目中。配置后，运行git commit后，将使用flake8-markdown对任何暂存标记文件进行lint。
要在本地存储库中启用此钩子，请将以下repo添加到.pre-commit-config.yaml文件中：
# .pre-commit-config.yamlrepos:-repo:https://github.com/johnfraney/flake8-markdownrev:v0.2.0hooks:-id:flake8-markdown
行为准则
在项目的代码库、问题跟踪程序、聊天室和邮件列表中进行交互的每个人都应该遵循PyPA Code of Conduct。
历史记录
[0.2.0]-2019-06-14
添加了
- ^{
} 代码块支持
[0.1.1]-2019-05-19
已更改
- 修复了自述文件中的预提交示例
[0.1.0]-2019-05-19
已添加
- 添加了初始版本的代码
欢迎加入QQ群-->： 979659372
