Skip to main content

Periphery

A tool to identify unused code in Swift projects.

Details

URL: 🔗 https://github.com/peripheryapp/periphery

Authors:
ileitch, kateinoigakukun, rock88, and others

Tags:
macOS, Swift, iOS, Apple, Xcode

Key Points​

  • Periphery is a tool designed to detect unused code in Swift projects.
  • Supports various build systems including Xcode and Swift Package Manager (SwiftPM).
  • Provides advanced scanning capabilities with options for guided setup and configuration.
  • Emphasizes the importance of selecting appropriate build targets for accurate analysis.
  • Suitable for mixed Objective-C and Swift projects, with considerations for public declarations.

Summary of Contents​

  • Introduction: Overview of Periphery as a tool for Swift project maintenance.
  • Installation: Methods to install Periphery using Homebrew, Mint, or CocoaPods.
  • How To Use: Detailed instructions on using the scan command and configuring project targets.
  • Configuration: Guidance on persisting scan configurations using a YAML file.
  • Technical Details: Discusses scanning functionalities and integration with various build systems.
  • Applications and Examples: Practical usage scenarios and examples for effective code optimization.
  • Troubleshooting: Known issues and recommendations for resolving common problems.
Go to Github Repository→