Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ assertions, and do so in a testable manner.

## Overview

> [!Important]
> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such,
> to use this library you must depend on the old repository URL:
>
> ```
> https://github.com/pointfreeco/xctest-dynamic-overlay
> ```

This library provides robust tools for reporting issues in your application with a customizable
degree of granularity and severity. In its most basic form you use the `reportIssue` function
anywhere in your application to flag an issue in your code, such as a code path that you think
Expand Down Expand Up @@ -72,9 +80,9 @@ There are many popular libraries out there using Issue Reporting. To name a few:
to explicitly declare its dependencies, and when a new dependency is introduced to a feature,
existing tests will fail until they account for it.

<!-- * [**Swift Navigation**](https://github.com/pointfreeco/swiftui-navigation) provides concise-->
<!-- domain modeling tools for UI frameworks including SwiftUI, UIKit, and more; and it uses Swift-->
<!-- Issue Reporting to raise runtime warnings when APIs are used in unexpected ways.-->
* [**Swift Navigation**](https://github.com/pointfreeco/swift-navigation) provides concise
domain modeling tools for UI frameworks including SwiftUI, UIKit, and more; and it uses Swift
Issue Reporting to raise runtime warnings when APIs are used in unexpected ways.

* [**The Composable Architecture**](https://github.com/pointfreeco/swift-composable-architecture)
comes with powerful testing tools that support both Swift Testing and XCTest out of the box
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

Learn how to report issues in your application code, and how to customize how issues are reported.

## Installation

Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such, to use this
library you must depend on the old repository URL. This means if you are using the Xcode
"Package Dependencies" interface you will enter the following URL when adding the package:

```
https://github.com/pointfreeco/xctest-dynamic-overlay
```

And if you are using an SPM Package.swift file you will specify the dependency like so:

```swift
.package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.5.0"),
```

## Reporting issues

The primary tool for reporting an issue in your application code is the
Expand Down
8 changes: 8 additions & 0 deletions Sources/IssueReporting/Documentation.docc/IssueReporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ assertions, and do so in a testable manner.

## Overview

> Important:
> Issue Reporting is an evolution of our previous library, XCTestDynamicOverlay. As such,
> to use this library you must depend on the old repository URL, which is
>
> ```
> https://github.com/pointfreeco/xctest-dynamic-overlay
> ```

This library provides robust tools for reporting issues in your application with a customizable
degree of granularity and severity. In its most basic form you use the unified
[`reportIssue`](<doc:reportIssue(_:fileID:filePath:line:column:)>) function anywhere in your
Expand Down
Loading