output-style-examples

Output style examples must be an array of strings

Error

Rule Details

This rule validates the examples field in output style frontmatter. The field must be an array of strings, where each string demonstrates the style in action. This is enforced via the OutputStyleFrontmatterSchema which validates the field as an array of strings.

Incorrect

Examples as a single string instead of array

---
name: concise-prose
description: A concise prose style
examples: "Be brief."
---

Correct

Examples as an array of strings

---
name: concise-prose
description: A concise prose style
examples:
  - "Use short sentences."
  - "Lead with the key point."
---

How To Fix

Change the examples field to a YAML array of strings. Each entry should be a short demonstration of the output style.

Options

This rule does not have any configuration options.

Related Rules

• output-style-name
• output-style-description

Resources

• Rule Implementation
• Rule Tests

Version

Available since: v0.2.0