lantern 0.0.6+3

Dart native
Flutter Android iOS

Cloud Firestore's data structure definition language and code generator. Lantern lights bright future of your project.

Lantern 🔆 #

Firebase Cloud Firestore's data structure definition language and code generator. Lantern lights bright future of your project.

Features #

Definition Language #

Have you ever been confused sharing collections / document structure in team? Or forgetting the structure by your self?

No problem. Lantern is simple data structure definition language to write down your Firestore structure.

It's easy to lean, to read, to use.

collection users {
    document User {
        string name
        array<string> attributes
        timestamp lastLogined

        collection tweets {
            document Tweet {
                string body
                reference<Tweet> referring
            }
        }
    }
}

Code Generation Toolkit #

Is hard for you that writing both code for iOS and Android? Have you ever mistook spelling between source code and security rule?

Lantern has code generation toolkit. You can concentrate to using defined data structure. It can provide code for ...

Install #

$ pub global activate lantern

Usage #

$ lantern <your_definition_file>

Grammar #

collection #

collection nameOfCollection(autoId = true) {
    ...
}

collection must have name and just one document. Parameters are optional.

document #

document NameOfDocument(saveCreatedDate = true) {
    ...
}

document have name and parameters (optional). And have fields and collections in body.

Fields and Types #

    string                      name
    boolean                     isAdult
    integer                     level
    number                      score
    url                         blogUrl
    array<string>               appeals
    map                         history
    timestamp                   birthday
    geopoint                    lastUsedFrom
    enum Rank {free, purchased} memberRank
    enum<Rank>                  anotherRank
    reference<DocumentName>     relatedDocument
    struct<DocumentName>        embeddedDocument
    struct S { string a }       embeddedStruct
Lantern TypeFirestore TypeSwift TypeDart typeTypeScript Type
stringstringStringStringstring
booleanbooleanBoolboolboolean
integernumberIntintnumber
numbernumberDoubledoublenumber
urlstringURLUristring
array<T>array[T]List<T>[T]
mapmap[String : Any]Map<String, dynamic>{}
timestamptimestampTimestampTimestampTimestamp
geopointgeopointGeoPointGeoPointGeoPoint
reference<T>referenceDocumentReference (T will be omitted)DocumentRefernce (T will be omitted)DocumentRefernce (T will be omitted)
struct<T>mapT (T should be Codable)T (Document)T (Document)
filemap (file will be uploaded to Cloud Storage)FileStorageFileFile
enum{elements...}stringenum (enum classes will be generated)enum(enum classes will be generated)enum(const enum of string will be generated)
enum<T>stringT (T should be enum)T (T should be enum)T (T should be enum)
struct S {fields...}mapS (Codable class will be generated)SModel (Model class will be generated)S (interface will be generated)
4
likes
60
pub points
30%
popularity

Cloud Firestore's data structure definition language and code generator. Lantern lights bright future of your project.

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

kikuchy.h@gmail.com

License

BSD (LICENSE)

Dependencies

args, code_builder, collection, dart_style, petitparser

More

Packages that depend on lantern