FieldTest Documentation

Welcome to FieldTest! This documentation will help you get started with content validation using Standard Schema.

📖 Getting Started

New to FieldTest? Start here:

• Getting Started Guide — Install FieldTest and validate your first markdown file
• Why FieldTest? — Understand the problems FieldTest solves

🎓 Guides (How-to)

Step-by-step instructions for common tasks:

• Schema Validation Guide — Create schemas and validate content
• Framework Integration — Use FieldTest with Astro, Next.js, and other frameworks
• Biome Integration — Set up Biome linting with FieldTest plugins

📚 Reference

Complete API documentation:

• API Reference — All functions, types, and utilities

💡 Explainers (Understanding)

Conceptual articles to deepen your understanding:

• What is Standard Schema? — Learn about Standard Schema and why it matters
• Why FieldTest? — The problems FieldTest solves and when to use it

🚀 Quick Links

• Examples — Real-world use cases
• Biome Plugins — Custom linting rules
• Changelog — Version history and changes

🗂️ Documentation Structure

This documentation follows the Diátaxis framework:

docs/
├── getting-started.md           # Quick start guide
├── guides/                      # How-to guides
│   ├── schema-validation.md
│   ├── framework-integration.md
│   └── biome-integration.md
├── reference/                   # API documentation
│   └── api.md
└── explainers/                  # Conceptual articles
    ├── standard-schema.md
    └── why-fieldtest.md

🎯 Find What You Need

I want to

Get started quickly → Getting Started Guide

Validate markdown content → Schema Validation Guide

Use FieldTest with Astro or Next.js → Framework Integration Guide

Set up Biome linting → Biome Integration Guide

Understand Standard Schema → Standard Schema Explainer

Look up API details → API Reference

See example code → Examples

🔧 Tools & Integrations

• MCP Server — AI-powered content validation
• Biome Plugins — Custom linting rules for migration and best practices

🌟 Features

FieldTest provides:

• ✅ Markdown parsing with frontmatter support
• ✅ Schema validation using Standard Schema
• ✅ Schema registry for reusable validation rules
• ✅ Framework integrations (Astro, Next.js, and more)
• ✅ MCP integration for AI workflows
• ✅ Biome plugins for linting and migration

💬 Community & Support

• 🐛 Report bugs
• 💬 Discussions
• 📧 Contact: hello@matthewhendricks.net

📦 Installation

npm install @watthem/fieldtest

Or with pnpm:

pnpm add @watthem/fieldtest

Requirements: Node.js 18+ and PNPM 8+

🚀 Quick Example

import { loadUserSchema, validateWithSchema } from '@watthem/fieldtest';
import type { StandardSchemaV1 } from '@watthem/fieldtest';

// Define schema
const schema: StandardSchemaV1 = {
  version: '1',
  name: 'blog-post',
  fields: {
    title: { type: 'string', required: true },
    published: { type: 'boolean', required: true }
  }
};

// Validate content
const loaded = loadUserSchema(schema);
const result = validateWithSchema(markdown, loaded);

if (!result.valid) {
  console.error('Validation failed:', result.errors);
}

📖 Contributing

Want to contribute? Check out:

• Contributing Guidelines
• Development Setup
• Open Issues

📝 License

MIT © Matthew Hendricks

---

Ready to get started? → Getting Started Guide