schemake 0.5.0

Schemake (schema make) is a package for describing schemas from a declarative specification. Specifications can then be used for validating data, generating code or other schemas like JSON Schema and more.

example/schemake_example.dart

import 'dart:io';

import 'package:schemake/dart_gen.dart';
import 'package:schemake/schemake.dart';
import 'package:yaml/yaml.dart';

/// this defines a schema that can be used for
/// data validation and code generation.
const personSchema = Objects('Person', {
  'name': Property(Strings()),
  'age': Property(Nullable(Ints())),
  'friends': Property(Arrays<String, Strings>(Strings()))
});

void main() {
  final yaml = loadYaml('''
  name: Joe Doe
  age: 42
  friends: [ "Mary", "Fred" ]
  ''');

  // when used directly, Objects simply verifies the schema and makes sure
  // to get rid of YAML types.
  Map<String, Object?> joe = personSchema.convert(yaml);
  print('// Full name: ${joe['name']}');
  print('// Age:       ${joe['age']}');
  // you get a List<String>, not a YamlList!
  final friends = joe['friends'] as List<String>;
  print('// Friends:   ${friends.join(', ')}');

  // if the schema does not validate, an Exception gets thrown!
  try {
    // missing "friends", which is mandatory
    personSchema.convert(loadYaml('name: Fred'));
  } on MissingPropertyException catch (e) {
    stderr.writeln('Missing properties: ${e.missingProperties}');
  }

  // now to the interesting bits...

  // generate a Dart class from the schema... by default, it generates a
  // simple Dart class with toString, equals and hashCode implemented,
  // but we can also add JSON methods.
  print(generateDartClasses([personSchema],
      options: const DartGeneratorOptions(methodGenerators: [
        ...DartGeneratorOptions.defaultMethodGenerators,
        DartToJsonMethodGenerator(),
        DartFromJsonMethodGenerator(),
      ])));

  // execute this example by piping its output to a ".dart" file, then run
  // that file!
  print(r'''
void main() {
  final person = Person(name: 'Joe Doe', age: 42, friends: ['Mary']);
  print(jsonEncode(person));
  final otherPerson = Person.fromJson(
    '{"name": "Mary Jane", "friends": ["Joe"]}');
  print(otherPerson.toJson());
}
  ''');
}