跳转到主要内容

将lint消息内联

项目描述

inline-plz

https://img.shields.io/pypi/v/inlineplz.svg https://img.shields.io/travis/guykisel/inline-plz.svg

厌倦了在CI控制台日志中查找lint错误?在内联diff中将lint消息内联!

  • 免费软件:ISC许可协议

Github webhook机器人

功能

  • 对您的代码运行linters,并在diff中注释失败行

  • 自动运行具有合理默认配置的linters

  • 轻松添加新的linter配置

如何使用

pip install inlineplz
inline-plz --install --autorun

您可能希望在CI作业中运行上述操作,而不是在常规开发环境中。

您还需要提供以下信息,要么在命令行中,要么通过环境变量

  • owner:仓库名称组织/所有者

  • repo:仓库名称

  • token:您的身份验证令牌(请加密此令牌,不要在任何公共配置中明文存储!)

  • url:您的源代码管理主机URL

  • interface:源代码管理主机的类型(例如github)

依赖关系

  • node.js / npm

  • ruby / gem

  • python / pip

  • haskell / cabal

配置

除了在命令行或环境变量中指定选项外,您还可以在yaml文件中设置它们。您可以在仓库的根目录中创建一个名为.inlineplz.yml的文件。

例如

ignore_paths:
  - node_modules
  - .tox
  - .git
enabled_linters:
  - prospector
disabled_linters:
  - markdownlint-cli
  - gherkin-lint

有关更多信息,请参阅仓库中的示例文件夹。

已知问题

  • 当前,inline-plz仅在原始仓库内的PR中工作,不支持来自分叉的PR。这是因为Travis-CI配置中的加密凭证是按仓库加密的,不能在分叉的PR中解密。您可以使用https://github.com/guykisel/inline-plz-bot上的webhook机器人来解决这个问题。

  • 当前,inline-plz控制台输出可能会打印出一些误导性的堆栈跟踪。

  • 当前,除非您预先创建一个虚拟环境,否则依赖项会全局安装。

  • 目前不支持直接提交到master分支 - 只支持PR进行代码检查。

贡献

  • 报告错误/建议功能

  • 添加/更新文档

  • 添加对更多代码检查工具的支持

致谢

本软件包是用Cookiecutteraudreyr/cookiecutter-pypackage项目模板创建的。

历史

0.19.0 (2016-07-17)

  • 添加过时检查

  • 配置改进

0.18.0 (2016-06-19)

  • 添加gometalinter支持

  • 在某些解析器中捕获索引错误

0.17.0 (2016-06-12)

  • 为安装添加–trusted标志

  • 在运行前清理安装目录

0.16.1 (2016-06-08)

  • 修复markdownlint路径

0.16.0 (2016-06-05)

  • 在ruby gem安装期间运行‘bundle install’

  • 用node.js markdownlint替换ruby markdownlint

  • 在yaml中启用或禁用代码检查工具

0.15.0 (2016-05-21)

  • 添加bandit支持

0.14.0 (2016-05-21)

  • 将错误输出转换为字符串

  • 使用time.time代替time.clock

  • 检查GitHub URL

  • 添加dockerfile_lint支持

  • 添加shellcheck支持

  • 使用可选的额外功能运行prospector

0.13.0 (2016-04-19)

  • 添加对gherkin-lint的支持

  • 配置rflint按文件运行

  • 将jscs的自启动设置为False

  • 更新eslint dotfiles

0.12.5 (2016-04-14)

  • 对日志进行细微改进

  • 添加显式的jscs目录排除

0.12.4 (2016-04-13)

  • 将输出编码为ASCII并替换错误

0.12.3 (2016-04-13)

  • 在setup.py中不要使用Unicode字面量

0.12.2 (2016-04-13)

  • 使用Unicode字面量而不是解码UTF-8

  • 将npm进度设置为false

0.12.1 (2016-04-12)

  • 替换解码错误

0.12.0 (2016-04-12)

  • 记录所有安装输出

  • 设置GitHub界面中每文件的最大注释数

0.11.0 (2016-03-29)

  • 告诉utf-8编码器替换错误

  • 添加Robotframework代码检查支持

0.10.1 (2016-03-16)

  • 修复.mdlrc语法

0.10.0 (2016-03-15)

  • 提高性能

0.9.0 (2016-03-14)

  • 打印安装和代码检查持续时间

0.8.2 (2016-03-11)

  • 从stylint dotfile名称中删除多余的空白

0.8.1 (2016-03-11)

  • 仅使用yaml-lint检测yaml-lint安装

0.8.0 (2016-02-29)

  • 添加–config-dir参数

  • 添加stylint支持

  • 添加默认mdl配置

0.7.5 (2016-02-22)

  • 如果未找到界面则提前退出

0.7.4 (2016-02-18)

  • 在安装过程中捕获OSError

0.7.3 (2016-02-18)

  • 不要重新运行安装命令

  • 更好的错误处理

0.7.2 (2016-02-17)

  • 处理缺失的配置文件

0.7.1 (2016-02-17)

  • 从yaml配置中加载忽略的路径

0.7.0 (2016-02-16)

  • 添加jsonlint支持

  • 添加yaml-lint支持

  • 修复按文件运行

  • 添加restructuredtest-lint支持

  • 添加markdownlint支持

0.6.0 (2016-02-12)

  • 如果未找到特定语言的dotfiles,则不自动运行

0.5.5 (2016-02-12)

  • 捕获GitHubError

0.5.4 (2016-02-12)

  • 使用os.walk而不是glob进行文件搜索

  • 在存储之前规范化消息路径

0.5.3 (2016-02-12)

  • 将代码检查工具配置文件包含在MANIFEST.in中

0.5.2 (2016-02-12)

  • 修复安装检查

0.5.1 (2016-02-12)

  • 更新部署配置

  • 更好的安装

0.5.0 (2016-02-11)

  • 取消锁定依赖项

  • 添加自启动模式

  • 在travis的python版本为2.7时进行发布

0.4.1 (2016-02-10)

  • 从ghprbPullLink中加载所有者和仓库名

0.4.0 (2016-02-08)

  • 在运行过程中捕获Exception

  • 将代码检查工具名称添加到消息内容之前

0.3.2 (2016-02-05)

  • 对于js代码检查工具,只需执行‘npm install’

0.3.1 (2016-02-05)

  • jshint xml解析修复

0.3.0 (2016-02-04)

  • 添加–max-comments参数

0.2.0 (2016-02-04)

  • 如果不在PR中或未定义GitHub,则禁用运行

0.1.1 (2016-02-03)

  • 初始版本,支持prospector、jshint、eslint、jscs

0.1.0 (2015-12-13)

  • 首次发布于PyPI。

项目详情


发布历史 发布通知 | RSS订阅

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

inlineplz-0.51.0.tar.gz (59.0 MB 查看哈希值)

上传时间 源代码

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面