platformos-check 0.0.1

data/docs/checks/required_layout_object.md

@@ -0,0 +1,28 @@
+# Prevent missing required objects in layouts (`RequiredLayoutThemeObject`)
+
+## Check Details
+
+This check prevents missing `{{ content_for_layout }}` objects in layouts.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+RequiredLayoutObject:
+  enabled: true
+```
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [platformOS layout requirements][layout]
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/required_layout_object.rb
+[docsource]: /docs/checks/required_layout_object.md
+[layout]: https://documentation.platformos.com/developer-guide/pages/layouts

data/docs/checks/space_inside_braces.md

@@ -0,0 +1,89 @@
+# Ensure consistent spacing inside Liquid tags and variables (`SpaceInsideBraces`)
+
+Warns against inconsistent spacing inside liquid tags and variables.
+
+## Check Details
+
+This check is aimed at eliminating ugly Liquid:
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+<!-- Around braces -->
+{% assign x = 1%}
+{{ x}}
+{{x }}
+
+<!-- After commas and semicolons -->
+{% background source_name: 'type',  object, key:value %}
+{% endbackground %}
+
+<!-- Arround filter pipelines -->
+{{ url  | asset_url | strip }}
+{% assign my_upcase_string = "Hello world"| upcase %}
+
+<!-- Arround symbol operators -->
+{%- if target  == product and product.price_varies -%}
+{%- if product.featured_media.width >=165 -%}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% assign x = 1 %}
+{{ x }}
+{% background source_name: 'type', object, key: value, key2: value %}
+{% endbackground %}
+{{ "ignore:stuff,  indeed" }}
+{% render 'product-card',
+  product_card_product: product_recommendation,
+  show_vendor: section.settings.show_vendor,
+  media_size: section.settings.product_recommendations_image_ratio,
+  center_align_text: section.settings.center_align_text
+%}
+{{ url | asset_url | strip }}
+{% assign my_upcase_string = "Hello world" | upcase %}
+{%- if target == product and product.price_varies -%}
+{%- if product.featured_media.width >= 165 -%}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+SpaceInsideBraces:
+  enabled: true
+```
+
+## Auto-correction
+
+This check can automatically trim or add spaces around `{{ ... }}`.
+
+```liquid
+{{ x}}
+{{x}}
+{{  x  }}
+```
+
+Can all be auto-corrected with the `--auto-correct` option to:
+
+```liquid
+{{ x }}
+```
+
+## When Not To Use It
+
+If you don't care about the look of your code.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/space_inside_braces.rb
+[docsource]: /docs/checks/space_inside_braces.md

data/docs/checks/syntax_error.md

