Link to source code in rule docs (#1144)

Fixes #1115 Signed-off-by: Anders Eknert <[email protected]>
StyraInc · Sep 26, 2024 · 75db465 · 75db465
1 parent efd4420
commit 75db465
Show file tree

Hide file tree

Showing 85 changed files with 183 additions and 20 deletions.
diff --git a/docs/rules/bugs/annotation-without-metadata.md b/docs/rules/bugs/annotation-without-metadata.md
@@ -50,6 +50,7 @@ rules:
 ## Related Resources
 
 - OPA Docs: [Annotations](https://www.openpolicyagent.org/docs/latest/policy-language/#annotations)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/annotation-without-metadata/annotation_without_metadata.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/argument-always-wildcard.md b/docs/rules/bugs/argument-always-wildcard.md
@@ -91,6 +91,10 @@ rules:
       except-function-name-pattern: "^mock_"
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/argument-always-wildcard/argument_always_wildcard.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/constant-condition.md b/docs/rules/bugs/constant-condition.md
@@ -39,6 +39,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/constant-condition/constant_condition.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/deprecated-builtin.md b/docs/rules/bugs/deprecated-builtin.md
@@ -45,6 +45,7 @@ rules:
 ## Related Resources
 
 - OPA Docs: [Strict Mode](https://www.openpolicyagent.org/docs/latest/policy-language/#strict-mode)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/deprecated-builtin/deprecated_builtin.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/duplicate-rule.md b/docs/rules/bugs/duplicate-rule.md
@@ -54,6 +54,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/duplicate-rule/duplicate_rule.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/if-empty-object.md b/docs/rules/bugs/if-empty-object.md
@@ -39,6 +39,7 @@ rules:
 ## Related Resources
 
 - Regal Docs: [constant-condition](https://docs.styra.com/regal/rules/bugs/constant-condition)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/if-empty-object/if_empty_object.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/if-object-literal.md b/docs/rules/bugs/if-object-literal.md
@@ -38,6 +38,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/if-object-literal/if_object_literal.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/impossible-not.md b/docs/rules/bugs/impossible-not.md
@@ -77,6 +77,7 @@ rules:
 ## Related Resources
 
 - Regal Docs: [constant-condition](https://docs.styra.com/regal/rules/bugs/constant-condition)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/impossible-not/impossible_not.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/inconsistent-args.md b/docs/rules/bugs/inconsistent-args.md
@@ -75,6 +75,7 @@ rules:
 ## Related Resources
 
 - Regal Docs: [equals-pattern-matching](https://docs.styra.com/regal/rules/idiomatic/equals-pattern-matching)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/inconsistent-args/inconsistent_args.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/internal-entrypoint.md b/docs/rules/bugs/internal-entrypoint.md
@@ -53,7 +53,8 @@ rules:
 ## Related Resources
 
 - Rego Style Guide: [Optionally, use leading underscore for rules intended for internal use](https://docs.styra.com/opa/rego-style-guide#optionally-use-leading-underscore-for-rules-intended-for-internal-use)
-- Regal  Docs: [no-defined-entrypoint](https://docs.styra.com/regal/rules/idiomatic/no-defined-entrypoint)
+- Regal Docs: [no-defined-entrypoint](https://docs.styra.com/regal/rules/idiomatic/no-defined-entrypoint)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/internal-entrypoint/internal_entrypoint.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/invalid-metadata-attribute.md b/docs/rules/bugs/invalid-metadata-attribute.md
@@ -50,6 +50,7 @@ rules:
 
 - OPA Docs: [Annotations](https://www.openpolicyagent.org/docs/latest/policy-language/#annotations)
 - OPA Docs: [Accessing Annotations](https://www.openpolicyagent.org/docs/latest/policy-language/#accessing-annotations)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/invalid-metadata-attribute/invalid_metadata_attribute.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/leaked-internal-reference.md b/docs/rules/bugs/leaked-internal-reference.md
@@ -59,6 +59,7 @@ rules:
 ## Related Resources
 
 - Rego Style Guide: [Optionally, use leading underscore for rules intended for internal use](https://docs.styra.com/opa/rego-style-guide#optionally-use-leading-underscore-for-rules-intended-for-internal-use)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/leaked-internal-reference/leaked_internal_reference.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/not-equals-in-loop.md b/docs/rules/bugs/not-equals-in-loop.md
@@ -67,6 +67,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/not-equals-in-loop/not_equals_in_loop.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/redundant-existence-check.md b/docs/rules/bugs/redundant-existence-check.md
@@ -54,6 +54,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/redundant-existence-check/redundant_existence_check.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/rule-named-if.md b/docs/rules/bugs/rule-named-if.md
@@ -36,13 +36,17 @@ it isn't — consider using a better name for your rule!
 This linter rule provides the following configuration options:
 
 ```yaml
-rules: 
+rules:
   bugs:
     rule-named-if:
       # one of "error", "warning", "ignore"
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/rule-named-if/rule_named_if.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/rule-shadows-builtin.md b/docs/rules/bugs/rule-shadows-builtin.md
@@ -37,6 +37,7 @@ rules:
 - OPA Docs: [Built-in Functions](https://www.openpolicyagent.org/docs/latest/policy-reference/#built-in-functions)
 - OPA Repo: [builtin_metadata.json](https://github.com/open-policy-agent/opa/blob/main/builtin_metadata.json)
 - Regal Docs: [var-shadows-builtin](https://docs.styra.com/regal/rules/bugs/var-shadows-builtin)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/rule-shadows-builtin/rule_shadows_builtin.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/sprintf-arguments-mismatch.md b/docs/rules/bugs/sprintf-arguments-mismatch.md
@@ -65,6 +65,7 @@ rules:
 ## Related Resources
 
 - OPA Docs: [Built-in Functions: `sprintf`](https://www.openpolicyagent.org/docs/latest/policy-reference/#builtin-strings-sprintf)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/sprintf-arguments-mismatch/sprintf_arguments_mismatch.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/top-level-iteration.md b/docs/rules/bugs/top-level-iteration.md
@@ -30,13 +30,17 @@ data.
 This linter rule provides the following configuration options:
 
 ```yaml
-rules: 
+rules:
   bugs:
     top-level-iteration:
       # one of "error", "warning", "ignore"
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/top-level-iteration/top_level_iteration.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/unassigned-return-value.md b/docs/rules/bugs/unassigned-return-value.md
@@ -47,6 +47,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/unassigned-return-value/unassigned_return_value.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/bugs/unused-output-variable.md b/docs/rules/bugs/unused-output-variable.md
@@ -95,6 +95,7 @@ rules:
 
 - Regal Docs: [prefer-some-in-iteration](https://docs.styra.com/regal/rules/style/prefer-some-in-iteration)
 - OPA Docs: [Strict Mode](https://www.openpolicyagent.org/docs/latest/policy-language/#strict-mode)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/unused-output-variable/unused_output_variable.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/var-shadows-builtin.md b/docs/rules/bugs/var-shadows-builtin.md
@@ -53,6 +53,7 @@ rules:
 - OPA Docs: [Built-in Functions](https://www.openpolicyagent.org/docs/latest/policy-reference/#built-in-functions)
 - OPA Repo: [builtin_metadata.json](https://github.com/open-policy-agent/opa/blob/main/builtin_metadata.json)
 - Regal Docs: [rule-shadows-builtin](https://docs.styra.com/regal/rules/bugs/rule-shadows-builtin)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/var-shadows-builtin/var_shadows_builtin.rego)
 
 ## Community
 

diff --git a/docs/rules/bugs/zero-arity-function.md b/docs/rules/bugs/zero-arity-function.md
@@ -40,7 +40,7 @@ it will remove the parentheses from a zero-arity function definition for you.
 This linter rule provides the following configuration options:
 
 ```yaml
-rules: 
+rules:
   bugs:
     zero-arity-function:
       # one of "error", "warning", "ignore"
@@ -49,8 +49,9 @@ rules:
 
 ## Related Resources
 
-OPA Docs: [The OPA Document Model](https://www.openpolicyagent.org/docs/latest/philosophy/#the-opa-document-model)
-OPA Issues: [Allow user-defined zero-argument functions in Rego](https://github.com/open-policy-agent/opa/issues/6315)
+- OPA Docs: [The OPA Document Model](https://www.openpolicyagent.org/docs/latest/philosophy/#the-opa-document-model)
+- OPA Issues: [Allow user-defined zero-argument functions in Rego](https://github.com/open-policy-agent/opa/issues/6315)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/bugs/zero-arity-function/zero_arity_function.rego)
 
 ## Community
 

diff --git a/docs/rules/custom/forbidden-function-call.md b/docs/rules/custom/forbidden-function-call.md
@@ -47,6 +47,7 @@ rules:
 
 - OPA Docs: [Capabilities](https://www.openpolicyagent.org/docs/latest/deployments/#capabilities)
 - OPA Docs: [Built-in Functions](https://www.openpolicyagent.org/docs/latest/policy-reference/#built-in-functions)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/custom/forbidden-function-call/forbidden_function_call.rego)
 
 ## Community
 

diff --git a/docs/rules/custom/missing-metadata.md b/docs/rules/custom/missing-metadata.md
@@ -78,6 +78,7 @@ rules:
 - OPA Docs: [Metadata](https://www.openpolicyagent.org/docs/latest/policy-language/#metadata)
 - OPA Docs: [Annotations](https://www.openpolicyagent.org/docs/latest/policy-language/#annotations)
 - Rego Style Guide: [Use Metadata Annotations](https://docs.styra.com/opa/rego-style-guide#use-metadata-annotations)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/custom/missing-metadata/missing_metadata.rego)
 
 ## Community
 

diff --git a/docs/rules/custom/naming-convention.md b/docs/rules/custom/naming-convention.md
@@ -50,6 +50,10 @@ rules:
 patterns. Additionally, you'll most often want to include anchors for the start and end of the string (`^` and `$`) in
 your patterns, or else your pattern might accidentally match only parts of the name rather than the whole name.
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/custom/naming-convention/naming_convention.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/custom/one-liner-rule.md b/docs/rules/custom/one-liner-rule.md
@@ -53,6 +53,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/custom/one-line-rule/one_line_rule.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/custom/prefer-value-in-head.md b/docs/rules/custom/prefer-value-in-head.md
@@ -80,6 +80,10 @@ rules:
       only-scalars: false
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/custom/prefer-value-in-head/prefer_value_in_head.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/idiomatic/ambiguous-scope.md b/docs/rules/idiomatic/ambiguous-scope.md
@@ -91,6 +91,7 @@ rules:
 
 - OPA Docs: [Annotations](https://www.openpolicyagent.org/docs/latest/policy-language/#annotations)
 - Regal Docs: [no-defined-entrypoint](https://docs.styra.com/regal/rules/idiomatic/no-defined-entrypoint)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/ambiguous-scope/ambiguous_scope.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/boolean-assignment.md b/docs/rules/idiomatic/boolean-assignment.md
@@ -57,6 +57,7 @@ rules:
 
 - Styra Blog: [How to express OR in Rego](https://www.styra.com/blog/how-to-express-or-in-rego/)
 - Regal Docs: [default-over-else](https://docs.styra.com/regal/rules/style/default-over-else)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/boolean-assignment/boolean_assignment.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/custom-has-key-construct.md b/docs/rules/idiomatic/custom-has-key-construct.md
@@ -45,6 +45,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/custom-has-key-construct/custom_has_key_construct.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/idiomatic/custom-in-construct.md b/docs/rules/idiomatic/custom-in-construct.md
@@ -48,6 +48,10 @@ rules:
       level: error
 ```
 
+## Related Resources
+
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/custom-in-construct/custom_in_construct.rego)
+
 ## Community
 
 If you think you've found a problem with this rule or its documentation, would like to suggest improvements, new rules,

diff --git a/docs/rules/idiomatic/directory-package-mismatch.md b/docs/rules/idiomatic/directory-package-mismatch.md
@@ -127,6 +127,7 @@ rules:
 - Regal Docs: [test-outside-test-package](https://docs.styra.com/regal/rules/testing/test-outside-test-package)
 - OPA Docs: [Bundles](https://www.openpolicyagent.org/docs/latest/management-bundles/)
 - Styra Docs: [Styra DAS](https://docs.styra.com/das)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/directory-package-mismatch/directory_package_mismatch.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/equals-pattern-matching.md b/docs/rules/idiomatic/equals-pattern-matching.md
@@ -101,6 +101,7 @@ rules:
 ## Related Resources
 
 - Styra Blog: [How to express OR in Rego](https://www.styra.com/blog/how-to-express-or-in-rego/)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/equals-pattern-matching/equals_pattern_matching.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/no-defined-entrypoint.md b/docs/rules/idiomatic/no-defined-entrypoint.md
@@ -89,6 +89,7 @@ rules:
 
 - OPA Docs: [Metadata](https://www.openpolicyagent.org/docs/latest/policy-language/#metadata)
 - OPA Docs: [Entrypoint](https://www.openpolicyagent.org/docs/latest/policy-language/#entrypoint)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/no-defined-entrypoint/no_defined_entrypoint.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/non-raw-regex-pattern.md b/docs/rules/idiomatic/non-raw-regex-pattern.md
@@ -58,6 +58,7 @@ rules:
 
 - Rego Style Guide: [Use raw strings for regex patterns](https://github.com/StyraInc/rego-style-guide#use-raw-strings-for-regex-patterns)
 - OPA Docs: [Regex Functions Reference](https://www.openpolicyagent.org/docs/latest/policy-reference/#regex)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/non-raw-regex-pattern/non_raw_regex_pattern.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/prefer-set-or-object-rule.md b/docs/rules/idiomatic/prefer-set-or-object-rule.md
@@ -154,6 +154,7 @@ rules:
 - OPA Docs: [Generating Objects](https://www.openpolicyagent.org/docs/latest/policy-language/#generating-objects)
 - OPA Docs: [Comprehensions](https://www.openpolicyagent.org/docs/latest/policy-language/#comprehensions)
 - Styra Blog: [Five Things You Didn't Know About OPA](https://www.styra.com/blog/five-things-you-didnt-know-about-opa/)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/prefer-set-or-object-rule/prefer_set_or_object_rule.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/use-contains.md b/docs/rules/idiomatic/use-contains.md
@@ -55,7 +55,7 @@ automatically at any applicable location by the `opa fmt` tool.
 This linter rule provides the following configuration options:
 
 ```yaml
-rules: 
+rules:
   idiomatic:
     use-contains:
       # one of "error", "warning", "ignore"
@@ -66,6 +66,7 @@ rules:
 
 - Regal Docs: [use-if](https://docs.styra.com/regal/rules/idiomatic/use-if)
 - OPA Docs: [Future Keywords](https://www.openpolicyagent.org/docs/latest/policy-language/#future-keywords)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/use-contains/use_contains.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/use-if.md b/docs/rules/idiomatic/use-if.md
@@ -64,6 +64,7 @@ rules:
 
 - Regal Docs: [use-contains](https://docs.styra.com/regal/rules/idiomatic/use-contains)
 - OPA Docs: [Future Keywords](https://www.openpolicyagent.org/docs/latest/policy-language/#future-keywords)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/use-if/use_if.rego)
 
 ## Community
 

diff --git a/docs/rules/idiomatic/use-in-operator.md b/docs/rules/idiomatic/use-in-operator.md
@@ -47,6 +47,7 @@ rules:
 ## Related Resources
 
 - Rego Style Guide: [Use `in` to check for membership](https://github.com/StyraInc/rego-style-guide#use-in-to-check-for-membership)
+- GitHub: [Source Code](https://github.com/StyraInc/regal/blob/main/bundle/regal/rules/idiomatic/use-in-operator/use_in_operator.rego)
 
 ## Community