Skip to content

Commit 67dbcb4

Browse files
committed
add comment
1 parent 4b0b7ac commit 67dbcb4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

rule_schema_v1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -821,6 +821,12 @@ properties:
821821
- message
822822
- languages
823823
- severity
824+
# This is a JSON Schema-ism to make the error messages report better.
825+
# It means "if we satisfy the sub-schema of requiring taint, then require taint.
826+
# Otherwise, require pattern-sinks and pattern-sources".
827+
# It basically just makes sure that we only report that we expected to see taint if
828+
# taint is actually there, so our error messages don't report needing `taint` when
829+
# it's actually an old-style syntax rule.
824830
if:
825831
required:
826832
- taint

0 commit comments

Comments
 (0)