box_generator 0.2.6

  • Readme
  • Changelog
  • Installing
  • 46

Dart Box Generator #

Generates Box bindings for @entity annotated classes.

Setup #

Add dev dependencies build_runner and box_generator to pubspec.yaml:

dev_dependencies:
    build_runner: <version>
    box_generator: <version>

Usage #

Whenever you make a change to an annotated class, execute:

pub run build_runner build

0.2.6 PostgreSQL & Join #

  • [x] PostgreSQL support
  • [ ] Join

0.2.5 ONE OF & CONTAINS #

  • [x] ONE OF (IN) predicate
  • [x] CONTAINS predicate for arrays

0.2.4 Firestore #

  • [x] Removed dependency on mirrors at runtime
  • [x] Firestore support

0.2.3 Limit & Offset #

  • [x] Limit
  • [x] Offset
  • [x] Select and map result

0.2.2 MongoDB #

  • [x] MongoDB support
  • [x] Deep queries
  • [x] Greater than (or equal)
  • [x] Less than (or equal)
  • [x] Between
  • [x] Dynamically typed queries

Backlog #

  • [ ] Automatic toJson and fromJson
  • [ ] SQLite support
  • [ ] Emulate unsupported Firestore features

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  box_generator: ^0.2.6

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:box_generator/box_generator.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
1
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Jul 11, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.15

Analysis suggestions

Package not compatible with SDK flutter

Because it is not compatible with any of the supported runtimes: flutter-native, flutter-web

Package not compatible with runtime flutter-native on Android

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on Linux

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on Windows

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on iOS

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-native on macOS

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Package not compatible with runtime flutter-web on Web

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build/src/builder/post_process_builder.dart that imports:
  • package:build/src/builder/builder.dart that imports:
  • package:build/src/builder/build_step.dart that imports:
  • package:build/src/asset/reader.dart that imports:
  • package:glob/glob.dart that imports:
  • package:glob/src/list_tree.dart that imports:
  • package:glob/src/io.dart that imports:
  • package:glob/src/io_export.dart that imports:
  • dart:io

Package not compatible with runtime js

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build/src/builder/post_process_builder.dart that imports:
  • package:build/src/builder/builder.dart that imports:
  • package:build/src/builder/build_step.dart that imports:
  • package:build/src/asset/reader.dart that imports:
  • package:glob/glob.dart that imports:
  • package:glob/src/list_tree.dart that imports:
  • package:glob/src/io.dart that imports:
  • package:glob/src/io_export.dart that imports:
  • dart:io

Package not compatible with runtime native-aot

Because:

  • package:box_generator/box_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors

Health suggestions

Format lib/box_generator.dart.

Run dartfmt to format lib/box_generator.dart.

Format lib/src/box_generator.dart.

Run dartfmt to format lib/src/box_generator.dart.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and box_generator.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

The package description is too short. (-10 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.8.1 <3.0.0
analyzer ^0.39.10 0.39.12
box ^0.2.5 0.2.5
build ^1.3.0 1.3.0
source_gen ^0.9.5 0.9.6
Transitive dependencies
_fe_analyzer_shared 5.0.0
args 1.6.0
async 2.4.2
bson 0.3.2
charcode 1.1.3
collection 1.14.13 1.15.0-nullsafety
convert 2.1.1
crypto 2.1.5
csslib 0.16.1
dart_style 1.3.6
fixnum 0.10.11
glob 1.2.0
googleapis_auth 0.2.12
html 0.14.0+3
http 0.12.1
http_parser 3.1.4
inflection2 0.4.3
io 0.3.4
js 0.6.2
logging 0.11.4
meta 1.2.2 1.3.0-nullsafety
mongo_dart 0.4.0
mongo_dart_query 0.4.1
more 1.18.2 2.5.0
node_interop 1.1.1
node_io 1.1.1
package_config 1.9.3
path 1.7.0
pedantic 1.9.2
pool 1.4.0
pub_semver 1.4.4
source_span 1.7.0
stack_trace 1.9.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.2.0 1.3.0-nullsafety
uuid 2.2.0
watcher 0.9.7+15
yaml 2.2.1
Dev dependencies
build_runner ^1.8.0
build_test ^1.0.0
test ^1.10.0