Added Danger, PR linter.

.rubocop.yml

@@ -2,9 +2,16 @@ AllCops:
   Exclude:
     - vendor/**/*
 
-Metrics/BlockLength:
-  Enabled: true
-  Exclude:
-    - spec/**/*
+Naming/MethodName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 256
 
 inherit_from: .rubocop_todo.yml

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-12-15 12:38:08 -0500 using RuboCop version 0.61.1.
+# on 2018-12-16 09:30:57 -0500 using RuboCop version 0.61.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,46 +13,17 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'fui.gemspec'
 
-# Offense count: 1
-Lint/IneffectiveAccessModifier:
-  Exclude:
-    - 'lib/fui/finder.rb'
-
 # Offense count: 1
 # Configuration parameters: IgnoreImplicitReferences.
 Lint/ShadowedArgument:
   Exclude:
     - 'bin/fui'
 
-# Offense count: 2
+# Offense count: 1
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/fui/finder.rb'
     - 'spec/fui/fui_spec.rb'
 
-# Offense count: 2
-Metrics/AbcSize:
-  Max: 17
-
-# Offense count: 7
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 144
-
-# Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 15
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/fui/finder.rb'
-    - 'lib/fui/header.rb'
-
 # Offense count: 6
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
@@ -77,9 +48,3 @@ Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
     - 'lib/fui/finder.rb'
-
-# Offense count: 34
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 203

.travis.yml

@@ -1,2 +1,5 @@
 rvm:
   - 2.5.3
+
+before_script:
+  - bundle exec danger

CHANGELOG.md

@@ -1,11 +1,12 @@
 ### 0.5.0 (Next)
 
-* Your contribution here.
 * [#29](https://github.com/dblock/fui/pull/29): Added support for ignoring paths through `-i`, `--ignore-path` - [@jeffctown](https://github.com/jeffctown).
 * [#28](https://github.com/dblock/fui/pull/28): Added support for finding global imports (bracket notation) - [@jeffctown](https://github.com/jeffctown).
 * [#28](https://github.com/dblock/fui/pull/28): Added ability to turn off global or local import checks through `-g`, `--ignore-global-imports` or `-l`, `--ignore-local-imports` - [@jeffctown](https://github.com/jeffctown).
 * [#28](https://github.com/dblock/fui/pull/28): The `--ignorexib` option has been renamed to `--ignore-xib-files` - [@jeffctown](https://github.com/jeffctown).
-
+* [#31](https://github.com/dblock/fui/pull/31): Added Danger, PR linter and a README TOC - [@jeffctown](https://github.com/jeffctown).
+* Your contribution here.
+
 ### 0.4.1 (8/16/2017)
 
 * [#24](https://github.com/dblock/fui/pull/24): Support .mm files - [@shachlan](https://github.com/Shachlan).

Dangerfile

@@ -0,0 +1,2 @@
+toc.check
+changelog.check

Gemfile

@@ -2,6 +2,8 @@ source 'http://rubygems.org'
 
 gemspec
 
+gem 'danger-changelog', '~> 0.3.0'
+gem 'danger-toc', '~> 0.1'
 gem 'rake'
 gem 'rspec', '~> 3.4.0'
 gem 'rubocop', '0.61.1'

README.md

@@ -6,79 +6,95 @@ Fui
 
 Find unused Objective-C imports.
 
+# Table of Contents
+
+- [Usage](#usage)
+  - [Get Help](#get-help)
+  - [Find Unused Classes in the Current Directory](#find-unused-classes-in-the-current-directory)
+  - [Find Unused Classes in any Path](#find-unused-classes-in-any-path)
+  - [Skip Interface Builder (.xib) Files](#skip-interface-builder-xib-files)
+  - [Ignore Local Imports](#ignore-local-imports)
+  - [Ignore Global Imports](#ignore-global-imports)
+  - [Ignore a Path](#ignore-a-path)
+  - [Ignore Multiple Paths](#ignore-multiple-paths)
+  - [Delete All Unused Class Files with Prompt](#delete-all-unused-class-files-with-prompt)
+- [Xcode Plugin](#xcode-plugin)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+
 ## Usage
 
 ```
 gem install fui
 ```
 
-#### Get Help
+### Get Help
 
 ```
 fui help
 ```
 
-#### Find Unused Classes in the Current Directory
+### Find Unused Classes in the Current Directory
 
 ```
 fui find
 ```
 
 The `find` command lists all the files that contain unused imports and exits with the number of files found.
 
-#### Find Unused Classes in a Path
+### Find Unused Classes in any Path
 
 ```
 fui --path=~/source/project/Name find
 ```
 
-#### Find Unused Classes in a Path Skipping Interface Builder (.xib) Files
+### Skip Interface Builder (.xib) Files
 
 Running `fui` with `-x` (or `--ignore-xib-files`) will, for example, mark `Foo.h` as unused when `Foo.xib` holds a reference to the `Foo` class and no other references to Foo.h exist.
 
 ```
 fui -x --path=~/source/project/Name find
 ```
 
-#### Find Unused Classes in a Path Ignoring Local (quotation syntax) Imports
+### Ignore Local Imports
 
-Running `fui` with `-l` (or `--ignore-local-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a local import of `Foo.h` (`#import Foo.h`)
+Running `fui` with `-l` (or `--ignore-local-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a local (quotation syntax) import of `Foo.h` (eg. `#import Foo.h`).
 
 ```
 fui -l --path=~/source/project/Name find
 ```
 
-#### Find Unused Classes in a Path Ignoring Global (bracket syntax) Imports
+### Ignore Global Imports
 
-Running `fui` with `-g` (or `--ignore-global-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a global import of `Foo.h` (`#import <Framework/Foo.h>`)
+Running `fui` with `-g` (or `--ignore-global-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a global (bracket syntax) import of `Foo.h` (eg. `#import <Framework/Foo.h>`).
 
 ```
 fui -g --path=~/source/project/Name find
 ```
 
-#### Find Unused Classes in a Path And Also Ignoring a Path
+### Ignore a Path
 
-Running `fui` with `-i` (or `--ignore-path`) will, for example, ignore a `Pods` folder when searching for headers or referencing files
+Running `fui` with `-i` (or `--ignore-path`) will, for example, ignore a `Pods` folder when searching for headers or referencing files.
 
 ```
 fui --path=~/source/project/Name --ignore-path=Pods find
 ```
 
-#### Find Unused Classes in a Path And Also Ignoring Multiple Paths
+### Ignore Multiple Paths
 
-Running `fui` with `-i` (or `--ignore-path`) can ignore multiple folders when searching for headers or referencing files
+Running `fui` with `-i` (or `--ignore-path`) can ignore multiple folders when searching for headers or referencing files.
 
 ```
 fui --path=~/source/project/Name --ignore-path=Pods --ignore-path=Libraries find
 ```
 
-#### Delete All Unused Class Files w/ Prompt
+### Delete All Unused Class Files with Prompt
 
 ```
 fui --path=~/source/project/Name delete --perform --prompt
 ```
 
-#### Xcode Plugin
+## Xcode Plugin
 
 Use [xcfui](https://github.com/jcavar/xcfui) for integration with Xcode.