Sha256: f6c983d25ae0b583397594ae8dcca53c75c4ed917a1d466497754e9046ffed11

Contents?: true

Size: 1.12 KB

Versions: 2

Compression:

Stored size: 1.12 KB

Contents

# Discourage the Use of Large Template Files (`TemplateLength`)

This check aims to eliminate the use of large template files by encouraging a modular approach - using partials and functions to componentize your app instead.

## Examples

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

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

- Files that have more lines than the threshold

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

- Files that have less lines than the threshold

## Configuration Options

The default configuration for this check:

```yaml
TemplateLength:
  enabled: true
  max_length: 600
```

### `max_length`

The `max_length` (Default: `600`) option determines the maximum number of lines allowed inside a liquid file.

## Disabling This Check

This check is safe to disable if you do not prioritize template length management.

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

Version data entries

2 entries across 2 versions & 1 rubygems

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