Sugar 🍬

📦 Installation

Update your Package.swift file.

.package(url: "https://github.com/nodes-vapor/sugar.git", from: "3.0.0-beta")

Getting started 🚀

Make sure that you've imported Sugar everywhere when needed:

import Sugar

Helpers

This package contains a lot of misc. functionality that might not fit into it's own package or that would best to get PR'ed into Vapor. Some examples of what this package contains:

Mutable Leaf tag config

To allow third party packages to register their own Leaf tags, Sugar comes with a MutableLeafTagConfig.

How to use it in a package

To have your package register the tags to the shared config, you can do the following:

public func didBoot(_ container: Container) throws -> Future<Void> {
    let tags: MutableLeafTagConfig = try container.make()
    tags.use(MyTag(), as: "mytag")

    return .done(on: container)
}

How to use it in a project

If you're using a package that uses the shared MutableLeafTagConfig, these tags will become available in your project automatically. If you have additional tags you want to add, these has to be registered in boot.swift instead of configure.swift to allow the different providers to have registered their tags to the config first. Here's how you could do it:

public func boot(_ app: Application) throws {
    // Register Leaf tags using the shared config.
    // This allows third party packages to register their own tags.
    let tags: MutableLeafTagConfig = try app.make()
    tags.use(MyAdditionalTag())
}

You don't have to register tags when adding this in boot.swift.

In the case where multiple packages is registering a tag using the same name, the tags can be added manually by defining your own name for the tags.

Environment variables

Access environment variables by writing

env("my-key", "my-fallback-value")

Seeder commands

If you want to make your model seedable, you can conform it to Seedable and use SeederCommand to wrap your seedable model. This basically means that you can focus on how your model gets initialized when running your command, and save a little code on actually performing the database work.

Seeding multiple instances of your model will be added - feel free to PR.

Authentication

This package contains a lot of convenience related to JWT, usernames and passwords which is used in JWTKeychain and Admin Panel.

Migrations

Sugar contains a helper function for adding properties while excluding some specific ones. This makes it a bit more convenient if you want to only modify how a single one or a couple of fields gets prepared.

extension MyModel: Migration {
    static func prepare(on connection: MySQLConnection) -> Future<Void> {
        return MySQLDatabase.create(self, on: connection) { builder in
            try addProperties(to: builder, excluding: [\.title])
            builder.field(for: \.title, type: .varchar(191))
        }
    }
}

🏆 Credits

This package is developed and maintained by the Vapor team at Nodes. The package owner for this project is Siemen.

📄 License

This package is open-sourced software licensed under the MIT license

jdmcd/sugar