Crimson

Fast, efficient and easy-to-use JSON parser and serializer for Dart.

🚧 Crimson is still in early development and is not ready for production use. Only parsing is supported for now 🚧

Features

  • 🏎ïļ Fast: Like really fast. Crimson parses JSON in a single pass.
  • ðŸŒŧ Easy to use: Crimson is designed to be easy to use and understand.
  • 💃 Flexible: Crimson can partially parse and serialize JSON.
  • ðŸŠķ Lightweight: Crimson is lightweight and has no third-party dependencies.

Usage

After adding Crimson to your pubspec.yaml, you can start annotating your classes with @json and optionally @JsonField:

import 'package:crimson/crimson.dart';

part 'tweet.g.dart';

@json
class Tweet {
  DateTime? created_at;

  @JsonField(name: 'text')
  String? tweet;

  int? reply_count;

  int? retweet_count;

  int? favorite_count;
}

Now you just need to run pub run build_runner build to generate the necessary code.

import 'package:crimson/crimson.dart';

void main() {
  final jsonBytes = downloadTweets();
  final crimson = Crimson(jsonBytes);

  final tweets = crimson.parseTweetList();
}

That’s it! You can now parse and serialize JSON with ease.

License

Copyright 2022 Simon Choi

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

GitHub

View Github