owl_example 0.2.2

  • README.md
  • Installing
  • Versions
  • 39

Owl code generator examples

It supports JSON serialization, HTTP APIs and SQL CRUD.

Warning: pre-1.0 API is subject to change. Please contact the contributors if you need migration path for early versions.

Usage

To run the code generator, execute the following command:

pub run owl_codegen:main

1. Depend on it

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


dependencies:
  owl_example: "^0.2.2"

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:owl_example/http_api_example.dart';

import 'package:owl_example/http_api_example.http_server.g.dart';

import 'package:owl_example/http_api_example.http_webapp.g.dart';

import 'package:owl_example/http_api_example.json.g.dart';

import 'package:owl_example/json_example.dart';

import 'package:owl_example/json_example.json.g.dart';

import 'package:owl_example/sql_crud_example.dart';

import 'package:owl_example/sql_crud_example.pg_sql.g.dart';
        
Version Uploaded Documentation Archive
0.2.2 Feb 13, 2018 Go to the documentation of owl_example 0.2.2 Download owl_example 0.2.2 archive

Analysis

We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
92 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60 / 100
Overall score:
Weighted score of the above. [more]
39
Learn more about scoring.

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Error(s) in lib/json_example.json.g.dart: The method tear-off 'parse' has type '(Map<String, dynamic>) → ChildClass' that isn't of expected type '(dynamic) → ChildClass'. This means its parameter or return type does not match what is expected.

Suggestions

  • Fix platform conflicts.

    Error(s) prevent platform classification:

    Error(s) in lib/json_example.json.g.dart: The method tear-off 'parse' has type '(Map<String, dynamic>) → ChildClass' that isn't of expected type '(dynamic) → ChildClass'. This means its parameter or return type does not match what is expected.

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • Use constrained dependencies.

    The pubspec.yaml contains 1 dependency without version constraints. Specify version ranges for the following dependencies: postgresql.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 2 errors 12 hints.

    Make sure that the imported libraries are not in conflict. Error(s) in lib/json_example.json.g.dart: The method tear-off 'parse' has type '(Map<String, dynamic>) → ChildClass' that isn't of expected type '(dynamic) → ChildClass'. This means its parameter or return type does not match what is expected.

    Strong-mode analysis of lib/http_api_example.http_server.g.dart gave the following hint:

    line: 17 col: 28
    'UTF8' is deprecated and shouldn't be used.

    Similar analysis of the following files failed:

    • lib/http_api_example.json.g.dart (hint)
  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use owl_example.dart.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.20.0 <2.0.0
owl ^0.2.1 0.2.1+1
postgresql any 0.3.4+1
Transitive dependencies
charcode 1.1.1
collection 1.14.9
convert 2.0.1
crypto 2.0.2+1
typed_data 1.1.5
Dev dependencies
owl_codegen ^0.2.2
test >=0.12.0 <0.13.0