Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix name of setting in README to exclude PreviewModels #68

Merged
merged 1 commit into from
Jun 30, 2024
Merged

Fix name of setting in README to exclude PreviewModels #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,18 +245,18 @@ playbook_configuration:

When preparing for distribution, you may want to exclude your `PreviewProvider` and mock data from release builds. This can be achieved by wrapping them in `#if DEBUG` compiler directives. Alternatively, you can pass a compiler flag to exclude `PreviewModels` from release builds.

To exclude `PreviewModels` using Swift Package Manager, pass the `NO_PLAYBOOK` swift setting in the package that links `PrefirePlaybookPlugin`:
To exclude `PreviewModels` using Swift Package Manager, pass the `PLAYBOOK_DISABLED` swift setting in the package that links `PrefirePlaybookPlugin`:

```swift
swiftSettings: [
.define("NO_PLAYBOOK", .when(configuration: .release)),
.define("PLAYBOOK_DISABLED", .when(configuration: .release)),
]
```

If you are using Xcode, you can pass the compiler flag in the Xcode build settings:

```
SWIFT_ACTIVE_COMPILATION_CONDITIONS = NO_PLAYBOOK;
SWIFT_ACTIVE_COMPILATION_CONDITIONS = PLAYBOOK_DISABLED;
```

## Requirements
Expand Down