Question 1

How do I ignore unused code in Periphery?

Accepted Answer

Use inline comment commands like // periphery:ignore above declarations or // periphery:ignore:parameters for function parameters. You can also use configuration options to exclude files or retain specific types, as detailed in the Comment Commands and Excluding Files sections.

Question 2

Periphery vs SwiftLint for dead code detection?

Accepted Answer

Periphery is specialized for deep, relational analysis of unused Swift code using the index store, detecting complex patterns like redundant protocols. SwiftLint offers broader linting with simpler rules but may miss advanced cases, making Periphery better for comprehensive code hygiene in large projects.

Question 3

How to set up Periphery in Xcode?

Accepted Answer

Create an aggregate target, add a run script phase with your Periphery command including --format xcode, and disable user script sandboxing. Follow the step-by-step guide in the Xcode Integration section for detailed instructions and tips.

Question 4

Does Periphery work with Bazel projects?

Accepted Answer

Yes, Periphery has built-in Bazel support via the --bazel option, which queries your project to generate and run scan rules. However, it requires visibility configuration and may impact build cache performance, as noted in the Build Systems section.

Question 5

How to handle false positives from Codable types?

Accepted Answer

Use the --retain-codable-properties option to retain all properties on Codable types, or --retain-encodable-properties for Encodable only. Alternatively, add explicit @objc annotations or ignore commands for specific cases, as explained in the Codable analysis subsection.

Question 6

Can Periphery detect unused imports in mixed Objective-C/Swift projects?

Accepted Answer

Yes, but with limitations: it may produce false positives for targets with significant Objective-C code since it cannot scan Objective-C files. It's recommended to disable unused import detection or manually exclude mixed-language targets, as cautioned in the Unused Imports section.

Periphery

What is Periphery?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions