Sha256: 887bd18899f8e033b681c886fafa35c2d157176e5f776cbe80d98a4400c73769

Contents?: true

Size: 1.32 KB

Versions: 5

Compression:

Stored size: 1.32 KB

Contents

# 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
```

## 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

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
platformos-check-0.3.3 docs/checks/undefined_object.md
platformos-check-0.3.1 docs/checks/undefined_object.md
platformos-check-0.3.0 docs/checks/undefined_object.md
platformos-check-0.2.2 docs/checks/undefined_object.md
platformos-check-0.2.1 docs/checks/undefined_object.md