Skip to content

Fix errors in tsconfig.json, make installation steps more explicit in README.md #24

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

Open
diegopetrucci wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix errors in tsconfig.json, make installation steps more explicit in README.md #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3131a44
Fix tsconfig
diegopetrucci Nov 21, 2025
8780938
make readme clearer
diegopetrucci Nov 21, 2025
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ Download the latest XCFramework from [Github releases](https://github.com/Emerge

## Setup

* Fetch the repo locally, eg via `gh repo clone getsentry/Reaper-iOS`
* Navigate to the `Scripts` directory `cd Scripts`
* Install the dependencies with `npm install`
* Build the project `npm tsc --project .`
* If you haven't already, archive your app from Xcode. You might need to only export `arm64` slices
* Locate your .app, usually at `/Users/{you-user}/Library/Developer/Xcode/Archives/{date}/{app-name-and-date}.xcarchive/Products/Applications/{app-name}.app`
* Scan for files with `node .build/main.js {your-app-path.app} output.json`
* You can ignore the errors if a `output.json` file has been created.

## Integration

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

```Swift
Expand All @@ -41,9 +52,6 @@ EMGReaper.sharedInstance().start { types in
}
```

## Determining all types

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

## Resources

Expand Down
3 changes: 3 additions & 0 deletions Scripts/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
"sourceMap": true,
"allowJs": true,
"target": "es2022",
"lib": ["es2022", "dom"],
"outDir": ".build",
"module": "es2022",
"noEmitOnError": true,
"strict": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"moduleResolution": "node",
"types": ["node"]
}
}