Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev2.1.0

yaml_writer

Uma biblioteca para escrever documentos YAML, com suporte a codificação de objetos e 'Converter' do 'dart:convert'.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
666 mil
Curtidas
29
Pontos Pub
160

Instalar pacote

flutter pub add yaml_writer

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

yaml_writer é uma biblioteca Dart projetada para gerar documentos YAML com suporte à codificação de objetos e integração com a interface Converter do 'dart:convert'. Permite a serialização sem problemas de objetos Dart em formato YAML estruturado, tornando-a ideal para arquivos de configuração, troca de dados e armazenamento persistente. O pacote é compatível com todas as principais plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux. Com foco na simplicidade e interoperabilidade, ele amplia o ecossistema padrão do Dart mantendo saídas limpas e legíveis.

Casos de uso

  • Gerando arquivos de configuração
  • Serializando objetos Dart em YAML
  • Persistência de dados no formato YAML
  • Interoperabilidade com dart:convert
  • Criando exportações de dados estruturados

Principais recursos

  • Suporte de codificação de objeto
  • Integração com o Converter do dart:convert
  • Compatibilidade multiplataforma
  • Saída YAML limpa e legível
  • API simples para escrever documentos YAML

Indicado para

  • Desenvolvedores trabalhando com dados de configuração
  • Aplicações que exigem saída YAML
  • Projetos usando utilitários dart:convert
  • Aplicativos cross-platform do Flutter
  • Ferramentas que precisam de serialização de texto estruturado

Considerações

  • Limitado à escrita de YAML (sem análise)
  • Depende de dependências externas para funcionalidade completa
  • Não otimizado para geração em larga escala de YAML
  • Nenhuma validação interna de objetos de entrada
  • Requer manipulação manual de estruturas aninhadas complexas

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

yaml_writer

pub package Null Safety Codecov Dart CI GitHub Tag New Commits Last Commits Pull Requests Code size License

A library to write YAML documents, supporting Object encoding and dart:convert Converter.

Usage

A simple usage example:

import 'package:yaml_writer/yaml_writer.dart';

void main() {
  final yamlWriter = YamlWriter();

  final yamlDoc = yamlWriter.write({
    'name': 'Joe',
    'ids': [10, 20, 30],
    'desc': 'This is\na multiline\ntext',
    'enabled': true,
  });

  print(yamlDoc);
}

OUTPUT:

name: "Joe"
ids: 
  - 10
  - 20
  - 30
desc: |-
    This is
    a multiline
    text
enabled: true

YAML Strings

The writer will try to encode strings using the best format depending on the text, avoiding to escape " and using | for multiline texts.

Encoding Objects

You can use YAMLWriter.toEncodable to convert an Object to an encodable version, similar to what is done by dart:convert JsonEncoder.

If YAMLWriter.toEncodable is not set, it will try to call toJson().

Features and bugs

Please file feature requests and bugs at the issue tracker.

Author

Graciliano M. Passos: gmpassos@GitHub.

Liplum: liplum@GitHub

License

Dart free & open-source license.

Categorias

Repositório-fonte

Projetos que usam este pacote