Contents

# Prevent Missing Templates (`MissingTemplate`)

This check ensures that resources specified with the `render` tag, `function` tag, and the deprecated `include` tag actually exist. It aims to prevent Liquid rendering errors caused by referencing non-existent templates.

## Examples

The following examples show code snippets that either fail or pass this check:

### ✗ Incorrect Code Example (Avoid using this):

```liquid
{% render 'partial-that-does-not-exist' %}
```

### ✓ Correct Code Example (Use this instead):

```liquid
{% render 'partial-that-exists' %}
```

## Configuration Options

The default configuration for this check:

```yaml
MissingTemplate:
  enabled: true
  ignore_missing: []
```

### `ignore_missing`

Specify a list of patterns for missing template files to ignore.

- The `ignore` option ignores all occurrences of `MissingTemplate` according to the file in which they appear.
- The `ignore_missing` option ignores all occurrences of `MissingTemplate` based on the target template, the template being rendered.

For example:

```yaml
MissingTemplate:
  ignore_missing:
  - icon-*
```

This configuration ignores offenses on `{% render 'icon-missing' %}` across all app files.

```yaml
MissingTemplate:
  ignore:
  - modules/private-module/index.liquid
```

This configuration ignores all `MissingTemplate` offenses in `modules/private-module/index.liquid`, regardless of the file being rendered.

## Version

This check has been introduced in platformOS Check 0.0.1.

## Resources

- [Rule Source][codesource]
- [Documentation Source][docsource]

[codesource]: /lib/platformos_check/checks/missing_template.rb
[docsource]: /docs/checks/missing_template.md

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
platformos-check-0.4.14	docs/checks/missing_template.md
platformos-check-0.4.13	docs/checks/missing_template.md