rspec/rules/S140/python/rule.adoc

37 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
This rule allows the definition of custom rules using XPath expressions.
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
Issues are created depending on the return value of the XPath expression. If the XPath expression returns:
2020-06-30 12:47:33 +02:00
* a single or list of AST nodes, then a line issue with the given message is created for each node
* a boolean, then a file issue with the given message is created only if the boolean is true
* anything else, no issue is created
This rule allows the definition of custom rules using XPath expressions.
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
Issues are created depending on the return value of the XPath expression. If the XPath expression returns:
2020-06-30 12:47:33 +02:00
* a single or list of AST nodes, then a line issue with the given message is created for each node
* a boolean, then a file issue with the given message is created only if the boolean is true
* anything else, no issue is created
Here is an example of an XPath expression to log a violation on each statement:
2020-06-30 12:47:33 +02:00
----
//statement
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
endif::env-github,rspecator-view[]