robotframework纯文本文件静态分析工具
robotframework-lint的Python项目详细描述
欢迎使用robot framework lint
robot框架纯文本文件的静态分析。
这是一个用于robot框架纯文本文件的静态分析工具。
安装说明
首选的安装方法是使用pip:
$ pip install –upgrade robotframework-lint
这将安装一个名为“rflint”的包和一个名为“rflint”的可执行文件
运行棉绒
要运行,请使用命令“rflint”,或者使用python的-m选项 运行rflint模块。添加一个或多个文件名作为参数,然后 将检查这些文件是否违反规则。
自定义规则
规则是简单的python类。有关如何 写规则,见 [robotframework lint wiki](https://github.com/boakley/robotframework-lint/wiki)
参数文件
rflint支持参数文件的方式与robot框架基本相同。你可以 在文件中每行放置一个参数,并使用选项引用该文件 -a或参数文件。
参数文件是创建一组规则和规则配置的方便方法 你要应用到你的文件。
示例
$ rflint myTestSuite.robot
要查看所有内置规则的列表,请运行以下命令
$ rflint –list
要查看文档,请添加–verbose选项:
$ rflint –list –verbose
有些规则是可配置的。例如,要配置“linetoolong” 规则标记超过80个字符的行(默认值为100),您可以 可以使用configure选项更改默认值:
$ rflint –configure LineTooLong:80 myTestSuite.robot
您可以禁用任何规则,或将其配置为警告或错误 使用选项–警告、–错误和–忽略。例如,到 忽略linetoolong规则您可以这样做:
$ rflint –ignore LineTooLong myTestSuite.robot
要查看所有命令行选项的列表,请使用–help选项:
$ python -m rflint –help
示例输出:
$ python -m rflint myTestSuite.robot + myTestSuite.robot W: 2, 0: No suite documentation (RequireSuiteDocumentation) E: 15, 0: No keyword documentation (RequireKeywordDocumentation)
这在第二行显示一个警告,字符0,应该有suite 文档,但不是。它还在第15行字符0上显示错误, 应该有关键字文档但没有的地方。
致谢
非常感谢Echo Global Logistics(http://www.echo.com)为 支持这个包的开发。