Skip to main content

robotsframework纯文本文件的静态分析工具

项目描述

欢迎使用机器人框架 Lint

机器人框架纯文本文件的静态分析。

这是一个机器人框架纯文本文件的静态分析工具。

安装说明

首选的安装方法是使用 pip:

$ pip install –升级机器人框架-lint

这将安装一个名为“rflint”的包和一个名为“rflint”的可执行文件

运行 linter

要运行,请使用命令“rflint”,或者使用 python 的-m选项来运行 rflint 模块。添加一个或多个文件名作为参数,这些文件将被检查是否违反规则。

自定义规则

规则是简单的 python 类。有关如何编写规则的更多信息,请参阅 [robotframework-lint wiki]( https://github.com/boakley/robotframework-lint/wiki )

参数文件

rflint 支持参数文件的方式与机器人框架非常相似。您可以在文件中每行放置一个参数,并使用选项 -A–argument-file引用该文件。

参数文件是创建一组要应用于文件的规则和规则配置的便捷方式。

例子

$ rflint myTestSuite.robot

要查看所有内置规则的列表,请运行以下命令

$ rflint –列表

要查看文档,请添加 –verbose 选项:

$ rflint –list –verbose

一些规则是可配置的。例如,要配置“LineTooLong”规则以标记长度超过 80 个字符的行(默认为 100),您可以使用配置选项更改默认值:

$ rflint – 配置 LineTooLong:80 myTestSuite.robot

您可以禁用任何规则,或使用选项–warning、–error 和–ignore 将其配置为警告或错误。例如,要忽略 LineTooLong 规则,您可以这样做:

$ rflint –忽略 LineTooLong myTestSuite.robot

要查看所有命令行选项的列表,请使用–help选项:

$ python -m rflint –帮助

示例输出:

$ python -m rflint myTestSuite.robot + myTestSuite.robot W: 2, 0: 没有套件文档 (RequireSuiteDocumentation) E: 15, 0: 没有关键字文档 (RequireKeywordDocumentation)

这在第 2 行字符 0 上显示警告,其中应该有套件文档但没有。它还在第 15 行字符 0 上显示错误,其中应该有关键字文档但没有。

致谢

非常感谢 Echo Global Logistics ( http://www.echo.com ) 支持这个包的开发。

项目详情


下载文件

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

源分布

robotsframework-lint-1.1.tar.gz (23.1 kB 查看哈希

已上传 source