Sha256: 6ebb9c131c610f90f8721d06a3c68cdbc1e8a78c55b40f0eecc4849516f87889

Contents?: true

Size: 620 Bytes

Versions: 23

Compression:

Stored size: 620 Bytes

Contents

# Check API

PlatformOS Check uses static analysis. It parses theme files into an AST, and then calls the appropriate checks to analyze it.

An [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) is a tree of node, representing the theme file.

Checks are Ruby classes with callback methods:
- `on_TYPE` that runs before a node of the specific TYPE is visited.
- `after_TYPE` that runs after a node of the specific TYPE is visited.

There are three types of checks currently supported:

- [`LiquidCheck`](/docs/api/liquid_check.md)
- [`HtmlCheck`](/docs/api/html_check.md)
- [`YamlCheck`](/docs/api/yaml_check.md)

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
platformos-check-0.4.12 docs/api/check.md
platformos-check-0.4.11 docs/api/check.md
platformos-check-0.4.10 docs/api/check.md
platformos-check-0.4.9 docs/api/check.md
platformos-check-0.4.8 docs/api/check.md
platformos-check-0.4.7 docs/api/check.md
platformos-check-0.4.6 docs/api/check.md
platformos-check-0.4.5 docs/api/check.md
platformos-check-0.4.4 docs/api/check.md
platformos-check-0.4.3 docs/api/check.md
platformos-check-0.4.2 docs/api/check.md
platformos-check-0.4.1 docs/api/check.md
platformos-check-0.4.0 docs/api/check.md
platformos-check-0.3.3 docs/api/check.md
platformos-check-0.3.1 docs/api/check.md
platformos-check-0.3.0 docs/api/check.md
platformos-check-0.2.2 docs/api/check.md
platformos-check-0.2.1 docs/api/check.md
platformos-check-0.2.0 docs/api/check.md
platformos-check-0.1.0 docs/api/check.md