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

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

Last synced: 6 days ago
JSON representation

🚫 danger plugin for asserting Swift compilation time

• Host: GitHub
• URL: https://github.com/giginet/danger-xcprofiler
• Owner: giginet
• License: mit
• Created: 2017-04-25T11:08:20.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-11-14T08:46:59.000Z (over 2 years ago)
• Last Synced: 2024-06-02T12:06:19.234Z (21 days ago)
• Language: Ruby
• Homepage:
• Size: 187 KB
• Stars: 50
• Watchers: 2
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-danger - danger-xcprofiler - Danger plugin for asserting Swift compilation time. (Plugins / Ruby (danger))

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.