nsagora / peppermint Goto Github PK

Hi,
By applying a small addition to the already existing ValidationResult extension it's possible to retrieve immediately the error without using any switch-case let statements.

extension ValidationResult {
    
    public var error: ValidationError? {
        switch self {
        case .valid:                       return nil
        case let .invalid(error):    return error
        }
    }
}

In this way the usage is much easier

guard result.error == nil else {
    // do something with the error
    return
}

Instead of

if result.isInvalid {
    // to get the actual error you have to switch over the enum.
   // that makes the isInvalid almost useless in this case.
}

Add example projects to document the framework integration and usage inside other projects.

Create an MR template that contains a checklist of activities to perform before submitting the MR. This checklist should include like tests passing, every target builds, pod lint is successful, etc.

Include usage examples of the framework for a sneak preview before installing the dependency.

The readme file doesn't reflect the current stage of the codebase.

Improve the declarative syntax style of the API.

Populate the readme.md file with installation sections for:

• Cocoa Pods
• Swift Package Manager

Rewrite every build script as a fastlane script and use the TravisCI matrix to run it.

Apple introduced DocC at WWDC21. It is a documentation compiler which allows framework and package authors to write and publish reach and interactive documentation for their clients of their software.

Inspired from SwiftUI,a modifier is a method on a constraint that returns a new constraint by decorating the caller with more functionality.

For example, one may call the .optional() modifier to return an OptionalConstraint.

The purpose is to simplify the API syntax.

is there any plan to support modern async with this library?
btw good work with the declarative api ! clearly underrated package imho

Update the ValidationToolkit.playground examples to run with the latest code base version.