@@ -0,0 +1,49 @@
+# Prevent Syntax Errors (`SyntaxError`)
+
+This check exists to inform the user of Liquid syntax error earlier.
+
+## Check Details
+
+This check is aimed at eliminating syntax errors.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% include 'muffin'
+{% assign foo = 1 }}
+{% unknown %}
+{% if collection | size > 0 %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% include 'muffin' %}
+{% assign foo  = 1 %}
+{% if collection.size > 0 %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+SyntaxError:
+  enabled: true
+```
+
+## When Not To Use It
+
+It is not safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/syntax_error.rb
+[docsource]: /docs/checks/syntax_error.md

data/docs/checks/template_length.md

@@ -0,0 +1,45 @@
+# Discourage the use of large template files (`TemplateLength`)
+
+This check exists to discourage the use of large template files. Use partials and functions to componentize your app.
+
+## Check Details
+
+This check is aimed at eliminating large template files.
+
+:-1: Examples of **incorrect** code for this check:
+
+- Files that have more lines than the threshold
+
+:+1: Examples of **correct** code for this check:
+
+- Files that have less lines than the threshold
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+TemplateLength:
+  enabled: true
+  max_length: 600
+```
+
+### `max_length`
+
+The `max_length` (Default: `200`) option determines the maximum number of lines allowed inside a liquid file.
+
+## When Not To Use It
+
+If you don't care about template lengths, then it's safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/template_length.rb
+[docsource]: /docs/checks/template_length.md

data/docs/checks/undefined_object.md

@@ -0,0 +1,71 @@
+# Prevent undefined object errors (`UndefinedObject`)
+
+This check prevents errors by making sure that no undefined variables are being used
+
+## Check Details
+
+This check is aimed at eliminating undefined object errors.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign greetings = "Hello" %}
+{% if greeting == "Hello" %}
+  Hello
+{% endif %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% assign greetings = "Hello" %}
+{% if greetings == "Hello" %}
+  Hello
+{% endif %}
+```
+
+```liquid
+{% function res = 'my_function' %}
+```
+
+```liquid
+{% liquid
+  # my_function body
+  assign my_arg = my_arg: default nil
+  return my_arg
+%}
+```
+
+
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+UndefinedObject:
+  enabled: true
+  exclude_partials: true
+```
+
+### `exclude_partials`
+
+The `exclude_partials` (Default: `true`) option determines whether to check for undefined objects in snippets file (as objects _may_ be defined as arguments)
+
+## When Not To Use It
+
+It is discouraged to disable this rule.
+
+## Version
+
+This check has been introduced in Theme Check 0.1.0.
+
+## Resources
+
+- [platformOS Context](https://documentation.platformos.com/developer-guide/variables/context-variable#displaying-the-context-object)
+- [platformOS Object Reference](https://documentation.platformos.com/api-reference/liquid/objects)
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/undefined_object.rb
+[docsource]: /docs/checks/undefined_object.md

data/docs/checks/unknown_filter.md

@@ -0,0 +1,46 @@
+# Prevent use of unknown filters (`UnknownFilter`)
+
+This check exists to prevent user errors.
+
+## Check Details
+
+This check is aimed at preventing the use of unknown filters.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{{ x | some_unknown_filter }}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{{ x | upcase }}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+UnknownFilter:
+  enabled: true
+```
+
+## When Not To Use It
+
+It is not safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Liquid Filter Reference](https://documentation.platformos.com/api-reference/liquid/filters)
+- [platformOS Filter Reference](https://documentation.platformos.com/api-reference/liquid/platformos-filters)
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/unknown_filter.rb
+[docsource]: /docs/checks/unknown_filter.md

data/docs/checks/unused_assign.md

@@ -0,0 +1,63 @@
+# Prevent unused assigns (`UnusedAssign`)
+
+This check exists to prevent bloat in themes by surfacing variable definitions that are not used.
+
+## Check Details
+
+This check is aimed at eliminating bloat in apps and highlight user errors.
+
+:-1: Examples of **incorrect** code for this check:
+
+```liquid
+{% assign this_variable_is_not_used = 1 %}
+```
+
+```liquid
+{% function this_variable_is_not_used = 'my_function' %}
+```
+
+:+1: Examples of **correct** code for this check:
+
+```liquid
+{% assign this_variable_is_used = 1 %}
+{% if this_variable_is_used == 1 %}
+  <span>Hello!</span>
+{% endif %}
+```
+
+```liquid
+{% function this_variable_is_used = 'my_function' %}
+{% if this_variable_is_used == 1 %}
+  <span>Hello!</span>
+{% endif %}
+```
+
+```liquid
+{% comment %}If you do not need to use the result of the function, start variable name with underscore{% endcomment %}
+{% function _ignore_this_var = 'my_function' %}
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+UnusedAssign:
+  enabled: true
+```
+
+## When Not To Use It
+
+It's safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/unused_assign.rb
+[docsource]: /docs/checks/unused_assign.md

data/docs/checks/unused_partial.md

@@ -0,0 +1,32 @@
+# Remove unused partials in app (`UnusedPartial`)
+
+This check warns the user about partials that are not used (Could not find a `render` or `function` tag that uses that partial)
+
+## Check Details
+
+This check is aimed at eliminating unused partials.
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+UnusedPartial:
+  enabled: true
+```
+
+## When Not To Use It
+
+It's safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/unused_partial.rb
+[docsource]: /docs/checks/unused_partial.md

data/docs/checks/valid_yaml.md

@@ -0,0 +1,48 @@
+# Enforce valid YAML (`ValidYaml`)
+
+This check exists to prevent invalid Yaml files in app.
+
+## Check Details
+
+This check is aimed at eliminating errors in YAML files.
+
+:-1: Examples of **incorrect** code for this check:
+
+```yaml
+---
+hello: world
+invalid
+```
+
+:+1: Examples of **correct** code for this check:
+
+```yaml
+---
+hello: world
+invalid:
+```
+
+## Check Options
+
+The default configuration for this check is the following:
+
+```yaml
+Validyaml:
+  enabled: true
+```
+
+## When Not To Use It
+
+It is not safe to disable this rule.
+
+## Version
+
+This check has been introduced in PlatformOS Check 0.0.1.
+
+## Resources
+
+- [Rule Source][codesource]
+- [Documentation Source][docsource]
+
+[codesource]: /lib/platformos_check/checks/valid_yaml.rb
+[docsource]: /docs/checks/valid_yaml.md