robotframework纯文本文件静态分析工具
rf-lint的Python项目详细描述
欢迎使用Robot Framework Lint
机器人框架纯文本文件的静态分析。在
这是一个用于robot框架纯文本文件的静态分析工具。在
安装说明
首选的安装方法是使用pip:
$ pip install –upgrade rf-lint
这将安装一个名为“rflint”的包和一个名为“rflint”的可执行文件
运行过梁
要运行,请使用命令“rflint”,或对python使用-m选项 运行rflint模块。添加一个或多个文件名作为参数,并且 将检查这些文件是否违反规则。在
自定义规则
规则是简单的python类。有关如何 编写规则,参见 [机器人框架lint wiki](https://github.com/LDerikx/rf-lint/wiki)
参数文件
rflint支持参数文件的方式与robot框架基本相同。你可以 在文件中每行放置一个参数,并使用选项引用该文件 -一个或–参数文件。在
参数文件是创建一组规则和规则配置的方便方法 你想应用到你的文件。在
示例
$ rflint myTestSuite.robot
要查看所有内置规则的列表,请运行以下命令
$ rflint –list
要查看文档,请添加–verbose选项:
$ rflint –list –verbose
有些规则是可配置的。例如,要配置“LineTooLong” 如果要标记长度超过80个字符的行(默认值为100),则 可以使用配置选项更改默认值:
$ rflint –configure LineTooLong:80 myTestSuite.robot
您可以禁用任何规则,或将其配置为警告或错误 使用选项–warning、–error和–ignore。例如,到 忽略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)为 支持该软件包的开发。在
- 项目
标签: