Search packages, repositories and app categories

Package detailsv2.0.4

checked_yaml

Generate more helpful exceptions when decoding YAML documents using package:json_serializable and package:yaml.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
12.2M
Likes
35
Pub points
160

Install package

flutter pub add checked_yaml

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

CheckedYAML is a Dart package that enhances error reporting when decoding YAML documents, particularly when used with json_serializable. It provides more descriptive and actionable exceptions during YAML parsing, helping developers quickly identify issues like missing fields, type mismatches, or invalid values. By integrating seamlessly with existing serialization workflows, it improves debugging efficiency without requiring changes to data models. The package is especially useful in development environments where clear feedback accelerates troubleshooting.

Use cases

  • Debugging YAML parsing errors
  • Improving developer experience during serialization
  • Enhancing error messages in CI/CD pipelines
  • Validating configuration files at runtime
  • Supporting structured data input in apps
  • Integrating with json_serializable workflows

Key features

  • Detailed exception messages
  • Seamless integration with json_serializable
  • Runtime validation of YAML structure
  • Improved error localization
  • Support for nested object validation
  • Clear indication of missing or incorrect fields

Suitable for

  • Developers using json_serializable
  • Teams working with YAML configuration files
  • Projects requiring robust data validation
  • Frontend and backend applications handling YAML
  • CI/CD pipelines needing clear error logs
  • Applications with complex configuration schemas

Considerations

  • Not intended for production-only use
  • Requires json_serializable to be effective
  • May increase build complexity slightly
  • Limited to YAML parsing context
  • Does not replace schema validation tools
  • Best used during development and testing phases

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Dart CI

Provides Dart Build System builders for handling JSON.

json_serializable Pub Package

The core package providing Generators for JSON-specific tasks.

Import it into your pubspec dev_dependencies: section.

json_annotation Pub Package

The annotation package which has no dependencies.

Import it into your pubspec dependencies: section.

checked_yaml Pub Package

Generate more helpful exceptions when decoding YAML documents using package:json_serializable and package:yaml.

Import it into your pubspec dependencies: section.

example

An example showing how to set up and use json_serializable and json_annotation.

Categories

Dependencies

Dependency list 3 items

Source repository

Projects using this package