https://github.com/pkrmf/umbrella-header-linter

The Linter for Umbrella Headers on iOS/watchOS/macOS/tvOS Frameworks.
https://github.com/pkrmf/umbrella-header-linter

framework header ios linter macos objective-c ruby swift tvos umbrella umbrella-headers watchos xcode

Last synced: 2 months ago
JSON representation

The Linter for Umbrella Headers on iOS/watchOS/macOS/tvOS Frameworks.

• Host: GitHub
• URL: https://github.com/pkrmf/umbrella-header-linter
• Owner: pkrmf
• License: mit
• Created: 2017-09-13T16:20:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-16T18:27:08.000Z (over 7 years ago)
• Last Synced: 2024-08-09T11:46:20.289Z (5 months ago)
• Topics: framework, header, ios, linter, macos, objective-c, ruby, swift, tvos, umbrella, umbrella-headers, watchos, xcode
• Language: Ruby
• Homepage:
• Size: 10.2 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Umbrella Helper Linter

__Umbrella Header Linter__ is a linter for iOS/macOS/tvOS/watchOS Frameworks. 

Since Xcode doesn't provide a good way to identify at pre/post compile time that the umbrella header is missing files, or files are missing its Public scope, I decided to build this gem to help with the development of Frameworks.

`umbrellalinter` is the perfect tool to be used with your C.I, or during development, as a pre-build script. The `umbrellalinter` will identify every single file that is missing on its umbrella header, or every single file in the umbrella header that is missing Public scope.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'umbrellalinter'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install umbrellalinter

## Usage

`umbrellalinter lint FrameworkTargetName` to lint your Framework Target.

`umbrellalinter lint FrameworkTargetName --fix` to lint and fix your umbrella header and the file's scopes.

__NOTE__: Take in consideration we don't know what files you want public or private, we don't know the architecture of your application or your public API. We base our linting and fixing on what is declared on your umbrella header or what is missing on it(Files with public scope).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pkrmf/umbrellalinter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Umbrellalinter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pkrmf/umbrellalinter/blob/master/CODE_OF_CONDUCT.md).