Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/giginet/danger-xcprofiler

🚫 danger plugin for asserting Swift compilation time
https://github.com/giginet/danger-xcprofiler

Last synced: 4 months ago
JSON representation

🚫 danger plugin for asserting Swift compilation time

Lists

README

        

# danger-xcprofiler
![GitHub Action](https://github.com/giginet/danger-xcprofiler/actions/workflows/ruby.yml/badge.svg)
[![Gem Version](https://badge.fury.io/rb/danger-xcprofiler.svg)](https://badge.fury.io/rb/danger-xcprofiler)

[danger](https://github.com/danger/danger) plugin for asserting Swift compilation time.

See detail for README of [xcprofiler](https://github.com/giginet/xcprofiler).

![](assets/warning.png)

## Installation

Add this line to your Gemfile:

```sh
gem 'danger-xcprofiler'
```

## Usage

Just add this line to your Dangerfile:

```ruby
xcprofiler.report 'MyApp'
```

Or specify an xcactivitylog path
```ruby
logDir = Dir[File.join('DerivedData/Logs/Build/', '*.xcactivitylog')].first
xcprofiler.report nil, nil, logDir
```

If compilation times of each methods are exceeded the thresholds, `danger` adds inline comment to your PR.

Default thresholds is 50ms for warning, 100ms for failure.

If you want to change thresholds see the following:

```ruby
# Defines inline_mode
xcprofiler.inline_mode = false
# Defines thresholds (ms)
xcprofiler.thresholds = {
warn: 100,
fail: 500
}
xcprofiler.report 'MyApp'
```

## Development

1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.