Reaper-iOS - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #android #rust #deep-learning #docker #macos #awesome #kubernetes #vue #security #ios

Reaper-iOS

(★ 195)

A tool for detecting unused code

File Explorer

Download Latest Version (.zip)

- - build-xcframework.yml
- BufferWrapper.ts
- findTypes.ts
- MachOParser.ts
- main.ts
- package-lock.json
- package.json
- README.md
- tsconfig.json
- types.ts
- - EMGObjcRuntimeTypes.h
  - EMGReaper.mm
  - ReaperUIKit.h
  - ReaperUIKit.m
- - NameFinder.swift
.gitignore
LICENSE
Package.swift
README.md
Reaper.podspec

# Installation Guide

1. Get the code

git clone https://github.com/getsentry/Reaper-iOS

Downloads the entire project code from GitHub to your computer.

cd Reaper-iOS

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd Scripts

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Reaper

A framework for detecting dead code at runtime - Reaper is an SDK added to your app to report which Swift and Objective-C types were used for each user session. It supports all classes written in Objective-C, most non-generic Swift classes, and some Swift structs/enums.

The framework detects the set of classes that are used, and the `Scripts` directory in this repo contains a program to determine the set of all possible types that reaper can detect.
The difference of these sets are the unused types.

See additional [resources](#resources) below.

## Installation

### Swift Package Manager

Add Reaper as a dependency with Swift package manager using the URL https://github.com/getsentry/Reaper-iOS.git

### CocoaPods

Add Reaper to your Podfile:

```Ruby
target 'MyApp' do
  pod 'Reaper', '~> 2.0.1'
end
```

### XCFramework

Download the latest XCFramework from [Github releases](https://github.com/EmergeTools/Reaper/releases).

## Setup

Start the SDK at app launch by adding the following code:

```Swift
import Reaper

...

EMGReaper.sharedInstance().start { types in
  // Handle list of used types
}
```

## Determining all types

Run `tsc ./Scripts/main.ts` then `node ./Scripts/main.ts PATH_TO_YOUR_APP.app`

## Resources

- [Example backend](https://github.com/getsentry/reaper-server)
- [Performance & Size Impact](https://docs.emergetools.com/docs/reaper#performance-impact)
- [Open sourcing Reaper](https://blog.sentry.io/an-open-source-sdk-for-finding-dead-code/)
- [Launch Blog Post](https://www.emergetools.com/blog/posts/dead-code-detection-with-reaper).
- [Reaper for Android](https://github.com/EmergeTools/emerge-android/tree/main/reaper)