模型验证器

用于 Swift 的模型验证框架,可在验证时返回自定义错误。

用法

该框架旨在用于当您希望在每次验证时接收自定义错误时。这是因为我们不想总是将错误显示为字符串,但有时我们希望突出显示无效字段,并提供有关所提供数据有何错误的详细自定义信息。此外,如果我们考虑突出显示表单中的字段,我们必须一次性获取所有验证错误,以获得更好的用户体验。该框架专为这些用例而设计。

安装

Swift 包管理器

首选的安装类型是使用 Swift 包管理器

CocoaPods

要使用 CocoaPods 安装框架

  1. 添加到 Podfile
pod 'ModelValidator'
  1. 安装 pods
pod install

用法

用法示例

下面您可以看到模型的最简单验证。

import ModelValidator

struct LoginForm: Validatable {
  var email: String?
  var password: String

  func validations(validations: inout Validations<LoginForm>) {
    validations.add(\.email, !.nil && .email, error: .emailIsInvalid)
    validations.add(\.password, .count(8...), error: .passwordIsTooShort)
  }

  enum ValidationError: Error {
    case emailIsInvalid, passwordIsTooShort
  }
}

更多示例可以在 tests 中找到

贡献

如果您对新功能有任何想法,请创建一个 issue 或添加一个 pull request。

我们不使用 Linux for Swift,因此如果您有在 Linux 上运行它的建议,请创建一个包含所需更改的 pull request。

该框架没有依赖项。您只需要在您的机器上安装 Swift 编译器和 SwiftLint

发布

该软件包是手动发布的。要发布,请使用正确的电子邮件帐户注册 pod trunk

bundle exec pod trunk register $email

确保您在准备发布的提交上,并使用正确的标签名称运行发布脚本。

Script/release.sh 1.0.0