内联您的磁带消息
inlineplz的Python项目详细描述
直列plz
厌倦了通过ci控制台日志查找lint错误?把你的线头信息插入你的diff!
- 免费软件:ISC许可证
Github Webhook机器人
功能
- 对代码运行linter,并在失败行的diff中进行注释
- 使用合理的默认配置自动运行linter
- 易于添加新的绒布配置
如何使用
pip install inlineplz inline-plz --install --autorun
您可能希望在ci作业中运行上述内容,而不是在常规开发环境中运行。
您还需要在命令行或通过环境变量提供以下内容:
- 所有者:回购组织/所有者
- 回购:回购名称
- 令牌:您的身份验证令牌(加密此令牌,不要在任何公共配置中以明文形式放置此令牌!)
- url:scm主机的url
- 接口:单片机主机类型(如github)
依赖关系:
- node.js/npm
- 红宝石/宝石
- python/pip
- 哈斯克尔/卡巴尔
配置
除了在命令行或环境变量中指定选项外,还可以在yaml文件中设置这些选项。 您可以在回购的根目录中创建一个名为 的文件。inlineplz.yml
例如:
ignore_paths: - node_modules - .tox - .git enabled_linters: - prospector disabled_linters: - markdownlint-cli - gherkin-lint
有关更多信息,请参见repo中的examples文件夹。
已知问题
- 目前,对于travis ci的使用,内联plz只适用于原始repo中的prs,而不适用于forks中的prs。这是因为travis ci配置中的加密cred是每个repo加密的,并且不能在prs中从fork解密。您可以使用webhook bot解决这个问题,网址是https://github.com/guykisel/inline-plz-bot" rel="nofollow">https://github.com/guykisel/inline-plz bot
- 目前,内联plz控制台输出可以打印出一些误导性的堆栈跟踪
- 当前依赖项在全局范围内安装,除非预先创建virtualenv
- 当前不支持直接提交到主服务器-仅支持prs get linted
贡献
- 报告错误/建议功能
- 添加/更新文档
- 增加对更多绒布的支持
学分
这个包是用cookiecutter和项目模板创建的。