Bow 是一个用于 Swift 类型函数式编程的跨平台库。
文档
所有文档和 API 引用均发布在我们的网站上 https://bow-swift.io/。以下是库的关键方面的一些链接
模块
Bow 被分割成多个模块,可以独立消费。以下是一些模块
Bow
:核心库。包含高阶类型仿真、函数操作工具、类型类、数据类型、Monad 变换器以及原始类型实例。BowOptics
:用于操作不同光学的基本模块。BowRecursionSchemes
:与递归方案操作的模块。BowFree
:与 Free Monads 操作的模块。BowGeneric
:与泛型数据类型操作的模块。BowEffects
:与 effects 操作的模块。BowRx
:提供与 RxSwift 集成的模块。
还有一些用于测试的模块
BowLaws
:核心模块中类型类的法则。BowOpticsLaws
:光学法则。BowEffectsLaws
:效应法则。BowGenerators
:为核心模块中的数据类型提供基于属性的测试生成器。BowFreeGenerators
:为 BowFree 中数据类型提供基于属性的测试生成器。BowEffectsGenerators
:为 BowEffects 中数据类型提供基于属性的测试生成器。BowRxGenerators
:为 BowRx 中数据类型提供基于属性的测试生成器。
Bow 还可通过 Swift Package Manager、CocoaPods 和 Carthage 使用。
Swift 包管理器
从 Xcode 11 开始,您可以使用 IDE 中的集成功能以及 Swift 包管理器将依赖项引入到您的项目中。您只需要仓库的 URL:https://github.com/bow-swift/bow.git。对于早期版本的 Xcode,创建一个类似于下面的 Package.swift
文件,并按需使用依赖项。
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "BowTestProject",
dependencies: [
.package(url: "https://github.com/bow-swift/bow.git", from: "{version}")
],
targets: [
.target(name: "BowTestProject",
dependencies: [
"Bow",
"BowOptics",
"BowRecursionSchemes",
"BowFree",
"BowGeneric",
"BowEffects",
"BowRx"]),
.testTarget(name: "BowTestProjectTests",
dependencies: [
// Type class laws
"BowLaws",
"BowOpticsLaws",
"BowEffectsLaws",
// Generators for PBT with SwiftCheck
"BowGenerators",
"BowFreeGenerators",
"BowEffectsGenerators",
"BowRxGenerators"])
]
)
要构建它,只需运行
$ swift build
CocoaPods
您可以单独使用 Bow 模块作为不同的 pod。您可以根据需要将这些行添加到您的 Podfile 中
pod "Bow", "~> {version}"
pod "BowOptics", "~> {version}"
pod "BowRecursionSchemes", "~> {version}"
pod "BowFree", "~> {version}"
pod "BowGeneric", "~> {version}"
pod "BowEffects", "~> {version}"
pod "BowRx", "~> {version}"
测试规则
pod "BowLaws", "~> {version}"
pod "BowOpticsLaws", "~> {version}"
pod "BowEffectsLaws", "~> {version}"
使用 SwiftCheck 基于属性的测试生成器
pod "BowGenerators", "~> {version}"
pod "BowFreeGenerators", "~> {version}"
pod "BowEffectsGenerators", "~> {version}"
pod "BowRxGenerators", "~> {version}"
Carthage
Carthage 会下载整个 Bow 项目,但它会为每个模块编译单独的框架,您可以单独使用。将这些行添加到您的 Cartfile 中
github "bow-swift/Bow" ~> {version}
贡献
如果您想为此库做出贡献,您可以通过检查问题来查看一些待办任务。
如何运行项目
在 Xcode 11(或更新版)中打开 Bow.xcodeproj
,您就可以开始了。Bow 使用 Swift 包管理器来处理其依赖项。
如何运行文档项目
- 前往目录
contents/Documentation
。 - 运行
pod install
以获取所有依赖项。 - 打开
Documentation.xcworkspace
并运行项目。
获取更多信息,请参阅我们的 贡献指南。
如何创建新的发布版本
您可以通过运行 bundle exec fastlane release version_number:
来创建新的发布版本。例如,bundle exec fastlane release version_number: 0.7.0
。
以下步骤将被运行
- 更新
*.podspec
文件中的version
。 - 在
CHANGELOG
文件中添加消息后创建标签。 - 部署 podspec 文件并使其公开可用。
许可
Copyright (C) 2018-2020 The Bow Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://apache.ac.cn/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.